diff --git a/.github/ISSUE_TEMPLATE/release.md b/.github/ISSUE_TEMPLATE/release.md index 998f00f66..dc7f0c6c3 100644 --- a/.github/ISSUE_TEMPLATE/release.md +++ b/.github/ISSUE_TEMPLATE/release.md @@ -7,9 +7,9 @@ title: "Release vX.Y.Z (or vX.Y.Zrc?)" Release check-list: - [ ] Choose the version number, e.g. `vX.Y.Z` (can be `vX.Y.Zrc?` for Release Candidates) following semantic versioning: https://semver.org/ -- [ ] Update the version in pyproject.toml to `X.Y.Z` (or `vX.Y.Zrc?`) +- [ ] Update the version in pyproject.toml to `X.Y.Z` (or `X.Y.Zrc?`) - [ ] Check the release milestone issues, cut out what can't be completed in time -- [ ] Checkout the commit for release, create a signed tag with the version name (careful for RC) `git tag -s -a -m "vX.Y.Z release" vX.Y.Z`, push it to GitHub with `git push origin refs/tags/vX.Y.Z` +- [ ] Checkout the commit for release, create a signed tag with the version name (careful for RC) `git tag -s -a -m "vX.Y.Z release" vX.Y.Z`, (or `vX.Y.Zrc?`) push it to GitHub with `git push origin refs/tags/vX.Y.Z` (or `vX.Y.Zrc?`) - [ ] Run sanity checks inside the dev docker: `make pcc` and `make pytest && make coverage` - [ ] On the build machine with docker installed, run in your OS terminal in the project dir: `make release_docker` - [ ] Re-tag the image with `docker tag concretefhe-release:latest ghcr.io/zama-ai/concretefhe-release:vX.Y.Z` (or `vX.Y.Zrc?`) diff --git a/docs/dev/howto/RELEASING.md b/docs/dev/howto/RELEASING.md index 36974d20f..086c3733f 100644 --- a/docs/dev/howto/RELEASING.md +++ b/docs/dev/howto/RELEASING.md @@ -2,7 +2,7 @@ ## Release Candidate cycle -Before settling for a final release, we go through a Release Candidate (RC) cycle. The idea is that once the code base and documentations look ready for a release you create an RC Release by opening an issue with the release template here: https://github.com/zama-ai/concretefhe-internal/issues/new?assignees=&labels=&template=release.md starting with version `vX.Y.Zrc0` and then with versions `vX.Y.Zrc1`, `vX.Y.Zrc2`... +Before settling for a final release, we go through a Release Candidate (RC) cycle. The idea is that once the code base and documentations look ready for a release you create an RC Release by opening an issue with the release template here: https://github.com/zama-ai/concretefhe-internal/issues/new?assignees=&labels=&template=release.md starting with version `vX.Y.Zrc1` and then with versions `vX.Y.Zrc2`, `vX.Y.Zrc3`... ## Proper release