Release #57
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Release | |
| on: | |
| workflow_dispatch: | |
| permissions: | |
| contents: read | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | |
| - name: Set up JDK for running Gradle | |
| uses: actions/setup-java@3a4f6e1af504cf6a31855fa899c6aa5355ba6c12 # v4.7.0 | |
| with: | |
| distribution: temurin | |
| java-version: 17 | |
| - name: Set up gradle | |
| uses: gradle/actions/setup-gradle@94baf225fe0a508e581a564467443d0e2379123b # v4.3.0 | |
| - name: Gradle build | |
| run: ./gradlew build | |
| - uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 # v4.6.0 | |
| name: Save unit test results | |
| if: always() | |
| with: | |
| name: test-results | |
| path: jmx-metrics/build/reports/tests/test | |
| integration-test: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | |
| - name: Set up JDK for running Gradle | |
| uses: actions/setup-java@3a4f6e1af504cf6a31855fa899c6aa5355ba6c12 # v4.7.0 | |
| with: | |
| distribution: temurin | |
| java-version: 17 | |
| - name: Set up gradle | |
| uses: gradle/actions/setup-gradle@94baf225fe0a508e581a564467443d0e2379123b # v4.3.0 | |
| - name: Integration test | |
| run: ./gradlew integrationTest | |
| - uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 # v4.6.0 | |
| name: Save integration test results | |
| if: always() | |
| with: | |
| name: integration-test-results | |
| path: jmx-metrics/build/reports/tests/integrationTest | |
| release: | |
| permissions: | |
| contents: write # for creating the release | |
| runs-on: ubuntu-latest | |
| needs: | |
| - build | |
| - integration-test | |
| outputs: | |
| version: ${{ steps.create-github-release.outputs.version }} | |
| steps: | |
| - run: | | |
| if [[ $GITHUB_REF_NAME != release/* ]]; then | |
| echo this workflow should only be run against release branches | |
| exit 1 | |
| fi | |
| - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | |
| - name: Set environment variables | |
| run: | | |
| version=$(.github/scripts/get-version.sh) | |
| if [[ $version =~ ^([0-9]+)\.([0-9]+)\.([0-9]+) ]]; then | |
| major="${BASH_REMATCH[1]}" | |
| minor="${BASH_REMATCH[2]}" | |
| patch="${BASH_REMATCH[3]}" | |
| else | |
| echo "unexpected version: $version" | |
| exit 1 | |
| fi | |
| if [[ $patch == 0 ]]; then | |
| if [[ $minor == 0 ]]; then | |
| prior_major=$((major - 1)) | |
| prior_minor=$(grep -Po "^## Version $prior_major.\K[0-9]+" CHANGELOG.md | head -1) | |
| prior_version="$prior_major.$prior_minor" | |
| else | |
| prior_version="$major.$((minor - 1)).0" | |
| fi | |
| else | |
| prior_version="$major.$minor.$((patch - 1))" | |
| fi | |
| echo "VERSION=$version" >> $GITHUB_ENV | |
| echo "PRIOR_VERSION=$prior_version" >> $GITHUB_ENV | |
| # check out main branch to verify there won't be problems with merging the change log | |
| # at the end of this workflow | |
| - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | |
| with: | |
| ref: main | |
| - name: Check that change log update was merged to main | |
| run: | | |
| if [[ $VERSION == *.0 ]]; then | |
| # not making a patch release | |
| if ! grep --quiet "^## Version $VERSION " CHANGELOG.md; then | |
| echo the pull request generated by prepare-release-branch.yml needs to be merged first | |
| exit 1 | |
| fi | |
| fi | |
| # back to the release branch | |
| - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | |
| with: | |
| # tags are needed for the generate-release-contributors.sh script | |
| fetch-depth: 0 | |
| - name: Set up JDK for running Gradle | |
| uses: actions/setup-java@3a4f6e1af504cf6a31855fa899c6aa5355ba6c12 # v4.7.0 | |
| with: | |
| distribution: temurin | |
| java-version: 17 | |
| - name: Set up gradle | |
| uses: gradle/actions/setup-gradle@94baf225fe0a508e581a564467443d0e2379123b # v4.3.0 | |
| - name: Build and publish artifacts | |
| run: ./gradlew assemble publishToSonatype closeAndReleaseSonatypeStagingRepository | |
| env: | |
| SONATYPE_USER: ${{ secrets.SONATYPE_USER }} | |
| SONATYPE_KEY: ${{ secrets.SONATYPE_KEY }} | |
| GPG_PRIVATE_KEY: ${{ secrets.GPG_PRIVATE_KEY }} | |
| GPG_PASSWORD: ${{ secrets.GPG_PASSWORD }} | |
| - name: Generate release notes | |
| env: | |
| GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| run: | | |
| instrumentation_version=$(grep -Po "val otelInstrumentationVersion = \"\K[0-9]+.[0-9]+.[0-9]+" dependencyManagement/build.gradle.kts) | |
| # conditional blocks not indented because of the heredoc | |
| if [[ $VERSION == *.0 ]]; then | |
| cat > /tmp/release-notes.txt << EOF | |
| This release targets the OpenTelemetry Java Instrumentation [$instrumentation_version](https://github.com/open-telemetry/opentelemetry-java-instrumentation/releases/tag/v$instrumentation_version). | |
| EOF | |
| else | |
| cat > /tmp/release-notes.txt << EOF | |
| This is a patch release on the previous $PRIOR_VERSION release, fixing the issue(s) below. | |
| EOF | |
| fi | |
| # CHANGELOG_SECTION.md is also used at the end of the release workflow | |
| # for copying the change log updates to main | |
| sed -n "0,/^## Version $VERSION /d;/^## Version /q;p" CHANGELOG.md \ | |
| > /tmp/CHANGELOG_SECTION.md | |
| # the complex perl regex is needed because markdown docs render newlines as soft wraps | |
| # while release notes render them as line breaks | |
| perl -0pe 's/(?<!\n)\n *(?!\n)(?![-*] )(?![1-9]+\. )/ /g' /tmp/CHANGELOG_SECTION.md \ | |
| >> /tmp/release-notes.txt | |
| # conditional block not indented because of the heredoc | |
| if [[ $VERSION == *.0 ]]; then | |
| cat >> /tmp/release-notes.txt << EOF | |
| ### 🙇 Thank you | |
| This release was possible thanks to the following contributors who shared their brilliant ideas and awesome pull requests: | |
| EOF | |
| .github/scripts/generate-release-contributors.sh v$PRIOR_VERSION >> /tmp/release-notes.txt | |
| fi | |
| - id: create-github-release | |
| name: Create GitHub release | |
| env: | |
| GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| run: | | |
| cp jmx-metrics/build/libs/opentelemetry-jmx-metrics-$VERSION-alpha.jar opentelemetry-jmx-metrics.jar | |
| cp jmx-metrics/build/libs/opentelemetry-jmx-metrics-$VERSION-alpha.jar.asc opentelemetry-jmx-metrics.jar.asc | |
| gh release create --target $GITHUB_REF_NAME \ | |
| --title "Version $VERSION" \ | |
| --notes-file /tmp/release-notes.txt \ | |
| v$VERSION \ | |
| opentelemetry-jmx-metrics.jar \ | |
| opentelemetry-jmx-metrics.jar.asc | |
| echo "version=$VERSION" >> $GITHUB_OUTPUT | |
| merge-change-log-to-main: | |
| permissions: | |
| contents: write # for git push to PR branch | |
| runs-on: ubuntu-latest | |
| needs: | |
| - release | |
| steps: | |
| - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | |
| - name: Copy change log section from release branch | |
| env: | |
| VERSION: ${{ needs.release.outputs.version }} | |
| run: | | |
| sed -n "0,/^## Version $VERSION /d;/^## Version /q;p" CHANGELOG.md \ | |
| > /tmp/changelog-section.md | |
| - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | |
| with: | |
| ref: main | |
| - name: Merge change log to main | |
| env: | |
| VERSION: ${{ needs.release.outputs.version }} | |
| GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| run: | | |
| release_date=$(gh release view v$VERSION --json publishedAt --jq .publishedAt | sed 's/T.*//') | |
| RELEASE_DATE=$release_date .github/scripts/merge-change-log-after-release.sh | |
| - name: Use CLA approved bot | |
| run: .github/scripts/use-cla-approved-bot.sh | |
| - uses: actions/create-github-app-token@0d564482f06ca65fa9e77e2510873638c82206f2 # v1.11.5 | |
| id: otelbot-token | |
| with: | |
| app-id: ${{ vars.OTELBOT_APP_ID }} | |
| private-key: ${{ secrets.OTELBOT_PRIVATE_KEY }} | |
| - name: Create pull request against main | |
| env: | |
| VERSION: ${{ needs.release.outputs.version }} | |
| # not using secrets.GITHUB_TOKEN since pull requests from that token do not run workflows | |
| GH_TOKEN: ${{ steps.otelbot-token.outputs.token }} | |
| run: | | |
| if git diff --quiet; then | |
| if [[ $VERSION == *.0 ]]; then | |
| echo there are no updates to merge, not creating pull request | |
| exit 0 # success | |
| else | |
| echo patch release notes did not get applied for some reason | |
| exit 1 # failure | |
| fi | |
| fi | |
| message="Merge change log updates from $GITHUB_REF_NAME" | |
| body="Merge log updates from \`$GITHUB_REF_NAME\`." | |
| branch="otelbot/merge-change-log-updates-from-${GITHUB_REF_NAME//\//-}" | |
| git checkout -b $branch | |
| git commit -a -m "$message" | |
| git push --set-upstream origin $branch | |
| gh pr create --title "$message" \ | |
| --body "$body" \ | |
| --base main |