-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
## Which problem is this PR solving? - new release ## Short description of the changes - update releasing doc - update version (and remove redundant version; example app will use parent version bc it's a module) - update changelog
- Loading branch information
1 parent
fe256ed
commit adfaf53
Showing
8 changed files
with
35 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,13 @@ | ||
# Creating a new release | ||
|
||
1. Update the `<version>` tag in each pom.xml in the repo. | ||
2. Add new release notes to the Changelog. | ||
3. Open a PR with those changes. | ||
4. Once the above PR is merged, tag `main` with the new version, e.g. `v0.1.1`. Push the tags. This will kick off a CI workflow, which will publish a draft GitHub release, and publish artifacts to Maven. | ||
5. Update Release Notes on the new draft GitHub release, and publish that. | ||
- Update the `<version>` tag in each pom.xml in the repo. | ||
- Update `CHANGELOG.md` with the changes since the last release. Consider automating with a command such as these two: | ||
- `git log $(git describe --tags --abbrev=0)..HEAD --no-merges --oneline > new-in-this-release.log` | ||
- `git log --pretty='%C(green)%d%Creset- %s | [%an](https://github.com/)'` | ||
- Commit changes, push, and open a release preparation pull request for review. | ||
- Once the pull request is merged, fetch the updated `main` branch. | ||
- Apply a tag for the new version on the merged commit (e.g. `git tag -a v2.3.1 -m "v2.3.1"`). | ||
- Push the tag upstream (this will kick off the release pipeline in CI) e.g. `git push origin v2.3.1`. | ||
- Ensure that there is a draft GitHub release created as part of CI publish steps (this will also publish to Maven). | ||
- Click "generate release notes" in GitHub for full changelog notes and any new contributors. | ||
- Publish the GitHub draft release. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters