From 2d743b263f43c6bfea8141245ab8b156cb6307a6 Mon Sep 17 00:00:00 2001 From: Jamie Danielson Date: Thu, 12 Oct 2023 09:48:27 -0400 Subject: [PATCH] rel: prep v3.0.1 (#234) ## 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) --- CHANGELOG.md | 12 ++++++++++++ RELEASING.md | 12 ++++++++---- lib/honeycomb/beeline/version.rb | 2 +- 3 files changed, 21 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 12094dc0..a86e3dc2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,17 @@ # beeline-ruby changelog +## 3.0.1 2023-10-12 + +### Fixed + +- fix: clean invalid UTF8 from trace field values when generating propagation header (#232) | Robb Kidd + +### Maintenance + +- maint: add local dev notes and fix example (#233) | Jamie Danielson +- ci: move nightly to weekly (#230) | Vera Reynolds +- ci: AWS specs updated to use include() instead of match() (#229) | Robb Kidd + ## 3.0.0 2023-06-08 ### ⚠️ Breaking Changes ⚠️ diff --git a/RELEASING.md b/RELEASING.md index 945dd982..0e7a0735 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -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. diff --git a/lib/honeycomb/beeline/version.rb b/lib/honeycomb/beeline/version.rb index 77bbc100..51450f3e 100644 --- a/lib/honeycomb/beeline/version.rb +++ b/lib/honeycomb/beeline/version.rb @@ -3,7 +3,7 @@ module Honeycomb module Beeline NAME = "honeycomb-beeline" - VERSION = "3.0.0" + VERSION = "3.0.1" USER_AGENT_SUFFIX = "#{NAME}/#{VERSION}" end end