Release workflow simplifications (#356)

* Release workflow simplifications

* doc

* Sync

* Remove prerelease support

* More

* Sync

* Fix

Author: trask

.github/scripts/draft-change-log-entries.sh

@@ -23,6 +23,9 @@ else
   range="v$major.$((minor - 1)).0..HEAD"
 fi
 
+echo "## Unreleased"
+echo
+
 declare -A component_names=()
 component_names["aws-xray/"]="AWS X-Ray"
 component_names["consistent-sampling/"]="Consistent sampling"

.github/scripts/generate-release-contributors.sh

@@ -5,6 +5,11 @@
 
 # this should be run on the release branch
 
+# NOTE if you need to run this script locally, you will need to first:
+#   git fetch upstream main
+#   git push origin upstream/main:main
+#   export GITHUB_REPOSITORY=open-telemetry/opentelemetry-java-contrib
+
 from_version=$1
 
 # get the date of the first commit that was not in the from_version
@@ -80,4 +85,5 @@ echo $contributors1 $contributors2 \
   | grep -v linux-foundation-easycla \
   | grep -v github-actions \
   | grep -v dependabot \
+  | grep -v opentelemetry-java-bot \
   | sed 's/^/@/'

.github/workflows/backport.yml

@@ -10,6 +10,12 @@ jobs:
   backport:
     runs-on: ubuntu-latest
     steps:
+      - run: |
+          if [[ ! $GITHUB_REF_NAME =~ ^release/v[0-9]+\.[0-9]+\.x$ ]]; then
+            echo this workflow should only be run against release branches
+            exit 1
+          fi
+
       - uses: actions/checkout@v3
         with:
           # history is needed to run git cherry-pick below
@@ -21,12 +27,11 @@ jobs:
       - name: Create pull request
         env:
           NUMBER: ${{ github.event.inputs.number }}
-          # not using the default GITHUB_TOKEN because pull requests generated by it do not run any workflows
+          # not using secrets.GITHUB_TOKEN since pull requests from that token do not run workflows
           GITHUB_TOKEN: ${{ secrets.BOT_TOKEN }}
         run: |
           commit=$(gh pr view $NUMBER --json mergeCommit --jq .mergeCommit.oid)
           title=$(gh pr view $NUMBER --json title --jq .title)
-          url=$(gh pr view $NUMBER --json url --jq .url)
 
           branch="backport-${NUMBER}-to-${GITHUB_REF_NAME//\//-}"
 

.github/workflows/merge-change-log-to-main.yml

@@ -8,10 +8,21 @@ jobs:
     steps:
       - uses: actions/checkout@v3
 
+      - run: |
+          if [[ ! $GITHUB_REF_NAME =~ ^release/v[0-9]+\.[0-9]+\.x$ ]]; then
+            echo this workflow should only be run against release branches
+            exit 1
+          fi
+
+          if ! grep --quiet "^## Unreleased$" CHANGELOG.md; then
+            echo the change log is missing an \"Unreleased\" section
+            exit 1
+          fi
+
       - name: Set environment variables
         run: |
           version=$(.github/scripts/get-version.sh)
-          if [[ $version =~ ([0-9]+\.[0-9]+)\.([0-9]+) ]]; then
+          if [[ $version =~ ^([0-9]+\.[0-9]+)\.([0-9]+)$ ]]; then
             major_minor="${BASH_REMATCH[1]}"
             patch="${BASH_REMATCH[2]}"
           else
@@ -20,22 +31,20 @@ jobs:
           fi
           echo "VERSION=$major_minor.$((patch + 1))" >> $GITHUB_ENV
 
-      - name: Check change log has been updated
-        run: |
-          if ! grep --quiet "^## Version $VERSION" CHANGELOG.md; then
-            echo the change log needs to be updated
-            exit 1
-          fi
-
       - name: Update version
         run: .github/scripts/update-version.sh $VERSION
 
+      - name: Update the change log with the approximate release date
+        run: |
+          date=$(date "+%Y-%m-%d")
+          sed -Ei "s/^## Unreleased$/## Version $VERSION ($date)/" CHANGELOG.md
+
       - name: Set git user
         run: .github/scripts/set-git-user.sh
 
       - name: Create pull request
         env:
-          # not using the default GITHUB_TOKEN because pull requests generated by it do not run any workflows
+          # not using secrets.GITHUB_TOKEN since pull requests from that token do not run workflows
           GITHUB_TOKEN: ${{ secrets.BOT_TOKEN }}
         run: |
           message="Prepare release $VERSION"

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

@@ -9,10 +9,13 @@ jobs:
       - uses: actions/checkout@v3
 
       - run: |
-          version=$(.github/scripts/get-version.sh)
-          version=${version//-SNAPSHOT/}
-          if ! grep --quiet "^## Version $version" CHANGELOG.md; then
-            echo the change log needs to be updated
+          if [[ $GITHUB_REF_NAME != main ]]; then
+            echo this workflow should only be run against main
+            exit 1
+          fi
+
+          if ! grep --quiet "^## Unreleased$" CHANGELOG.md; then
+            echo the change log is missing an \"Unreleased\" section
             exit 1
           fi
 
@@ -23,11 +26,15 @@ jobs:
       - uses: actions/checkout@v3
 
       - name: Create release branch
-        id: create-release-branch
         run: |
           version=$(.github/scripts/get-version.sh)
           version=${version//-SNAPSHOT/}
-          release_branch_name=$(echo $version | sed -E 's/([0-9]+)\.([0-9]+)\.0/release\/v\1.\2.x/')
+          if [[ $version =~ ^([0-9]+)\.([0-9]+)\.0$ ]]; then
+            release_branch_name=$(echo $version | sed -E 's/([0-9]+)\.([0-9]+)\.0/release\/v\1.\2.x/')
+          else
+            echo "unexpected version: $version"
+            exit 1
+          fi
 
           git push origin HEAD:$release_branch_name
 
@@ -37,12 +44,17 @@ jobs:
       - name: Update version
         run: .github/scripts/update-version.sh $VERSION
 
+      - name: Update the change log with the approximate release date
+        run: |
+          date=$(date "+%Y-%m-%d")
+          sed -Ei "s/^## Unreleased$/## Version $VERSION ($date)/" CHANGELOG.md
+
       - name: Set git user
         run: .github/scripts/set-git-user.sh
 
       - name: Create pull request against the release branch
         env:
-          # not using the default GITHUB_TOKEN because pull requests generated by it do not run any workflows
+          # not using secrets.GITHUB_TOKEN since pull requests from that token do not run workflows
           GITHUB_TOKEN: ${{ secrets.BOT_TOKEN }}
         run: |
           message="Prepare release $VERSION"
@@ -64,26 +76,33 @@ jobs:
       - name: Set environment variables
         run: |
           version=$(.github/scripts/get-version.sh)
-          if [[ $version =~ ([0-9]+)\.([0-9]+)\.0 ]]; then
+          version=${version//-SNAPSHOT/}
+          if [[ $version =~ ^([0-9]+)\.([0-9]+)\.0$ ]]; then
             major="${BASH_REMATCH[1]}"
             minor="${BASH_REMATCH[2]}"
+            next_version="$major.$((minor + 1)).0"
           else
             echo "unexpected version: $version"
             exit 1
           fi
-          next_version="$major.$((minor + 1)).0"
-          next_version="${next_version}-SNAPSHOT"
-          echo "NEXT_VERSION=$next_version" >> $GITHUB_ENV
+          echo "NEXT_VERSION=${next_version}-SNAPSHOT" >> $GITHUB_ENV
+          echo "VERSION=$version" >> $GITHUB_ENV
 
       - name: Update version
         run: .github/scripts/update-version.sh $NEXT_VERSION
 
+      - name: Update the change log on main
+        run: |
+          # the actual release date on main will be updated at the end of the release workflow
+          date=$(date "+%Y-%m-%d")
+          sed -Ei "s/^## Unreleased$/## Unreleased\n\n## Version $VERSION ($date)/" CHANGELOG.md
+
       - name: Set git user
         run: .github/scripts/set-git-user.sh
 
       - name: Create pull request against main
         env:
-          # not using the default GITHUB_TOKEN because pull requests generated by it do not run any workflows
+          # not using secrets.GITHUB_TOKEN since pull requests from that token do not run workflows
           GITHUB_TOKEN: ${{ secrets.BOT_TOKEN }}
         run: |
           message="Update version to $NEXT_VERSION"