-
-
Notifications
You must be signed in to change notification settings - Fork 36
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
Document current "Create a release" process #114
Comments
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 |
Agreed, on both points. |
While looking at the Changelog for the
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. |
That is indeed weird 🤔. I'll look into this to see what's up... |
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. |
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 changelog1
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).
1 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
The text was updated successfully, but these errors were encountered: