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

Set up scriv for changelog management #1804

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Conversation

mdickinson
Copy link
Member

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 use scriv than grow our own tool.

scriv is relatively unopinionated, flexible and easy to use; it simply lets you assemble changelog snippets in separate files under changelog.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/

Copy link

@flongford flongford left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks very useful indeed - excited to see how it works in practice

@mdickinson - is it appropriate to include the scriv package in some setup.py / etstool.py list of dependencies or shall we look into that at a later date?

@mdickinson
Copy link
Member Author

@mdickinson - is it appropriate to include the scriv package in some setup.py / etstool.py list of dependencies or shall we look into that at a later date?

It's not actually needed by any of our current workflows, so I'm not sure where I'd put it. Where it should be mentioned is in developer setup instructions, but we don't have any of those. (See #1803.) It'll also impact the method of making a release, so I need to update the notes on making releases in the wiki.

@flongford
Copy link

@mdickinson - is it appropriate to include the scriv package in some setup.py / etstool.py list of dependencies or shall we look into that at a later date?

It's not actually needed by any of our current workflows, so I'm not sure where I'd put it. Where it should be mentioned is in developer setup instructions, but we don't have any of those. (See #1803.) It'll also impact the method of making a release, so I need to update the notes on making releases in the wiki.

Makes sense to me - thanks for the explanation

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

Successfully merging this pull request may close these issues.

None yet

2 participants