Add configuration for towncrier #1354
Conversation
|
@jaraco @benoit-pierre Ready for review. We can add this to the "how to make a release" docs in a subsequent PR. |
| underlines = ["-"] | ||
|
|
||
| [[tool.towncrier.type]] | ||
| directory = "deprecations" |
jmbowman
May 14, 2018
Contributor
Is there a good reason why this is plural while the "directory" entry for Changes is the singular "change"?
Is there a good reason why this is plural while the "directory" entry for Changes is the singular "change"?
pganssle
May 14, 2018
Author
Member
No, good catch.
No, good catch.
| @@ -0,0 +1,27 @@ | |||
| {% for section, _ in sections.items() %} | |||
| {% set underline = underlines[0] %}{% if section %}{{section}} | |||
| {{ underline * section|length }}{% set underline = underlines[1] %} | |||
jmbowman
May 14, 2018
Contributor
There's only one entry configured for "underlines" in pyproject.toml; should this set tag be removed? underline doesn't seem to be referenced after this in the template.
There's only one entry configured for "underlines" in pyproject.toml; should this set tag be removed? underline doesn't seem to be referenced after this in the template.
pganssle
May 14, 2018
Author
Member
Yeah, I did it this way so that we can eventually start adding section headers if we want.
Maybe I should just pull it out and we'll add it in if and only if we need it.
Yeah, I did it this way so that we can eventually start adding section headers if we want.
Maybe I should just pull it out and we'll add it in if and only if we need it.
| {% endif %} | ||
| {% if sections[section] %} | ||
| {% for category, val in definitions.items() if category in sections[section]%} | ||
| {% if definitions[category]['showcontent'] %} |
jmbowman
May 14, 2018
Contributor
It looks like the category names aren't used in the template; is there any plan to separate the different types of changes in the generated changelog entries?
It looks like the category names aren't used in the template; is there any plan to separate the different types of changes in the generated changelog entries?
pganssle
May 14, 2018
Author
Member
Possibly, but for now the categories are just used for ordering purposes so that the important stuff is sorted on top.
Possibly, but for now the categories are just used for ordering purposes so that the important stuff is sorted on top.
|
@jmbowman Made some updates, want to take another look? |
|
Apparently, there's a "town-crier" and a "towncrier" and I guess they're not the same thing at all. The one linked here appears to be a blockchain interface... |
Per #1341, this sets up
towncrierusing this:The current configuration more or less recreates the old changelog format. We can tweak from here if we want to make improvements that take advantage of what
towncriercan give us.We now just need documentation on how to use this.