Skip to content

Commit 0b5c871

Browse files
authored
RELEASING: clarify backporting in patch releases (open-telemetry#5171)
1 parent 0844b5e commit 0b5c871

1 file changed

Lines changed: 12 additions & 1 deletion

File tree

RELEASING.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,15 @@
1717

1818
## Preparing a new patch release
1919

20-
* Backport pull request(s) to the release branch.
20+
### Backporting
21+
22+
Creating manual backports of pull request(s) requires the `backport` label to be added in order to have a green CI. Even if there where
23+
no changes on a repo the patch release preparation workflow requires an empty `## Unreleased` header in `CHANGELOG.md`.
24+
25+
Backport of pull request(s) can be automated by a workflow only if there where no changes that will create conflicts in the release
26+
branch, unfortunately every `CHANGELOG.md` change will create one.
27+
28+
To use the workflow to backport pull request(s) to the release branch:
2129
* Run the [Backport workflow](https://github.com/open-telemetry/opentelemetry-python/actions/workflows/backport.yml).
2230
* Press the "Run workflow" button, then select the release branch from the dropdown list,
2331
e.g. `release/v1.9.x`, then enter the pull request number that you want to backport,
@@ -27,6 +35,9 @@
2735
* Review and merge the backport pull request that it generates.
2836
* Merge a pull request to the release branch updating the `CHANGELOG.md`.
2937
* The heading for the unreleased entries should be `## Unreleased`.
38+
39+
### Preparing a patch release
40+
3041
* Run the [Prepare patch release workflow](https://github.com/open-telemetry/opentelemetry-python/actions/workflows/prepare-patch-release.yml).
3142
* Press the "Run workflow" button, then select the release branch from the dropdown list,
3243
e.g. `release/v1.9.x`, and click the "Run workflow" button below that.

0 commit comments

Comments
 (0)