Skip to content

Commit cd5e327

Browse files
committed
RELEASING: clarify usage of backport workflow in patch releases
1 parent cf0662d commit cd5e327

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
@@ -44,7 +44,15 @@ To keep the process lightweight, it's OK to approve the PRs you generate and mer
4444

4545
## Preparing a new patch release
4646

47-
* Backport pull request(s) to the release branch.
47+
### Backporting
48+
49+
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
50+
no changes on a repo the patch release preparation workflow requires an empty `## Unreleased` header in `CHANGELOG.md`.
51+
52+
Backport of pull request(s) can be automated by a workflow only if there where no changes that will create conflicts in the release
53+
branch, unfortunately every `CHANGELOG.md` change will create one.
54+
55+
To use the workflow to backport pull request(s) to the release branch:
4856
* Run the [Backport workflow](https://github.com/open-telemetry/opentelemetry-python-contrib/actions/workflows/backport.yml).
4957
* Press the "Run workflow" button, then select the release branch from the dropdown list,
5058
e.g. `release/v1.9.x`, then enter the pull request number that you want to backport,
@@ -54,6 +62,9 @@ To keep the process lightweight, it's OK to approve the PRs you generate and mer
5462
* Review and merge the backport pull request that it generates.
5563
* Merge a pull request to the release branch updating the `CHANGELOG.md`.
5664
* The heading for the unreleased entries should be `## Unreleased`.
65+
66+
### Preparing a patch release
67+
5768
* Run the [Prepare patch release workflow](https://github.com/open-telemetry/opentelemetry-python-contrib/actions/workflows/prepare-patch-release.yml).
5869
* Press the "Run workflow" button, then select the release branch from the dropdown list,
5970
e.g. `release/v1.9.x`, and click the "Run workflow" button below that.

0 commit comments

Comments
 (0)