Skip to content

Commit 5e3b057

Browse files
authored
Update RELEASING.md with contrib.yml notes (#4864)
Added notes on contrib.yml workflow behavior and its limitations during release preparations.
1 parent 102fec2 commit 5e3b057

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

RELEASING.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,18 @@
3333
* Review and merge the pull request that it creates for updating the version.
3434
* Note: If you are doing a patch release in `-core` repo, you should also do an equivalent patch release in `-contrib` repo (even if there's no fix to release), otherwise tests in CI will fail.
3535

36+
### Note on `contrib.yml` Workflow Behavior
37+
38+
The [contrib.yml](https://github.com/open-telemetry/opentelemetry-python/blob/main/.github/workflows/contrib.yml) workflow in the core repository references reusable workflows from opentelemetry-python-contrib using the hard-coded `main` branch.
39+
40+
Because `uses:` statements cannot receive environment variables and workflows cannot patch or modify other workflows, this reference cannot dynamically follow release branches as we are doing in other workflows.
41+
42+
As a result, when preparing a release branch that contains a different set of instrumentations (e.g., older branches without newly added tox environments), CI may attempt to run tests that do not exist on tox in that branch. In this case:
43+
44+
* It is safe to merge the release PR even if the contrib workflow fails for this reason, or
45+
46+
* Optionally update the contrib.yml workflow to point to the corresponding release branch before running CI.
47+
3648
## Making the release
3749

3850
* Run the [Release workflow](https://github.com/open-telemetry/opentelemetry-python/actions/workflows/release.yml).

0 commit comments

Comments
 (0)