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

Automate releases (CHANGELOG.md updating) #3179

Merged
merged 2 commits into from
Feb 8, 2024

Conversation

Hind-M
Copy link
Member

@Hind-M Hind-M commented Feb 6, 2024

This adds a script to automate updating CHANGELOG.md for releases.
This needs all the upcoming merged PRs to have exactly one of the following labels:
release::enhancements, release::bug_fixes, release::ci_docs

@JohanMabille @AntoinePrv @jonashaag @Klaim please make sure it's the case when merging in the future.

PS1: Feel free to tag here anyone who can merge in this repo to be notified. Thanks!
PS2: If anyone is aware of a way to make these labels mandatory in order to prevent from merging if missing, that would be great!

@Hind-M Hind-M added the release::enhancements For enhancements PRs or implementing features label Feb 6, 2024
@JohanMabille
Copy link
Member

JohanMabille commented Feb 6, 2024

I think we can add a CI job to require such a label on each PR (I know JupyterLab has it)

@AntoinePrv
Copy link
Member

Can we get a chore for cleaning that change nothing for the user?

Alternatively (but this may be more work), we could look into Conventional Commits. There are tools to generate automated changelogs, as well as pre-commits hooks for enforcing we use them.

@Hind-M Hind-M added release::ci_docs For PRs related to CI or documentation type::general-improvement release::enhancements For enhancements PRs or implementing features and removed release::enhancements For enhancements PRs or implementing features release::ci_docs For PRs related to CI or documentation type::general-improvement labels Feb 7, 2024
@Hind-M
Copy link
Member Author

Hind-M commented Feb 7, 2024

Alternatively (but this may be more work), we could look into Conventional Commits. There are tools to generate automated changelogs, as well as pre-commits hooks for enforcing we use them.

Yes indeed, it's another way of doing things. I actually first thought of using a tool to generate the changelog but figured that we may want to keep the current format of the changelog file (with contributor name etc), but maybe not? The script here is really some solution to avoid all the manual cumbersome work with the release. This could be short term of course and we may want to think about the whole process and conventional commits more thoroughly considering what can be involved and improved while we're at it?

Can we get a chore for cleaning that change nothing for the user?

I'm not sure I get what you mean. Is this related to the conventional commits?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release::enhancements For enhancements PRs or implementing features
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants