From 5d1e2a5b8812ba60fe2b4630b73462dcb4d6864e Mon Sep 17 00:00:00 2001 From: Sam Xie Date: Thu, 9 May 2024 15:05:56 -0700 Subject: [PATCH] Update `RELEASING.md` to obtain steps to verify the changes for contrib (#5284) * Add steps to verify the code changes for contrib * Update release issue template * Relace steps with the refernece to contrib * Update RELEASING.md Co-authored-by: Tyler Yahn --------- Co-authored-by: Tyler Yahn --- .github/ISSUE_TEMPLATE/version_release.md | 2 +- RELEASING.md | 6 ++++++ 2 files changed, 7 insertions(+), 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) diff --git a/RELEASING.md b/RELEASING.md index d2691d0bd8b..940f57f3d87 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -27,6 +27,12 @@ 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 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 First, decide which module sets will be released and update their versions