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

Remove automated commits from release notes #1062

Open
ds-cbo opened this issue Aug 2, 2024 · 2 comments
Open

Remove automated commits from release notes #1062

ds-cbo opened this issue Aug 2, 2024 · 2 comments

Comments

@ds-cbo
Copy link

ds-cbo commented Aug 2, 2024

Not sure where else to put this, but could you please keep pre-commit.ci and dependabot commits out of the release notes? They make it very hard to see what actually changed, which makes my life as a dependency update reviewer much harder.

For example, the 8.1.0 release notes contain the following line 12 times, vs 24 real changes (not counting 3 dependabots)

[pre-commit.ci] pre-commit autoupdate by https://github.com/pre-commit-ci in https://github.com/pypa/setuptools_scm/pull/...

If you really want to keep them (though I doubt their usefulness in release notes), could you at least move them to a dedicated "Automated commits" block?

@shenxianpeng
Copy link
Contributor

shenxianpeng commented Aug 5, 2024

How about using release-drafter? we used it in cpp-linter org and it works well HERE. It can automatically label PRs, automatically classify them, and guess new versions. Finally, the publisher opens the Draft release and clicks to publish. I can draft a PR for reference If you are interested.

UPDATE: GitHub Releases also support classifying release notes automatically by creating a .github/release.yml file if not prefer to use 3rd tools above.

@RonnyPfannschmidt
Copy link
Contributor

the intent is to migrate towards using towncrier and/or scriv to produce the changelog fragments and using those to fill in the release

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

No branches or pull requests

3 participants