Configure and add Towncrier files #273
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ef30f81 to
60e1244
Compare
* Add `changelog.d/.gitignore` to keep this directory * Create `changelog.d/README.rst` with some descriptions * Add `changelog.d/_template.rst` as Towncrier template * Add `[tool.towncrier]` section in pyproject.toml * Add "changelog" target into `tox.ini`. Use it like "tox -e changes -- CMD" whereas CMD is a towncrier command. The default "tox -e changes" calls towncrier to create a draft of the changelog file and output it to stdout. * Update documentation and add include a new section "Changelog" included from `changelog.d/README.rst`
60e1244 to
da6179e
Compare
|
This will be integrated into PR #290 so closing this. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR fixes #270 and contains the following changes:
changelog.d/.gitignoreto keep this directorychangelog.d/README.rstwith some descriptionschangelog.d/_template.rstas Towncrier template[tool.towncrier]section inpyproject.tomltox.ini. Use it liketox -e changelog -- CMDwhereas CMD is a towncrier command. The defaulttox -e changelogcalls towncrier to create a draft of the changelog file and output it to stdout.changelog.d/README.rst@python-semver/reviewers @tlaferriere this PR is an attempt to show how this could work.
The
changelog.ddirectory contains some example files whereas only file270.feature.rstis "real", the other newsfragments will be removed before merging to master.I've documented the procedure, see
changelog.d/README.rst. If you prefer to read it as HTML, build the documentation withtox -e docsand look into "Contributing to semver" / "Changelog".Would like to hear your ideas, feedback, or comments. Thank you!