search

wtbarnes / fiasco

Python interface to the CHIANTI atomic database
http://fiasco.readthedocs.io/
BSD 3-Clause "New" or "Revised" License
20 stars 15 forks source link

Use changelog and render during releases #214

Closed wtbarnes closed 5 months ago

wtbarnes commented 1 year ago

For the first two releases, I've not used the changelog at all. Moving forward, a changelog should be required for any significant user-facing changes. These should then be rendered on each release using towncrier.

Cadair commented 1 year ago

May I suggest an alternative which is the github changelog approach now taken by reproject etc. Use the GitHub releases auto-changelog generator, and then use an action to edit the changelog file in the repo: https://github.com/astropy/reproject/blob/main/RELEASE_INSTRUCTIONS.md

wtbarnes commented 1 year ago

That sounds like a lot less effort so I'm in favor of it.

When it comes to backports that are rendered as authored by the backport bot, do you know if there is a way to render those as the original PRs rather than the backport PRs?

Cadair commented 1 year ago

No I don't know. The packages I use this flow on tend to be very backport-light i.e. mostly don't do bugfixes off a branch.

wtbarnes commented 5 months ago

I've just been using the GH releases auto-changelog generator for the last couple of releases and I think that's more than sufficient for now so I'm going to close this.