From 80bc2424d65ba5448efde4b2b80fd0f45ae3e09d Mon Sep 17 00:00:00 2001 From: Philip Jenvey Date: Wed, 20 May 2026 11:34:55 -0700 Subject: [PATCH 1/2] docs: we run clog with --setversion Issue STOR-569 --- docs/src/release-process.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/src/release-process.md b/docs/src/release-process.md index 498345fa3c..eeabab8383 100644 --- a/docs/src/release-process.md +++ b/docs/src/release-process.md @@ -8,7 +8,7 @@ 1. Bump the version number in [Cargo.toml](https://github.com/mozilla-services/syncstorage-rs/blob/master/Cargo.toml) (this new version number will be designated as `` in this checklist) 1. create a git branch for the new version `git checkout -b release/` 1. `cargo build --release` - Build with the release profile [release mode](https://doc.rust-lang.org/book/ch14-01-release-profiles.html). -1. `clog -C CHANGELOG.md` - Generate release notes. We're using [clog](https://github.com/clog-tool/clog-cli) for release notes. Add a `-p`, `-m` or `-M` flag to denote major/minor/patch version, ie `clog -C CHANGELOG.md -p`. +1. `clog --setversion ` - Generate release notes. We're using [clog](https://github.com/clog-tool/clog-cli) for release notes. 1. Review the `CHANGELOG.md` file and ensure all relevant changes since the last tag are included. 1. Create a new [release in Sentry](https://docs.sentry.io/product/releases/#create-release): `VERSION={release-version-here} bash scripts/sentry-release.sh`. If you're doing this for the first time, checkout the [tips below](https://github.com/mozilla-services/syncstorage-rs#troubleshooting) for troubleshooting sentry cli access. 1. `git commit -am "chore: tag "` to commit the new version and changes @@ -22,4 +22,4 @@ 1. Copy and paste the most recent change set from `CHANGELOG.md` into the release description, omitting the top 2 lines (the name and version) 1. Once your PR merges, click [Publish Release] on the [GitHub release](https://github.com/mozilla-services/syncstorage-rs/releases) page. -Sync server is automatically deployed to STAGE, however QA may need to be notified if testing is required. Once QA signs off, then a bug should be filed to promote the server to PRODUCTION. \ No newline at end of file +Sync server is automatically deployed to STAGE, however QA may need to be notified if testing is required. Once QA signs off, then a bug should be filed to promote the server to PRODUCTION. From 8f9318a41943c62210fbc5a24d8d8a0d8807d935 Mon Sep 17 00:00:00 2001 From: Philip Jenvey Date: Wed, 20 May 2026 12:35:43 -0700 Subject: [PATCH 2/2] docs: clarify latest clog bug and remove explicit adding of releases in sentry which we don't need to do (sentry auto populates new versions as new events occur) Closes STOR-569 --- docs/src/release-process.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/src/release-process.md b/docs/src/release-process.md index eeabab8383..8f17ebf760 100644 --- a/docs/src/release-process.md +++ b/docs/src/release-process.md @@ -8,9 +8,8 @@ 1. Bump the version number in [Cargo.toml](https://github.com/mozilla-services/syncstorage-rs/blob/master/Cargo.toml) (this new version number will be designated as `` in this checklist) 1. create a git branch for the new version `git checkout -b release/` 1. `cargo build --release` - Build with the release profile [release mode](https://doc.rust-lang.org/book/ch14-01-release-profiles.html). -1. `clog --setversion ` - Generate release notes. We're using [clog](https://github.com/clog-tool/clog-cli) for release notes. +1. `clog --setversion ` - Generate release notes. We're using [clog](https://github.com/clog-tool/clog-cli) for release notes. The older v0.9.3 version is recommended (`cargo install clog-cli@0.9.3`), v0.10.0 has a bug interpreting our `.clog.toml` file options (which can be worked around by running it via `clog -r https://github.com/mozilla-services/syncstorage-rs --from-latest-tag --setversion `) 1. Review the `CHANGELOG.md` file and ensure all relevant changes since the last tag are included. -1. Create a new [release in Sentry](https://docs.sentry.io/product/releases/#create-release): `VERSION={release-version-here} bash scripts/sentry-release.sh`. If you're doing this for the first time, checkout the [tips below](https://github.com/mozilla-services/syncstorage-rs#troubleshooting) for troubleshooting sentry cli access. 1. `git commit -am "chore: tag "` to commit the new version and changes 1. `git tag -s -m "chore: tag " ` to create a signed tag of the current HEAD commit for release. 1. `git push origin release/` to push the commits to a new origin release branch