diff options
Diffstat (limited to 'RELEASE.md')
| -rw-r--r-- | RELEASE.md | 75 |
1 files changed, 50 insertions, 25 deletions
@@ -1,34 +1,59 @@ -# Release checklist for Obnam2 +# Release checklist for Obnam -Follow these steps to make a release of Obnam2. +Follow these steps to make a release of Obnam. -* create a `release` branch -* update `NEWS` with changes for the new release -* update the version number everywhere it needs to be updated; use - [semantic versioning][] - - `NEWS` - - `debian/changelog` - - `Cargo.toml` -* commit everything -* push changes to gitlab, create merge request, merge, pull back to - local `main` branch -* create a signed, annotated git tag `vX.Y.Z` for version X.Y.Z for +1. Create a `release` branch. + - `git checkout -b release` +2. Update dependencies for the crate, and make any needed changes. + - `cargo outdated -R` + - `cargo update` + - `cargo deny check` +3. Review changes in the crate (`git log vX.Y.Y..`). Update the `NEWS.md` + file with any changes that users of Obnam need to be aware of. +4. Update the crate's `Cargo.toml` with the appropriate version number + for the new release, following [semantic versioning][]. +5. Update `debian/changelog` with a summary of any changes to the + Debian packaging (it's not necessary to repeat `NEWS.md` here). Use + the `dch` command to edit the file to get the format right, since + it's quite finicky. + - `dch -v X.Y.Z-1 "New release."` + - `dch "Changed this thing: foo."` + - `dch -r ""` +6. Make sure everything still works. + - `./check` +7. Update `Cargo.lock` after version change. + - `cargo update` +8. Commit any changes. +9. Run `cargo publish --dry-run` and fix any problems. +10. Push to gitlab.com and create a merge request. +11. Wait for GitLab CI to test the changes successfully. Fix any + problems it finds. + +After the above changes have been merged, do the following steps. You +need to have sufficient access to both the gitlab.com project and the +git.liw.fi project. Currently that means only Lars can do this. These +steps can hopefully be automated in the future. + +1. Pull down the above changes from GitLab. +2. Create a signed, annotated git tag `vX.Y.Z` for version X.Y.Z for the release commit -* push tag to `gitlab.com` and `git.liw.fi` -* announce new release + - `git tag -sam "Obnam version X.Y.Z" vX.Y.Z` +3. Push tags to `gitlab.com` and `git.liw.fi` (substitute whatever + names you use for the remotes): + - `git push --tags gitlab` + - `git push --tags origin` +4. Wait for Lars's Ick CI to build the release. +5. Publish Obnam crate to crates.io: + - `cargo publish` +5. Run benchmark for release. + - `obnam-benchmark run benchmarks.yaml --obnam vX.Y.Z --output obnam-X.Y.Z.json` + - add the output file to the `obnam-benchmark-results` repository + - push the updated results repository to Lars's personal CI, to + update the result page on the web +6. Announce new release: - obnam.org blog, possibly other blogs - `#obnam` IRC channel - Obnam room on Matrix - social media -* prepare `main` branch for further development - - create new branch - - update version number again by adding `+git` to it - - add a new entry to `NEWS` with the `+git` version - - ditto `debian/changelog` - - commit - - push to gitlab, create MR, merge, pull back down to local `main` - -* continue development - [semantic versioning]: https://semver.org/ |