Skip to content

Commit

Permalink
Add Verify OTel changes section to releasing file (open-telemetry#5527)
Browse files Browse the repository at this point in the history
Co-authored-by: Tyler Yahn <[email protected]>
  • Loading branch information
2 people authored and zailic committed May 20, 2024
1 parent 55631c9 commit c126478
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,40 @@ tool](https://github.com/open-telemetry/opentelemetry-go-build-tools/tree/main/m
to manage releases. This document will walk you through how to perform a
release using this tool for this repository.

## Before releasing

### Verify OTel changes

Before releasing, it is important to verify that the changes in the upstream
go.opentelemetry.io/otel packages are compatible with the contrib repository.

Follow the following steps to verify the changes.

1. Pick the GIT SHA on the [main branch](https://github.com/open-telemetry/opentelemetry-go/commits/main) that you want to verify.
2. Run the following command to update the OTel depencies with the GIT SHA picked in step 1.

```sh
export GITSHA=<the GIT SHA you want to verify>
make update-all-otel-deps
make go-mod-tidy
```

3. Verify the changes.

```sh
git diff
```

This should have changed the version for all OTel modules to be the GIT SHA picked in step 1.

4. Run the lint and tests to verify that the changes are compatible with the contrib repository.

```sh
make precommit
```

This command should be passed without any errors.

## Start a release

First, decide which module sets will have their versions changed and what those
Expand Down

0 comments on commit c126478

Please sign in to comment.