Set up scriv for changelog management #1804
Closed
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.
Let's use
scriv
for changelog management. This is very similar to the setup that we have in TraitsUI and apptools, except that it seems better to usescriv
than grow our own tool.scriv
is relatively unopinionated, flexible and easy to use; it simply lets you assemble changelog snippets in separate files underchangelog.d
until you're ready to collect those snippets together to assemble a changelog entry for a release. It seems like a good fit for Traits.We're currently lacking a good place to record the information that we're expecting to use
scriv
for changelog management. See #1803.xref: https://scriv.readthedocs.io/en/1.5.1/