Automating release notes from CI

[jalvesz]

Motivation

I've been looking at ways to ease the generation of releases. I found two options that seems interesting:

1. https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes#configuring-automatically-generated-release-notes
2. https://git-cliff.org/ > https://git-cliff.org/docs/category/github-actions

I wanted to see if the use of any of these tools could help facilitate making more regular releases.

Any experience with these tools?

Prior Art

No response

Additional Information

No response

[stigh]

I think this is a great idea! To help keep the Git history clean and make changelog automation easier (especially with git-cliff), I’d suggest:

1. Enabling squash-on-merge for the repo. This prevents intermediate commits from cluttering the history. It works best when PRs are kept small and focused.

2. Adopting conventional commits (https://www.conventionalcommits.org/en/v1.0.0/), which git-cliff relies on for changelog generation. One approach is to use the conventional message as the PR title, since that becomes the final commit message after squashing.