Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update RELEASING.md to obtain steps to verify the changes for contrib #5284

Merged
merged 7 commits into from
May 9, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/version_release.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ assignees: ''
<!--- The current milestones can be found at https://github.com/open-telemetry/opentelemetry-go/milestones -->
- [ ] Complete [Milestone](https://github.com/open-telemetry/opentelemetry-go/milestone/<Release Milesone>)
<!-- markdownlint-enable MD034 -->
- [ ] Update contrib codebase to support changes about to be released (use a git sha version)
- [ ] [Update contrib codebase to support changes about to be released (use a git sha version)](https://github.com/open-telemetry/opentelemetry-go/blob/main/RELEASING.md#verify-changes-for-contrib-repository)
- [ ] [Pre-release](https://github.com/open-telemetry/opentelemetry-go/blob/main/RELEASING.md#pre-release)
- [ ] [Tag](https://github.com/open-telemetry/opentelemetry-go/blob/main/RELEASING.md#tag)
- [ ] [Release](https://github.com/open-telemetry/opentelemetry-go/blob/main/RELEASING.md#release)
Expand Down
31 changes: 31 additions & 0 deletions RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,37 @@ You can run `make gorelease` that runs [gorelease](https://pkg.go.dev/golang.org

You can check/report problems with `gorelease` [here](https://golang.org/issues/26420).

## Verify changes for contrib repository

If the changes in the main repository are going to affect the contrib repository, it is important to verify that the changes are compatible with the contrib repository.

Follow the following steps in the local [contrib repository](https://github.com/open-telemetry/opentelemetry-go-contrib) 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.
XSAM marked this conversation as resolved.
Show resolved Hide resolved
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.

```
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.

## Pre-Release

First, decide which module sets will be released and update their versions
Expand Down