Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add configuration for towncrier #1354

Merged
merged 3 commits into from May 14, 2018
Merged

Add configuration for towncrier #1354

merged 3 commits into from May 14, 2018

Conversation

@pganssle
Copy link
Member

@pganssle pganssle commented May 14, 2018

Per #1341, this sets up towncrier using this:

towncrier --version

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 towncrier can give us.

We now just need documentation on how to use this.

@pganssle
Copy link
Member Author

@pganssle pganssle commented May 14, 2018

@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"

This comment has been minimized.

@jmbowman

jmbowman May 14, 2018
Contributor

Is there a good reason why this is plural while the "directory" entry for Changes is the singular "change"?

This comment has been minimized.

@pganssle

pganssle May 14, 2018
Author Member

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] %}

This comment has been minimized.

@jmbowman

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.

This comment has been minimized.

@pganssle

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.

{% endif %}
{% if sections[section] %}
{% for category, val in definitions.items() if category in sections[section]%}
{% if definitions[category]['showcontent'] %}

This comment has been minimized.

@jmbowman

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?

This comment has been minimized.

@pganssle

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.

pganssle added 3 commits May 14, 2018
@pganssle pganssle force-pushed the pganssle:towncrier branch from 5a73e06 to 51e3fab May 14, 2018
@pganssle
Copy link
Member Author

@pganssle pganssle commented May 14, 2018

@jmbowman Made some updates, want to take another look?

@pganssle pganssle merged commit c70cc12 into pypa:master May 14, 2018
0 of 2 checks passed
0 of 2 checks passed
continuous-integration/appveyor/pr Waiting for AppVeyor build to complete
Details
continuous-integration/travis-ci/pr The Travis CI build is in progress
Details
@kojiromike
Copy link
Contributor

@kojiromike kojiromike commented Jun 21, 2018

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...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

3 participants