Skip to content

Commit

Permalink
Update release instructions (#10431)
Browse files Browse the repository at this point in the history
Step 8 in the core release process references a draft PR opened in Step
1. However, Step 1 was changed somewhat recently to state that this PR
should be merged before proceeding. Therefore, a new PR should be
opened. Since this new PR is for contrib and no longer directly
associated with a step in the core process, it makes sense to move it to
Step 1 of contrib section.
  • Loading branch information
djaglowski committed Jun 18, 2024
1 parent ae2ed9d commit 0ca892a
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions docs/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,25 +50,25 @@ It is possible that a core approver isn't a contrib approver. In that case, the

7. A new `v0.85.0` release should be automatically created on Github by now. Edit it and use the contents from the CHANGELOG.md and CHANGELOG-API.md as the release's description.

8. Update the draft PR to Contrib created in step 1 to use the newly released Core version and set it to Ready for Review.
## Releasing opentelemetry-collector-contrib

1. Open a PR to Contrib to use the newly released Core version and set it to Ready for Review.
- Run `make update-otel OTEL_VERSION=v0.85.0 OTEL_STABLE_VERSION=v1.1.0`
- Manually update `cmd/otelcontribcol/builder-config.yaml`
- Manually update `cmd/oteltestbedcol/builder-config.yaml`
- Run `make genotelcontribcol`
- Push updates to the PR
- πŸ›‘ **Do not move forward until this PR is merged.** πŸ›‘

## Releasing opentelemetry-collector-contrib

1. Manually run the action [Automation - Prepare Release](https://github.com/open-telemetry/opentelemetry-collector-contrib/actions/workflows/prepare-release.yml). When prompted, enter the version numbers determined in Step 1, but do not include a leading `v`. This action will create a pull request to update the changelog and version numbers in the repo. **While this PR is open all merging in Contrib should be halted**.
2. Manually run the action [Automation - Prepare Release](https://github.com/open-telemetry/opentelemetry-collector-contrib/actions/workflows/prepare-release.yml). When prompted, enter the version numbers determined in Step 1, but do not include a leading `v`. This action will create a pull request to update the changelog and version numbers in the repo. **While this PR is open all merging in Contrib should be halted**.
- If the PR needs updated in any way you can make the changes in a fork and PR those changes into the `prepare-release-prs/x` branch. You do not need to wait for the CI to pass in this prep-to-prep PR.
- πŸ›‘ **Do not move forward until this PR is merged.** πŸ›‘

2. Check out the commit created by merging the PR created by `Automation - Prepare Release` (e.g. `prepare-release-prs/0.85.0`) and create a branch named `release/<release-series>` (e.g. `release/v0.85.x`). Push the new branch to `open-telemetry/opentelemetry-collector-contrib`.
3. Check out the commit created by merging the PR created by `Automation - Prepare Release` (e.g. `prepare-release-prs/0.85.0`) and create a branch named `release/<release-series>` (e.g. `release/v0.85.x`). Push the new branch to `open-telemetry/opentelemetry-collector-contrib`.

3. Make sure you are on `release/<release-series>`. Tag all the module groups (`contrib-base`) with the new release version by running the `make push-tags MODSET=contrib-base` command. If you set your remote using `https` you need to include `REMOTE=https://github.com/open-telemetry/opentelemetry-collector-contrib.git` in each command. Wait for the new tag build to pass successfully.
4. Make sure you are on `release/<release-series>`. Tag all the module groups (`contrib-base`) with the new release version by running the `make push-tags MODSET=contrib-base` command. If you set your remote using `https` you need to include `REMOTE=https://github.com/open-telemetry/opentelemetry-collector-contrib.git` in each command. Wait for the new tag build to pass successfully.

4. A new `v0.85.0` release should be automatically created on Github by now. Edit it and use the contents from the CHANGELOG.md as the release's description.
5. A new `v0.85.0` release should be automatically created on Github by now. Edit it and use the contents from the CHANGELOG.md as the release's description.

## Producing the artifacts

Expand Down

0 comments on commit 0ca892a

Please sign in to comment.