Skip to content
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

Minor JReleaser tweaks and documentation #1723

Merged
merged 2 commits into from
Oct 24, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
docs: document on releasing Mutiny
jponge committed Oct 24, 2024
commit a244da2d478df07b48ee4899a4a717136414d5ba
18 changes: 18 additions & 0 deletions RELEASING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Releasing Mutiny

## Prepare a release pull-request

1. Make sure that all issues and pull-requests assigned to the target milestone have been closed.
2. Run: `just prepare-release 2.7.0-RC3` (replace with the correct version number).
3. Review the changes in the branch.
4. Open a pull-request: `gh pr create`.
5. Once all tests pass, merge it:
- the `pre-release.yml` workflow will create a Git tag, then
- the `release.yml` workflow will push to Maven Central, then
- the `deploy-site.yml` workflow will update the website (except for release candidates and milestones).

## GitHub release notes

Run the following command: `just jreleaser 2.6.2 2.7.0-RC3` where you specify the previous and the release tags to compute release notes.

If the release notes fail to update or if they are too big for JReleaser to update them, then you can read them from `target/jreleaser/release/CHANGELOG.md` and manually update the release notes on GitHub.