From dd72e9e5f43c73d66a773682a6fa37bbf52baf05 Mon Sep 17 00:00:00 2001 From: Trask Stalnaker Date: Tue, 18 Jan 2022 12:07:12 -0800 Subject: [PATCH] Update RELEASING.md (#5131) * Update RELEASING.md * Remove generate-release-contributors.sh * Simplify --- RELEASING.md | 9 +++++---- buildscripts/draft-change-log-entries.sh | 5 +++++ 2 files changed, 10 insertions(+), 4 deletions(-) create mode 100644 buildscripts/draft-change-log-entries.sh diff --git a/RELEASING.md b/RELEASING.md index 3d2274ba9f..ee01b8d85b 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -14,6 +14,8 @@ as the last step, which publishes a snapshot build to Before making the release: * Merge a PR to `main` updating the `CHANGELOG.md` + * Use the script at `buildscripts/draft-change-log-entries.sh` to help create an initial draft. + We typically only include end-user facing changes in the change log. * Run the [Prepare Release Branch workflow](https://github.com/open-telemetry/opentelemetry-java-instrumentation/actions/workflows/prepare-release-branch.yml). * Review and merge the two PRs that it creates (one is targeted to the release branch and one is targeted to the `main` branch) * Delete the branches from these two PRs since they are created in the main repo @@ -33,10 +35,9 @@ After making the release: ## Announcement -Once the GitHub workflow completes, go to Github [release -page](https://github.com/open-telemetry/opentelemetry-java-instrumentation/releases), press -`Draft a new release` to write release notes about the new release. If there is already a draft -release notes, just point it at the created tag. +Once the GitHub workflow completes, go to Github +[release page](https://github.com/open-telemetry/opentelemetry-java-instrumentation/releases), +find the draft release created by the release workflow, and copy the change log into it. ## Patch Release diff --git a/buildscripts/draft-change-log-entries.sh b/buildscripts/draft-change-log-entries.sh new file mode 100644 index 0000000000..a06ae7eef1 --- /dev/null +++ b/buildscripts/draft-change-log-entries.sh @@ -0,0 +1,5 @@ +#!/bin/bash -e + +git log --reverse --pretty=format:"- %s" "$1"..HEAD \ + | sed -r 's,\(#([0-9]+)\),([#\1](https://github.com/open-telemetry/opentelemetry-java-instrumentation/pull/\1)),' +echo