Workflow updates and fixes (#286)

* Port open-telemetry/opentelemetry-java#4353

* Port open-telemetry/opentelemetry-java#4359

* Port open-telemetry/opentelemetry-java#4361

* Port open-telemetry/opentelemetry-java#4362

* More syncing

* And sync markdown link check

Author: trask

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

@@ -0,0 +1,13 @@
+#!/bin/bash -e
+
+for file in "$@"; do
+  for i in 1 2 3; do
+    if markdown-link-check --config "$(dirname "$0")/markdown-link-check-config.json" \
+                           "$file"; then
+      break
+    elif [[ $i == 3 ]]; then
+      exit 1
+    fi
+    sleep 5
+  done
+done

.github/scripts/markdown-link-check-with-retry.sh

@@ -12,7 +12,7 @@ jobs:
     steps:
       - uses: actions/checkout@v3
         with:
-          # history is needed in order to do cherry-pick
+          # history is needed to run git cherry-pick below
           fetch-depth: 0
 
       - name: Set git user

.github/workflows/backport.yml

@@ -71,7 +71,8 @@ jobs:
       - build
       - integration-test
     runs-on: ubuntu-latest
-    if: ${{ github.repository == 'open-telemetry/opentelemetry-java-contrib' }}
+    # skipping release branches because the versions in those branches are not snapshots
+    if: ${{ github.ref_name == 'main' && github.repository == 'open-telemetry/opentelemetry-java-contrib' }}
     steps:
       - uses: actions/checkout@v3
 

.github/workflows/build.yml

@@ -0,0 +1,34 @@
+name: Merge change log to main
+on:
+  workflow_dispatch:
+
+jobs:
+  create-pull-request:
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          # this workflow is run against the release branch (see usage of GITHUB_REF_NAME below)
+          # but it is creating a pull request against main
+          ref: main
+          # history is needed to run format-patch below
+          fetch-depth: 0
+
+      - name: Set git user
+        run: |
+          git config user.name opentelemetry-java-bot
+          git config user.email [email protected]
+
+        # this will fail if there have been conflicting change log updates introduced in main
+      - name: Create pull request against main
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          git format-patch --stdout HEAD..origin/$GITHUB_REF_NAME CHANGELOG.md | git apply
+          msg="Merge change log updates from $GITHUB_REF_NAME to main"
+          git commit -a -m "$msg"
+          git push origin HEAD:merge-change-log-updates-to-main
+          gh pr create --title "$msg" \
+                       --body "$msg" \
+                       --head merge-change-log-updates-to-main \
+                       --base main

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

@@ -19,17 +19,16 @@ jobs:
           echo "VERSION=$version" >> $GITHUB_ENV
           echo "RELEASE_BRANCH_NAME=$release_branch_name" >> $GITHUB_ENV
 
-      - name: Bump version
+      - name: Drop snapshot from version
         run: |
-          sed -ri "s/$VERSION-SNAPSHOT/$VERSION/" version.gradle.kts
-          sed -ri "s/$VERSION-alpha-SNAPSHOT/$VERSION-alpha/" version.gradle.kts
+          sed -ri "s/val snapshot = true/val snapshot = false/" version.gradle.kts
 
       - name: Set git user
         run: |
           git config user.name opentelemetry-java-bot
           git config user.email [email protected]
 
-      - name: Create pull request against release branch
+      - name: Create pull request against the release branch
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
@@ -58,7 +57,6 @@ jobs:
           fi
           next_version="$major.$((minor + 1)).0"
           sed -ri "s/$version-SNAPSHOT/$next_version-SNAPSHOT/" version.gradle.kts
-          sed -ri "s/$version-apha-SNAPSHOT/$next_version-apha-SNAPSHOT/" version.gradle.kts
 
       - name: Set git user
         run: |

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

@@ -105,16 +105,17 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
-          if [[ $version == *.0 ]]; then
-            cat > release-notes.txt << EOF
-            This release targets the OpenTelemetry SDK $VERSION.
+          # conditional blocks not indented because of the heredoc
+          if [[ $VERSION == *.0 ]]; then
+          cat > release-notes.txt << EOF
+          This release targets the OpenTelemetry SDK $VERSION.
 
-            EOF
+          EOF
           else
-            cat > release-notes.txt << EOF
-            This is a patch release on the previous $PRIOR_VERSION release, fixing the issue(s) below.
+          cat > release-notes.txt << EOF
+          This is a patch release on the previous $PRIOR_VERSION release, fixing the issue(s) below.
 
-            EOF
+          EOF
           fi
 
           sed -n "/^## Version $VERSION/,/^## Version /p" CHANGELOG.md \
@@ -126,15 +127,16 @@ jobs:
             | perl -0pe 's/\n +/ /g' \
             >> release-notes.txt
 
-          if [[ $version == *.0 ]]; then
-            cat >> release-notes.txt << EOF
+          # conditional block not indented because of the heredoc
+          if [[ $VERSION == *.0 ]]; then
+          cat >> release-notes.txt << EOF
 
-            ### 🙇 Thank you
-            This release was possible thanks to the following contributors who shared their brilliant ideas and awesome pull requests:
+          ### 🙇 Thank you
+          This release was possible thanks to the following contributors who shared their brilliant ideas and awesome pull requests:
 
-            EOF
+          EOF
 
-            .github/scripts/generate-release-contributors.sh v$PRIOR_VERSION v$VERSION >> release-notes.txt
+          .github/scripts/generate-release-contributors.sh v$PRIOR_VERSION $GITHUB_REF_NAME >> release-notes.txt
           fi
 
       - name: Create GitHub release
@@ -149,31 +151,24 @@ jobs:
                             v$VERSION \
                             opentelemetry-jmx-metrics.jar
 
-      - uses: actions/checkout@v3
-        with:
-          ref: main
-          # history is needed in order to generate the patch
-          fetch-depth: 0
+      - name: Update the change log with the release date
+        run: |
+          date=$(gh release view v$VERSION --json publishedAt --jq .publishedAt | sed 's/T.*//')
+          sed -ri "s/## Version $VERSION .*/## Version $VERSION ($date)/" CHANGELOG.md
 
       - name: Set git user
         run: |
           git config user.name opentelemetry-java-bot
           git config user.email [email protected]
 
-        # this step should be last since it will fail if there have been conflicting
-        # change log updates introduced on the main branch
-      - name: Create pull request to merge any change log updates to main
+      - name: Create pull request against the release branch
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
-          git format-patch --stdout main..$GITHUB_REF_NAME CHANGELOG.md > patch
-          if [ -s patch ]; then
-            git apply patch
-            msg="Merge change log updates from $GITHUB_REF_NAME to main"
-            git commit -a -m "$msg"
-            git push origin HEAD:merge-change-log-updates-to-main
-            gh pr create --title "$msg" \
-                         --body "$msg" \
-                         --head merge-change-log-updates-to-main \
-                         --base main
-          fi
+          msg="Add $VERSION release date to the change log"
+          git commit -a -m "$msg"
+          git push origin HEAD:add-$VERSION-release-date
+          gh pr create --title "[$GITHUB_REF_NAME] $msg" \
+                       --body "$msg" \
+                       --head add-$VERSION-release-date \
+                       --base $GITHUB_REF_NAME

.github/workflows/release.yml

@@ -14,8 +14,7 @@ jobs:
 
       - name: Run markdown-link-check
         run: |
-          # --quiet displays errors only, making them easier to find in the log
           find . -type f \
                  -name '*.md' \
                  -not -path './CHANGELOG.md' \
-                 | xargs markdown-link-check --quiet --config .github/scripts/markdown-link-check-config.json
+               | xargs .github/scripts/markdown-link-check-with-retry.sh

.github/workflows/reusable-markdown-link-check.yml

@@ -1,12 +1,12 @@
 # Changelog
 
-## Unreleased
+## Version 1.13.0 (unreleased)
 
-## Version 1.12.0 - 2022-03-14
+## Version 1.12.0 (2022-03-14)
 
 All components updated to target OpenTelemetry SDK 1.12.0.
 
-## Version 1.11.0 - 2022-03-03
+## Version 1.11.0 (2022-03-03)
 
 All components updated to target OpenTelemetry SDK 1.11.0.
 
@@ -38,7 +38,7 @@ All components updated to target OpenTelemetry SDK 1.11.0.
 * Update file total metric
   ([#234](https://github.com/open-telemetry/opentelemetry-java-contrib/pull/234))
 
-## Version 1.10.0 - 2022-01-18
+## Version 1.10.0 (2022-01-18)
 
 All components updated to target OpenTelemetry SDK 1.10.0.
 
@@ -75,7 +75,7 @@ All components updated to target OpenTelemetry SDK 1.10.0.
 * Rename contrib-samplers to samplers
   ([#185](https://github.com/open-telemetry/opentelemetry-java-contrib/pull/185))
 
-## Version 1.9.0 - 2021-12-03
+## Version 1.9.0 (2021-12-03)
 
 All components updated to target OpenTelemetry SDK 1.9.1.
 
@@ -104,7 +104,7 @@ All components updated to target OpenTelemetry SDK 1.9.1.
 
 Skipped to stay in sync with other OpenTelemetry Java repositories.
 
-## Version 1.7.0 - 2021-10-29
+## Version 1.7.0 (2021-10-29)
 
 All components updated to target OpenTelemetry SDK 1.7.0.
 
@@ -140,15 +140,15 @@ Allows programmatic attach of Javaagent.
 * Use the [OpenTelemetry SDK Autoconfigure extension](https://github.com/open-telemetry/opentelemetry-java/tree/main/sdk-extensions/autoconfigure) to support more configuration setting. All the settings of the OTLP exporter are supported.
   ([#112](https://github.com/open-telemetry/opentelemetry-java-contrib/pull/112))
 
-## Version 1.6.0 - 2021-09-22
+## Version 1.6.0 (2021-09-22)
 
 All components updated to target OpenTelemetry SDK 1.6.0.
 
 ### Maven extension - New 🌟
 
 This extension can be registered in a Maven build to trace different build steps, for example project build and Maven plugin executions.
 
-## Version 1.5.0 - 2021-09-21
+## Version 1.5.0 (2021-09-21)
 
 All components updated to target OpenTelemetry SDK 1.5.0.
 
@@ -159,7 +159,7 @@ All components updated to target OpenTelemetry SDK 1.5.0.
   * `*Sum` have been replaced with `*Counter`
   * `*Observer` have been replaced with `*Callback` and do not return any object anymore
 
-## Version 1.4.0 - 2021-08-13
+## Version 1.4.0 (2021-08-13)
 
 All components updated to target OpenTelemetry SDK 1.4.0.
 
@@ -171,7 +171,7 @@ This library contains OTel extensions for use with [AWS X-Ray](https://docs.aws.
 
 * Because of numerous backwards incompatible changes in the OpenTelemetry Metrics data model, you will want to make sure you are running the latest version of the OpenTelemetry collector. Older versions will likely not process metrics correctly.
 
-## Version 1.0.0-alpha - 2021-06-02
+## Version 1.0.0-alpha (2021-06-02)
 
 ### JMX metrics - New 🌟
 

CHANGELOG.md

@@ -14,6 +14,8 @@ as the last step, which publishes a snapshot build to
 
 * Close the release milestone if there is one.
 * Merge a pull request to `main` updating the `CHANGELOG.md`.
+  * The heading for the release should include the release version but not the release date, e.g.
+  `## Version 1.9.0 (unreleased)`.
 * Run the [Prepare release branch workflow](.github/workflows/prepare-release-branch.yml).
 * Review and merge the two pull requests that it creates
   (one is targeted to the release branch and one is targeted to the `main` branch).
@@ -24,26 +26,40 @@ All patch releases should include only bug-fixes, and must avoid adding/modifyin
 
 In general, patch releases are only made for regressions, memory leaks and deadlocks.
 
-* Backport pull request(s) to the release branch
+* Backport pull request(s) to the release branch.
   * Run the [Backport workflow](.github/workflows/backport.yml).
   * Press the "Run workflow" button, then select the release branch from the dropdown list,
     e.g. `release/v1.9.x`, then enter the pull request number that you want to backport,
     then click the "Run workflow" button below that.
-  * Review and merge the backport pull request that it generates
-* Merge a pull request to the release branch updating the `CHANGELOG.md`
+  * Review and merge the backport pull request that it generates.
+* Merge a pull request to the release branch updating the `CHANGELOG.md`.
+  * The heading for the release should include the release version but not the release date, e.g.
+  `## Version 1.9.0 (unreleased)`.
 * Run the [Prepare patch release workflow](.github/workflows/prepare-patch-release.yml).
   * Press the "Run workflow" button, then select the release branch from the dropdown list,
     e.g. `release/v1.9.x`, and click the "Run workflow" button below that.
-* Review and merge the pull request that it creates
+* Review and merge the pull request that it creates.
 
 ## Making the release
 
 Run the [Release workflow](.github/workflows/release.yml).
 
 * Press the "Run workflow" button, then select the release branch from the dropdown list,
   e.g. `release/v1.9.x`, and click the "Run workflow" button below that.
-* This workflow will publish the artifacts to maven central and will publish a GitHub release with
-  release notes based on the change log and with the javaagent jar attached.
-* Lastly, if there were any change log updates in the release branch that need to be merged back to
-  the main branch, the workflow will create a pull request if the updates can be cleanly applied,
-  or it will fail this last step if the updates cannot be cleanly applied.
+* This workflow will publish the artifacts to maven central and will publish a GitHub release
+  with release notes based on the change log and with the jmx metrics jar attached.
+* Review and merge the pull request that the release workflow creates against the release branch
+  which adds the release date to the change log.
+
+## After the release
+
+Run the [Merge change log to main workflow](.github/workflows/merge-change-log-to-main.yml).
+
+* Press the "Run workflow" button, then select the release branch from the dropdown list,
+  e.g. `release/v1.9.x`, and click the "Run workflow" button below that.
+* This will create a pull request that merges the change log updates from the release branch
+  back to main.
+* Review and merge the pull request that it creates.
+* This workflow will fail if there have been conflicting change log updates introduced in main,
+  in which case you will need to merge the change log updates manually and send your own pull
+  request against main.