Document current "Create a release" process

[Potherca]

In order to guarantee consistencies with releases from this codebase, the process used to create a new release needs to be documented.

Roughly, it goes like this:

1.Make sure all closed tickets and MRs have a label.
2. Move any open tickets to the next milestone (create a new one if needed)
3. Run github-changelog-generator to generate a changelog¹
4. Use GitHub "Draft a new release" functionality to draft a new release (this also creates a tag).
5. Close the milestone for the version that was just released

I'll write things down in more detail.

Maybe later we can also have a look at automating this step with a GitHub Action (i.e. push-button release).

¹ I currently user these setting: potherca-contrib/phpcodesniffer-composer-installer/.github_changelog_generator
And this script: potherca-contrib/phpcodesniffer-composer-installer/bin/generate-changelog.sh

[jrfnl]

Might be helpful for the changelog generation tooling (settings, script) to be added to this repo.

I imagine it may also be useful for the above steps to be included in the CONTRIBUTING.md doc ?

[Potherca]

Agreed, on both points.

[jrfnl]

While looking at the Changelog for the 1.7.1 release I noticed two bugs:

1. Underscores being escaped - installed\_paths.
2. An issue from another milestone having been added to the changelog - Composer 2.x compatibility #108 was fixed in 1.7.0 not 1.7.1.

I've manually edited the release now to fix both, but I think it would be good to review the configuration of the changelog generator to prevent these issues in the future.

Screenshot of the original changelog/release announcement:

[Potherca]

An issue from another milestone having been added to the changelog - #108 was fixed in 1.7.0 not 1.7.1.

That is indeed weird 🤔. I'll look into this to see what's up...

[Potherca]

Regarding issues being placed in wrong milestones, I could not find anything significant, I will have to follow up on that at the source repo.