OpenRefine icon indicating copy to clipboard operation
OpenRefine copied to clipboard

Improve configuration of Github autogenerated release notes

Open tfmorris opened this issue 3 weeks ago • 1 comments

The default configuration for Github autogenerated release notes is suboptimal for our project.

Proposed solution

Let's use the information below to improve it: https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes#configuring-automatically-generated-release-notes

Alternatives considered

Organize/edit release notes by hand. Some hand editing will probably always be required, but the closer we can get the generated notes to ideal, the less editing we'll have to do.

Additional context

tfmorris avatar Dec 09 '25 02:12 tfmorris

It may make sense to exclude automated dependency updates entirely and instead use a human summarization of the output of something like:

find . -name pom.xml -exec git diff 3.9.5...3.10 {} \; > pom-diffs-3.9.5-3.10-beta1.txt

We also need one or more tags for internal things like build procedure updates, administrative updates to READMEs, etc so that they can be excluded from the release notes in an automated fashion (after the tags are applied to the PRs).

tfmorris avatar Dec 09 '25 05:12 tfmorris