Skip to content

Commit c1394b1

Browse files
authored
docs: document merge queue deadlock workaround and merge order (open-telemetry#5233)
Assisted-by: Gemini
1 parent 7c4a6b8 commit c1394b1

3 files changed

Lines changed: 7 additions & 0 deletions

File tree

.github/workflows/ci.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,9 @@ jobs:
4343
- contrib
4444
runs-on: ubuntu-latest
4545
steps:
46+
# Skip alls-green check for post-release version bumps in merge_group.
47+
# This avoids a deadlock where core and contrib repos wait for each other's releases.
48+
# See RELEASING.md for more details.
4649
- name: Decide whether the needed jobs succeeded or failed
4750
if: ${{ !(github.event_name == 'merge_group' && contains(github.event.merge_group.head_commit.message, 'Update version to')) }}
4851
uses: re-actors/alls-green@release/v1

.github/workflows/templates/ci.yml.j2

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,9 @@ jobs:
4343
- contrib
4444
runs-on: ubuntu-latest
4545
steps:
46+
# Skip alls-green check for post-release version bumps in merge_group.
47+
# This avoids a deadlock where core and contrib repos wait for each other's releases.
48+
# See RELEASING.md for more details.
4649
- name: Decide whether the needed jobs succeeded or failed
4750
if: ${% raw %}{{ !(github.event_name == 'merge_group' && contains(github.event.merge_group.head_commit.message, 'Update version to')) }}{% endraw %}
4851
uses: re-actors/alls-green@release/v1

RELEASING.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
* Release builds now should pass.
1515
* Merge the release PR.
1616
* Merge the PR to main (this can be done separately from [making the release](#making-the-release))
17+
* ⚠️ **Merge `core` first**: To avoid a merge queue deadlock with `contrib`, you must merge the `core` PR to `main` first. We skip `alls-green` in the core merge queue ([ci.yml](https://github.com/open-telemetry/opentelemetry-python/blob/main/.github/workflows/ci.yml)) for this PR, which unblocks `contrib` once merged.
1718

1819
## Preparing a new patch release
1920

0 commit comments

Comments
 (0)