Skip to content

Commit

Permalink
maint: update RELEASING now that version is computed from a tag (#187)
Browse files Browse the repository at this point in the history
## Which problem is this PR solving?

- Followup to #186 to correct the releasing steps.
  • Loading branch information
robbkidd committed Sep 15, 2023
1 parent 1b6e387 commit 25b1903
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions RELEASING.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
# Releasing

- Update version number in `main.go`
- Update `CHANGELOG.md` with the changes since the last release. Consider automating with a command such as these two:
- Update `CHANGELOG.md` with the changes since the last release. Consider automating with a command such as one of 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 v0.1.0-alpha -m "v0.1.0-alpha"`)
- Apply an annotated tag (`git tag -a`) for the new version on the merged commit (e.g. `git tag -a v0.1.0-alpha -m "v0.1.0-alpha"`)
- Push the tag upstream (this will kick off the release pipeline in CI) e.g. `git push origin v0.1.0-alpha`
- Ensure that there is a draft GitHub release created as part of CI publish steps.
- Click "generate release notes" in GitHub for full changelog notes and any new contributors
Expand Down

0 comments on commit 25b1903

Please sign in to comment.