Skip to content

[chore] update release documentation #12670

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 19, 2025
Merged

[chore] update release documentation #12670

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
64aefc7
[chore] update release documentation
codeboten Mar 18, 2025
df0fd1b
Merge branch 'main' into codeboten/update-release-to-include-merge-queue
codeboten Mar 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions docs/release.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -200,11 +200,12 @@ The following documents the procedure to release a bugfix
2. Merge the `release/<release-series>` branch into the new branch.
3. Resolve the conflicts.
4. Create another pull request to the `main` branch from the new branch to replace the pull request from the `release/<release-series>` branch.
5. Enable the **Merge pull request** setting in the repository's **Settings** tab.
6. Make sure you are on `release/<release-series>`. Push the new release version tags for a target module set by running `make push-tags MODSET=<beta|stable>`. Wait for the new tag build to pass successfully.
7. **IMPORTANT**: The pull request to bring the changes from the release branch *MUST* be merged using the **Merge pull request** method, and *NOT* squashed using “**Squash and merge**”. This is important as it allows us to ensure the commit SHA from the release branch is also on the main branch. **Not following this step will cause much go dependency sadness.**
8. If the pull request was created from the `release/<release-series>` branch, it will be auto-deleted. Restore the release branch via GitHub.
9. Once the patch is released, disable the **Merge pull request** setting.
5. Disable the merge queue. An admin of the repo needs to be available for this.
6. Enable the **Merge pull request** setting in the repository's **Settings** tab.
7. Make sure you are on `release/<release-series>`. Push the new release version tags for a target module set by running `make push-tags MODSET=<beta|stable>`. Wait for the new tag build to pass successfully.
8. **IMPORTANT**: The pull request to bring the changes from the release branch *MUST* be merged using the **Merge pull request** method, and *NOT* squashed using “**Squash and merge**”. This is important as it allows us to ensure the commit SHA from the release branch is also on the main branch. **Not following this step will cause much go dependency sadness.**
9. If the pull request was created from the `release/<release-series>` branch, it will be auto-deleted. Restore the release branch via GitHub.
10. Once the patch is released, disable the **Merge pull request** setting and re-enable the merge queue.

## 1.0 release

Expand All @@ -216,7 +217,6 @@ Once a module is ready to be released under the `1.x` version scheme, file a PR

| Date | Version | Release manager |
|------------|----------|---------------------------------------------------|
| 2025-03-17 | v0.122.0 | [@evan-bradley](https://github.com/evan-bradley) |
| 2025-03-31 | v0.123.0 | [@TylerHelmuth](https://github.com/TylerHelmuth) |
| 2025-04-14 | v0.124.0 | [@atoulme](https://github.com/atoulme) |
| 2025-04-28 | v0.125.0 | [@songy23](https://github.com/songy23) |
Expand All @@ -227,3 +227,4 @@ Once a module is ready to be released under the `1.x` version scheme, file a PR
| 2025-07-14 | v0.130.0 | [@jade-guiton-dd](https://github.com/jade-guiton-dd) |
| 2025-07-28 | v0.131.0 | [@jmacd](https://github.com/jmacd) |
| 2025-08-11 | v0.132.0 | [@mx-psi](https://github.com/mx-psi) |
| 2025-08-18 | v0.133.0 | [@evan-bradley](https://github.com/evan-bradley) |
Loading