Skip to content

Commit

Permalink
rel: prep v3.0.1 (#234)
Browse files Browse the repository at this point in the history
## 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
JamieDanielson committed Oct 12, 2023
1 parent 0a0eafe commit 2d743b2
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 5 deletions.
12 changes: 12 additions & 0 deletions 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 ⚠️
Expand Down
12 changes: 8 additions & 4 deletions 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.
2 changes: 1 addition & 1 deletion lib/honeycomb/beeline/version.rb
Expand Up @@ -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

0 comments on commit 2d743b2

Please sign in to comment.