Skip to content

Commit 69908f4

Browse files
authored
[chore] update release documentation (#12670)
There was no mention of disabling the merge queue which is needed if we need to merge a commit (instead of squashing it) Signed-off-by: Alex Boten <[email protected]>
1 parent 54222b6 commit 69908f4

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

docs/release.md

+7-6
Original file line numberDiff line numberDiff line change
@@ -200,11 +200,12 @@ The following documents the procedure to release a bugfix
200200
2. Merge the `release/<release-series>` branch into the new branch.
201201
3. Resolve the conflicts.
202202
4. Create another pull request to the `main` branch from the new branch to replace the pull request from the `release/<release-series>` branch.
203-
5. Enable the **Merge pull request** setting in the repository's **Settings** tab.
204-
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.
205-
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.**
206-
8. If the pull request was created from the `release/<release-series>` branch, it will be auto-deleted. Restore the release branch via GitHub.
207-
9. Once the patch is released, disable the **Merge pull request** setting.
203+
5. Disable the merge queue. An admin of the repo needs to be available for this.
204+
6. Enable the **Merge pull request** setting in the repository's **Settings** tab.
205+
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.
206+
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.**
207+
9. If the pull request was created from the `release/<release-series>` branch, it will be auto-deleted. Restore the release branch via GitHub.
208+
10. Once the patch is released, disable the **Merge pull request** setting and re-enable the merge queue.
208209

209210
## 1.0 release
210211

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

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

0 commit comments

Comments
 (0)