search

pypa / setuptools-scm

the blessed package to manage your versions by scm tags
https://setuptools-scm.readthedocs.io/en/latest/
MIT License
860 stars 211 forks source link

Remove automated commits from release notes #1062

Open ds-cbo opened 3 months ago

ds-cbo commented 3 months ago

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 commented 3 months ago

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 commented 3 months ago

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