From b0e6e3f7292249bf5d6ae84209100d2d2f12a1bb Mon Sep 17 00:00:00 2001 From: jackgopack4 Date: Thu, 1 Aug 2024 16:22:24 -0400 Subject: [PATCH] clarify documentation --- docs/release.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/release.md b/docs/release.md index 44809c881df..e71893a2f44 100644 --- a/docs/release.md +++ b/docs/release.md @@ -78,17 +78,19 @@ The last step of the release process creates artifacts for the new version of th 1. Update the builder version in `OTELCOL_BUILDER_VERSION` to the new release in the `Makefile`. While this might not be strictly necessary for every release, this is a good practice. -1. Create a pull request with the change and ensure the build completes successfully. See [example](https://github.com/open-telemetry/opentelemetry-collector-releases/pull/71). This pull request will also initiate and release the opentelemetry collector builder (ocb) binaries in a separate release; this is required to use the newest ocb binary to build the collector distributions below. +1. Create a pull request with the change and ensure the build completes successfully. See [example](https://github.com/open-telemetry/opentelemetry-collector-releases/pull/71). - 🛑 **Do not move forward until this PR is merged.** 🛑 1. Check out the commit created by merging the PR and tag with the new release version by running the `make push-tags TAG=v0.85.0` command. If you set your remote using `https` you need to include `REMOTE=https://github.com/open-telemetry/opentelemetry-collector-releases.git` in each command. Wait for the new tag build to pass successfully. -1. Ensure the "Release Core", "Release Contrib" and "Release k8s" actions pass, this will +1. Ensure the "Release Core", "Release Contrib", "Release k8s", and "Builder - Release" actions pass, this will 1. push new container images to `https://hub.docker.com/repository/docker/otel/opentelemetry-collector`, `https://hub.docker.com/repository/docker/otel/opentelemetry-collector-contrib` and `https://hub.docker.com/repository/docker/otel/opentelemetry-collector-k8s` 1. create a Github release for the tag and push all the build artifacts to the Github release. See [example](https://github.com/open-telemetry/opentelemetry-collector-releases/actions/workflows/release-core.yaml). + 1. build and release ocb binaries under a separate tagged Github release, e.g. `cmd/builder/v0.85.0` + ## Troubleshooting 1. `unknown revision internal/coreinternal/v0.85.0` -- This is typically an indication that there's a dependency on a new module. You can fix it by adding a new `replaces` entry to the `go.mod` for the affected module.