From 70d1e3345ad57891b006fa0924bbdbea11406b82 Mon Sep 17 00:00:00 2001 From: Sam Xie Date: Thu, 2 May 2024 15:46:56 -0700 Subject: [PATCH 1/4] Add steps to verify the code changes for contrib --- RELEASING.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/RELEASING.md b/RELEASING.md index d2691d0bd8b..354c03cd101 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -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. +2. Run the following command to update the OTel depencies with the GIT SHA picked in step 1. + + ```sh + export GITSHA= + 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 From abae130f7a3c8ec301666633b733f9abe74cc69e Mon Sep 17 00:00:00 2001 From: Sam Xie Date: Thu, 2 May 2024 15:48:35 -0700 Subject: [PATCH 2/4] Update release issue template --- .github/ISSUE_TEMPLATE/version_release.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/version_release.md b/.github/ISSUE_TEMPLATE/version_release.md index f0a7c0a975a..c321e0eab5b 100644 --- a/.github/ISSUE_TEMPLATE/version_release.md +++ b/.github/ISSUE_TEMPLATE/version_release.md @@ -11,7 +11,7 @@ assignees: '' - [ ] Complete [Milestone](https://github.com/open-telemetry/opentelemetry-go/milestone/) -- [ ] 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) From 52d3b7a09dd5122b86d019ac8039405fd2e76d02 Mon Sep 17 00:00:00 2001 From: Sam Xie Date: Thu, 9 May 2024 09:12:30 -0700 Subject: [PATCH 3/4] Relace steps with the refernece to contrib --- RELEASING.md | 27 +-------------------------- 1 file changed, 1 insertion(+), 26 deletions(-) diff --git a/RELEASING.md b/RELEASING.md index 354c03cd101..d24c9eac055 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -31,32 +31,7 @@ You can check/report problems with `gorelease` [here](https://golang.org/issues/ 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. -2. Run the following command to update the OTel depencies with the GIT SHA picked in step 1. - - ```sh - export GITSHA= - 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. +Follow [the steps](https://github.com/open-telemetry/opentelemetry-go-contrib/blob/main/RELEASING.md#verify-otel-changes) in the contrib repostory to verify OTel changes. ## Pre-Release From 33389e46be6268790922fb3a98c1541b52d76391 Mon Sep 17 00:00:00 2001 From: Sam Xie Date: Thu, 9 May 2024 14:27:45 -0700 Subject: [PATCH 4/4] Update RELEASING.md Co-authored-by: Tyler Yahn --- RELEASING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/RELEASING.md b/RELEASING.md index d24c9eac055..940f57f3d87 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -31,7 +31,7 @@ You can check/report problems with `gorelease` [here](https://golang.org/issues/ 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 steps](https://github.com/open-telemetry/opentelemetry-go-contrib/blob/main/RELEASING.md#verify-otel-changes) in the contrib repostory to verify OTel changes. +Follow [the steps](https://github.com/open-telemetry/opentelemetry-go-contrib/blob/main/RELEASING.md#verify-otel-changes) in the contrib repository to verify OTel changes. ## Pre-Release