Skip to content

Commit

Permalink
add more detail to releasing steps
Browse files Browse the repository at this point in the history
  • Loading branch information
JamieDanielson committed Feb 27, 2023
1 parent 51a39c7 commit a15baa8
Showing 1 changed file with 12 additions and 7 deletions.
19 changes: 12 additions & 7 deletions RELEASING.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,14 @@
# Releasing Process

1. Update changelog
2. Update VersionPrefix (and VersionSuffix if necessary) in the csproj file
- If updating the OTel SDK, update the OTLP version in `HoneycombOptions.cs`
3. Open a PR with the above, and merge that into main
4. Tag the merged commit with the new version (e.g. `v0.10.0-alpha`)
5. Push the tag upstream (this will kick off the release pipeline in CI)
6. Once the CI is done, publish the GitHub draft release as pre-release through GitHub UI
- 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/)'`
- Update VersionPrefix (and VersionSuffix if necessary) in the `*.csproj` files
- If updating the OTel SDK, update the OTLP version in `HoneycombOptions.cs`
- 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 v1.2.1v/0.26.1-beta -m "v1.2.1v/0.26.1-beta"`)
- Push the tag upstream (this will kick off the release pipeline in CI) e.g. `git push origin v1.2.1v/0.26.1-beta`
- Ensure that there is a draft GitHub release created as part of CI publish steps (this will also publish to Nuget).
- Click "generate release notes" in Github for full changelog notes and any new contributors
- Publish the Github draft release - if it is a prerelease (e.g. beta) click the prerelease checkbox.

0 comments on commit a15baa8

Please sign in to comment.