-
Notifications
You must be signed in to change notification settings - Fork 32
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 version - update changelog - update releasing doc for extra clarity (found to be helpful in other repos)
- Loading branch information
1 parent
0a0eafe
commit 2d743b2
Showing
3 changed files
with
21 additions
and
5 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,9 +1,13 @@ | ||
# Releasing | ||
|
||
- Update the version number in `lib/honeycomb/beeline/version`. | ||
- Update `CHANGELOG.md` with the changes since the last release. | ||
- Update the version number in `lib/honeycomb/beeline/version.rb`. | ||
- 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'` | ||
- 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: vX.Y.Z, for example v1.1.2. | ||
- Push the new version tag up to the project repository to kick off build and artifact publishing to GitHub and the Gems registry. | ||
- 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 Gems registry). | ||
- Click "generate release notes" in GitHub for full changelog notes and any new contributors | ||
- Publish the draft release in GitHub. |
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