open-telemetry
/
opentelemetry-python-contrib
mirror of https://github.com/open-telemetry/opentelemetry-python-contrib.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

RELEASING: Document what package prepare release workflows will create (#3153) 

While at it fix formatting
This commit is contained in:
Riccardo Magliocchetti 2024-12-30 14:13:07 +01:00 committed by GitHub
parent 72dc1cf1f6
commit 8db1479e0d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
RELEASING.md
View File

@ -21,6 +21,7 @@
> - opentelemetry-resource-detector-azure > - opentelemetry-resource-detector-azure
> - opentelemetry-sdk-extension-aws > - opentelemetry-sdk-extension-aws
> - opentelemetry-instrumentation-openai-v2 > - opentelemetry-instrumentation-openai-v2
>
> These libraries are also excluded from the general release. > These libraries are also excluded from the general release.
Package release preparation is handled by the [`[Package] Prepare release`](./.github/workflows/package-prepare-release.yml) workflow that allows Package release preparation is handled by the [`[Package] Prepare release`](./.github/workflows/package-prepare-release.yml) workflow that allows
@ -28,6 +29,8 @@ to pick a specific package to release. It follows the same versioning strategy a
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. 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.
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.
## Preparing a new patch release ## Preparing a new patch release
* Backport pull request(s) to the release branch. * Backport pull request(s) to the release branch.
@ -54,6 +57,8 @@ to pick a specific package to release.
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`. 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`.
The workflow will create a pull request that should be merged in order to proceed with the release.
## Making the release ## Making the release
* Run the [Release workflow](https://github.com/open-telemetry/opentelemetry-python-contrib/actions/workflows/release.yml). * Run the [Release workflow](https://github.com/open-telemetry/opentelemetry-python-contrib/actions/workflows/release.yml).