Skip to content

Commit 3e97428

Browse files
authored
Update RELEASING.md (#196)
* Update RELEASING.md * Fix repo
1 parent 5d2edc2 commit 3e97428

File tree

3 files changed

+18
-1
lines changed

3 files changed

+18
-1
lines changed

RELEASING.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,10 @@ next _minor_ release version. This means version `vX.(Y+1).0-SNAPSHOT`.
1515

1616
## Starting the Release
1717

18+
Before making the release, merge a PR to `main` updating the `CHANGELOG.md`. You can use the script
19+
at `buildscripts/draft-change-log-entries.sh` to help create an initial draft. We typically only
20+
include end-user facing changes in the change log.
21+
1822
Open the release build workflow in your browser [here](https://github.com/open-telemetry/opentelemetry-java-contrib/actions/workflows/release-build.yml).
1923

2024
You will see a button that says "Run workflow". Press the button, enter the version number you want
@@ -28,7 +32,8 @@ and pushes a git tag with the version number.
2832
Once the GitHub workflow completes, go to Github [release
2933
page](https://github.com/open-telemetry/opentelemetry-java-contrib/releases), press
3034
`Draft a new release` to write release notes about the new release. If there is already a draft
31-
release notes, just point it at the created tag.
35+
release notes, just point it at the created tag. You can use the script at
36+
`buildscripts/draft-release-notes.sh` to generate release notes from the change log.
3237

3338
### Notifying other OpenTelemetry projects
3439

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
#!/bin/bash -e
2+
3+
for component in aws-xray samplers jfr-streaming jmx-metrics maven-extension runtime-attach; do
4+
echo "* $component"
5+
git log --reverse --pretty=format:" * %s" "$1"..HEAD $component \
6+
| sed -r 's,\(#([0-9]+)\),\n ([#\1](https://github.com/open-telemetry/opentelemetry-java-contrib/pull/\1)),'
7+
echo
8+
done
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
#!/bin/bash -e
2+
3+
sed -r 's,\[#([0-9]+)]\(https://github.com/open-telemetry/opentelemetry-java-contrib/pull/[0-9]+\),#\1,' CHANGELOG.md \
4+
| perl -0pe 's/\n +/ /g'

0 commit comments

Comments
 (0)