Generate release notes from change log (#249)

* Generate release notes from change log

* Update release instructions

* Patch releases too

Author: trask

.github/workflows/patch-release-build.yml

@@ -126,6 +126,33 @@ jobs:
           GPG_PRIVATE_KEY: ${{ secrets.GPG_PRIVATE_KEY }}
           GPG_PASSWORD: ${{ secrets.GPG_PASSWORD }}
 
+      - name: Set SDK version
+        id: set-sdk-version
+        run: |
+          v=$(grep -Po "io.opentelemetry:opentelemetry-bom:\K[0-9]+.[0-9]+.0" dependencyManagement/build.gradle.kts)
+          echo "::set-output name=sdk-version::$v"
+
+      - name: Generate Release Notes
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          cat > release-notes.txt << EOF
+          This release targets the OpenTelemetry SDK ${{ steps.set-sdk-version.outputs.sdk-version }}.
+
+          EOF
+
+          sed -n '/^## Version ${{ github.event.inputs.version }}/,/^## Version /p' CHANGELOG.md \
+            | head -n -1 \
+            | perl -0pe 's/^\n+//g' \
+            | perl -0pe 's/\n+$/\n/g' \
+            | sed -r 's,\[#([0-9]+)]\(https://github.com/open-telemetry/opentelemetry-java-contrib/pull/[0-9]+\),#\1,' \
+            | perl -0pe 's/\n +/ /g' \
+            >> release-notes.txt
+
+          cat >> release-notes.txt << EOF
+
+          EOF
+
       - name: Create Release
         id: create_release
         uses: actions/[email protected]
@@ -136,6 +163,7 @@ jobs:
           release_name: Version ${{ github.event.inputs.version }}
           draft: true
           prerelease: false
+          body_path: release-notes.txt
 
       - name: Upload jmx-metrics release asset
         id: upload-release-asset-jmx-metrics

.github/workflows/release-build.yml

@@ -85,6 +85,33 @@ jobs:
           GPG_PRIVATE_KEY: ${{ secrets.GPG_PRIVATE_KEY }}
           GPG_PASSWORD: ${{ secrets.GPG_PASSWORD }}
 
+      - name: Set SDK version
+        id: set-sdk-version
+        run: |
+          v=$(grep -Po "io.opentelemetry:opentelemetry-bom:\K[0-9]+.[0-9]+.0" dependencyManagement/build.gradle.kts)
+          echo "::set-output name=sdk-version::$v"
+
+      - name: Generate Release Notes
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          cat > release-notes.txt << EOF
+          This release targets the OpenTelemetry SDK ${{ steps.set-sdk-version.outputs.sdk-version }}.
+
+          EOF
+
+          sed -n '/^## Version ${{ github.event.inputs.version }}/,/^## Version /p' CHANGELOG.md \
+            | head -n -1 \
+            | perl -0pe 's/^\n+//g' \
+            | perl -0pe 's/\n+$/\n/g' \
+            | sed -r 's,\[#([0-9]+)]\(https://github.com/open-telemetry/opentelemetry-java-contrib/pull/[0-9]+\),#\1,' \
+            | perl -0pe 's/\n +/ /g' \
+            >> release-notes.txt
+
+          cat >> release-notes.txt << EOF
+
+          EOF
+
       - name: Create Release
         id: create_release
         uses: actions/[email protected]
@@ -95,6 +122,7 @@ jobs:
           release_name: Version ${{ github.event.inputs.version }}
           draft: true
           prerelease: false
+          body_path: release-notes.txt
 
       - name: Upload jmx-metrics release asset
         id: upload-release-asset-jmx-metrics

RELEASING.md

@@ -27,13 +27,11 @@ to release in the input field that pops up, and then press "Run workflow".
 This triggers the release process, which builds the artifacts, publishes the artifacts, and creates
 and pushes a git tag with the version number.
 
-## Announcement
-
-Once the GitHub workflow completes, go to Github [release
-page](https://github.com/open-telemetry/opentelemetry-java-contrib/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. You can use the script at
-`buildscripts/draft-release-notes.sh` to generate release notes from the change log.
+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
+* Select the checkbox for "Create a discussion for this release"
+* Press the "Publish release" button
 
 ### Notifying other OpenTelemetry projects
 
@@ -89,3 +87,9 @@ applied automatically, we need to do code review to make sure the manual cherryp
 After it is merged, Run the patch release workflow again, but leave the commits input field blank.
 The release will be made with the current state of the release branch, which is what you prepared
 above.
+
+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
+* Select the checkbox for "Create a discussion for this release"
+* Press the "Publish release" button