Skip to content

Commit 8db1479

Browse files
authored
RELEASING: Document what package prepare release workflows will create (#3153)
While at it fix formatting
1 parent 72dc1cf commit 8db1479

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

RELEASING.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,16 @@
2121
> - opentelemetry-resource-detector-azure
2222
> - opentelemetry-sdk-extension-aws
2323
> - opentelemetry-instrumentation-openai-v2
24+
>
2425
> These libraries are also excluded from the general release.
2526
2627
Package release preparation is handled by the [`[Package] Prepare release`](./.github/workflows/package-prepare-release.yml) workflow that allows
2728
to pick a specific package to release. It follows the same versioning strategy and process as the general release.
2829

2930
Long-term package release branch follows `package-release/{package-name}/v{major}.{minor}.x` (or `package-release/{package-name}/v{major}.{minor}bx`) naming pattern.
3031

32+
The workflow will create two pull requests, one against the `main` and one against the `package-release/` branch; both should be merged in order to proceed with the release.
33+
3134
## Preparing a new patch release
3235

3336
* Backport pull request(s) to the release branch.
@@ -54,6 +57,8 @@ to pick a specific package to release.
5457

5558
The workflow can only be run against long-term release branch such as `package-release/{package-name}/v{major}.{minor}.x` or `package-release/{package-name}/v{major}.{minor}bx`.
5659

60+
The workflow will create a pull request that should be merged in order to proceed with the release.
61+
5762
## Making the release
5863

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

0 commit comments

Comments
 (0)