Skip to content

Commit

Permalink
docs: minor clarifications in release docs
Browse files Browse the repository at this point in the history
Signed-off-by: Sam Whited <[email protected]>
  • Loading branch information
SamWhited committed Sep 23, 2024
1 parent a788115 commit 4edb896
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions docs/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,11 @@ When making a release, remember to do the following:

- Create a new commit bumping the release in `CHANGELOG.md` with the commit
message "all: release vX.Y.Z"
- Tag the release with `git tag -a --cleanup=whitespace vX.Y.Z`
- Tag the release with `git tag -a --cleanup=whitespace vX.Y.Z` and remove all
comments from the annotation as these won't be treated as comments and will
end up in the final annotation
- Copy the changelog for the release in as the annotation, making sure the
headers are correct
headers are correct (ie. remove one `#' from each header)
- Create a new release on Codeberg (https://codeberg.org/mellium/xmpp/releases)
using the same annotation, making sure headers make sense (remove the top
level one, Codeberg will create that from the tag)
Expand Down

0 comments on commit 4edb896

Please sign in to comment.