From 8eb78af093aee782716b98f57d85705ba743eb30 Mon Sep 17 00:00:00 2001 From: Andreas Braun Date: Fri, 14 Jun 2024 15:54:28 +0200 Subject: [PATCH 1/4] Add GitHub Actions based release automation (#1400) JAVA-5479 --- .github/workflows/bump-and-tag.sh | 18 ++++++ .github/workflows/release.yml | 98 +++++++++++++++++++++++++++++++ 2 files changed, 116 insertions(+) create mode 100755 .github/workflows/bump-and-tag.sh create mode 100644 .github/workflows/release.yml diff --git a/.github/workflows/bump-and-tag.sh b/.github/workflows/bump-and-tag.sh new file mode 100755 index 00000000000..84b7567427c --- /dev/null +++ b/.github/workflows/bump-and-tag.sh @@ -0,0 +1,18 @@ +#!/usr/bin/env bash +set -e + +# This script assumes that release X.Y.Z will always be created from X.Y.Z-SNAPSHOT" +echo "Replace snapshot version with release version ${RELEASE_VERSION} in build.gradle" +sed --in-place "s/version = '.*-SNAPSHOT'/version = '${RELEASE_VERSION}'/g" build.gradle + +echo "Create package commit for ${RELEASE_VERSION}" +git commit -m "Version: bump ${RELEASE_VERSION}" build.gradle + +echo "Create release tag for ${RELEASE_VERSION}" +git tag -a -m "${RELEASE_VERSION}" r${RELEASE_VERSION} + +echo "Bump to snapshot version for ${NEXT_VERSION}" +sed --in-place "s/version = '${RELEASE_VERSION}'/version = '${NEXT_VERSION}-SNAPSHOT'/g" build.gradle + +echo "Create commit for version bump to ${NEXT_VERSION}" +git commit -m "Version: bump ${NEXT_VERSION}-SNAPSHOT" build.gradle diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 00000000000..cfb5002dc56 --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,98 @@ +name: "Release New Version" +run-name: "Release ${{ inputs.version }}" + +on: + workflow_dispatch: + inputs: + version: + description: "The version to be released (e.g. 1.2.3)" + required: true + type: "string" + +jobs: + prepare-release: + environment: release + name: "Prepare release" + runs-on: ubuntu-latest + permissions: + # Write permission for id-token is necessary to generate a new token for the GitHub App + id-token: write + # Write permission for contents is to ensure we're allowed to push to the repository + contents: write + + steps: + - name: "Create release output" + run: echo '🎬 Release process for version ${{ env.RELEASE_VERSION }} started by @${{ github.triggering_actor }}' >> $GITHUB_STEP_SUMMARY + + - uses: mongodb-labs/drivers-github-tools/secure-checkout@v2 + with: + app-id: ${{ vars.APP_ID }} + private-key: ${{ secrets.APP_PRIVATE_KEY }} + + - name: "Store version numbers in env variables" + # The awk command to increase the version number was copied from + # StackOverflow: https://stackoverflow.com/a/61921674/3959933 + run: | + echo RELEASE_VERSION=${{ inputs.version }} >> $GITHUB_ENV + echo NEXT_VERSION=$(echo ${{ inputs.version }} | awk -F. -v OFS=. '{$NF += 1 ; print}') >> $GITHUB_ENV + echo RELEASE_BRANCH=$(echo ${{ inputs.version }} | awk -F. -v OFS=. '{$NF = "x" ; print}') >> $GITHUB_ENV + + - name: "Ensure release tag does not already exist" + run: | + if [[ $(git tag -l r${RELEASE_VERSION}) == r${RELEASE_VERSION} ]]; then + echo '❌ Release failed: tag for version ${{ inputs.version }} already exists' >> $GITHUB_STEP_SUMMARY + exit 1 + fi + + # For patch releases (A.B.C where C != 0), we expect the release to be + # triggered from the A.B.x maintenance branch + - name: "Fail if patch release is created from wrong release branch" + if: ${{ !endsWith(inputs.version, '.0') && env.RELEASE_BRANCH != github.ref_name }} + run: | + echo '❌ Release failed due to branch mismatch: expected ${{ inputs.version }} to be released from ${{ env.RELEASE_BRANCH }}, got ${{ github.ref_name }}' >> $GITHUB_STEP_SUMMARY + exit 1 + + # For non-patch releases (A.B.C where C == 0), we expect the release to + # be triggered from master or the A.B.x maintenance branch + - name: "Fail if non-patch release is created from wrong release branch" + if: ${{ endsWith(inputs.version, '.0') && env.RELEASE_BRANCH != github.ref_name && github.ref_name != 'master' }} + run: | + echo '❌ Release failed due to branch mismatch: expected ${{ inputs.version }} to be released from ${{ env.RELEASE_BRANCH }} or master, got ${{ github.ref_name }}' >> $GITHUB_STEP_SUMMARY + exit 1 + + # If a non-patch release is created from a branch other than its + # maintenance branch, create that branch from the current one and push it + - name: "Create new release branch for non-patch release" + if: ${{ endsWith(inputs.version, '.0') && env.RELEASE_BRANCH != github.ref_name }} + run: | + echo '🆕 Creating new release branch ${RELEASE_BRANCH} from ${{ github.ref_name }}' >> $GITHUB_STEP_SUMMARY + git checkout -b ${RELEASE_BRANCH} + + - name: "Set git author information" + run: | + git config user.name "${GIT_AUTHOR_NAME}" + git config user.email "${GIT_AUTHOR_EMAIL}" + + # This step bumps version numbers in build.gradle and creates git artifacts for the release + - name: "Bump version numbers and create release tag" + run: .github/workflows/bump-and-tag.sh + + - name: "Push release branch and tag" + run: | + git push origin ${RELEASE_BRANCH} + git push origin r${{ env.RELEASE_VERSION }} + + - name: "Create draft release with generated changelog" + run: | + echo "RELEASE_URL=$(\ + gh release create r${RELEASE_VERSION} \ + --target ${{ env.RELEASE_BRANCH }} \ + --title "Java Driver ${{ env.RELEASE_VERSION }} ($(date '+%B %d, %Y'))" \ + --generate-notes \ + --draft\ + )" >> "$GITHUB_ENV" + + - name: "Set summary" + run: | + echo '🚀 Created tag and drafted release for version [${{ env.RELEASE_VERSION }}](${{ env.RELEASE_URL }})' >> $GITHUB_STEP_SUMMARY + echo '✍️ You may now update the release notes and publish the release when ready' >> $GITHUB_STEP_SUMMARY From 8fcc50b63c68ae9d166c34d8ed68ad3992320fab Mon Sep 17 00:00:00 2001 From: Andreas Braun Date: Fri, 14 Jun 2024 16:58:57 +0200 Subject: [PATCH 2/4] Fix release workflow (#1422) * Fix input names * Set git author information JAVA-5479 --- .github/workflows/release.yml | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index cfb5002dc56..0832b079955 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -9,6 +9,10 @@ on: required: true type: "string" +env: + GIT_AUTHOR_EMAIL: "167856002+mongodb-dbx-release-bot[bot]@users.noreply.github.com" + GIT_AUTHOR_NAME: "mongodb-dbx-release-bot[bot]" + jobs: prepare-release: environment: release @@ -26,8 +30,8 @@ jobs: - uses: mongodb-labs/drivers-github-tools/secure-checkout@v2 with: - app-id: ${{ vars.APP_ID }} - private-key: ${{ secrets.APP_PRIVATE_KEY }} + app_id: ${{ vars.APP_ID }} + private_key: ${{ secrets.APP_PRIVATE_KEY }} - name: "Store version numbers in env variables" # The awk command to increase the version number was copied from From 527262d0107578468cf4686bb0fd8fdcce645342 Mon Sep 17 00:00:00 2001 From: Andreas Braun Date: Tue, 9 Jul 2024 22:17:36 +0200 Subject: [PATCH 3/4] Attribute release commit and tag to user triggering the workflow (#1437) --- .github/workflows/release.yml | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 0832b079955..3136189bc27 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -9,10 +9,6 @@ on: required: true type: "string" -env: - GIT_AUTHOR_EMAIL: "167856002+mongodb-dbx-release-bot[bot]@users.noreply.github.com" - GIT_AUTHOR_NAME: "mongodb-dbx-release-bot[bot]" - jobs: prepare-release: environment: release @@ -72,10 +68,13 @@ jobs: echo '🆕 Creating new release branch ${RELEASE_BRANCH} from ${{ github.ref_name }}' >> $GITHUB_STEP_SUMMARY git checkout -b ${RELEASE_BRANCH} + # Set commit author information to the user that triggered the release workflow - name: "Set git author information" run: | - git config user.name "${GIT_AUTHOR_NAME}" - git config user.email "${GIT_AUTHOR_EMAIL}" + GITHUB_USER_NAME=$(gh api users/${{ github.actor }} --jq '.name') + GITHUB_USER_ID=$(gh api users/${{ github.actor }} --jq '.id') + git config user.name "${GITHUB_USER_NAME}}" + git config user.email "${GITHUB_USER_ID}+${{ github.actor }}@users.noreply.github.com" # This step bumps version numbers in build.gradle and creates git artifacts for the release - name: "Bump version numbers and create release tag" From 79aecfd2da742852646f68b17a27f4f6daeee629 Mon Sep 17 00:00:00 2001 From: Andreas Braun Date: Tue, 9 Jul 2024 22:46:07 +0200 Subject: [PATCH 4/4] Support pre-releases in release tooling (#1425) --- .github/workflows/bump-and-tag.sh | 22 +++++---- .github/workflows/bump-version.sh | 13 ++++++ .github/workflows/release.yml | 74 +++++++++++++++++++++++-------- 3 files changed, 82 insertions(+), 27 deletions(-) create mode 100755 .github/workflows/bump-version.sh diff --git a/.github/workflows/bump-and-tag.sh b/.github/workflows/bump-and-tag.sh index 84b7567427c..9e735586e91 100755 --- a/.github/workflows/bump-and-tag.sh +++ b/.github/workflows/bump-and-tag.sh @@ -1,18 +1,22 @@ #!/usr/bin/env bash set -e -# This script assumes that release X.Y.Z will always be created from X.Y.Z-SNAPSHOT" -echo "Replace snapshot version with release version ${RELEASE_VERSION} in build.gradle" -sed --in-place "s/version = '.*-SNAPSHOT'/version = '${RELEASE_VERSION}'/g" build.gradle +if [ "$#" -ne 3 ]; then + echo "Usage: $0 " >&2 + exit 1 +fi -echo "Create package commit for ${RELEASE_VERSION}" -git commit -m "Version: bump ${RELEASE_VERSION}" build.gradle +CURRENT_VERSION=$1 +RELEASE_VERSION=$2 +NEXT_VERSION=$3 + +SCRIPT_DIR=$(dirname ${BASH_SOURCE[0]}) + +echo "Bump version in build.gradle to ${RELEASE_VERSION}" +${SCRIPT_DIR}/bump-version.sh "${RELEASE_VERSION_WITHOUT_SUFFIX}-SNAPSHOT" "${RELEASE_VERSION}" echo "Create release tag for ${RELEASE_VERSION}" git tag -a -m "${RELEASE_VERSION}" r${RELEASE_VERSION} echo "Bump to snapshot version for ${NEXT_VERSION}" -sed --in-place "s/version = '${RELEASE_VERSION}'/version = '${NEXT_VERSION}-SNAPSHOT'/g" build.gradle - -echo "Create commit for version bump to ${NEXT_VERSION}" -git commit -m "Version: bump ${NEXT_VERSION}-SNAPSHOT" build.gradle +${SCRIPT_DIR}/bump-version.sh "${RELEASE_VERSION}" "${NEXT_VERSION}-SNAPSHOT" diff --git a/.github/workflows/bump-version.sh b/.github/workflows/bump-version.sh new file mode 100755 index 00000000000..5f39df82d79 --- /dev/null +++ b/.github/workflows/bump-version.sh @@ -0,0 +1,13 @@ +#!/usr/bin/env bash +set -e + +if [ "$#" -ne 2 ]; then + echo "Usage: $0 " >&2 + exit 1 +fi + +FROM_VERSION=$1 +TO_VERSION=$2 + +sed --in-place "s/version = '${FROM_VERSION}'/version = '${TO_VERSION}'/g" build.gradle +git commit -m "Version: bump ${TO_VERSION}" build.gradle diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 3136189bc27..4724227e0ff 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -32,63 +32,101 @@ jobs: - name: "Store version numbers in env variables" # The awk command to increase the version number was copied from # StackOverflow: https://stackoverflow.com/a/61921674/3959933 + # Variables set here: + # RELEASE_VERSION: The version the deployment is expected to create + # RELEASE_VERSION_WITHOUT_SUFFIX: The version without any stability + # suffixes. Example: 5.2.0-beta0 => 5.2.0 + # NEXT_VERSION: The next version to be released. For pre-releases, the + # next version is a snapshot of the pre-release version. Examples: + # 5.2.0 => 5.2.1; 5.2.0-beta0 => 5.2.0 + # RELEASE_BRANCH: The name of the stable branch for this release series + # Example: 5.2.0 => 5.2.x + # Example: 5.2.0-beta1 => run: | echo RELEASE_VERSION=${{ inputs.version }} >> $GITHUB_ENV - echo NEXT_VERSION=$(echo ${{ inputs.version }} | awk -F. -v OFS=. '{$NF += 1 ; print}') >> $GITHUB_ENV - echo RELEASE_BRANCH=$(echo ${{ inputs.version }} | awk -F. -v OFS=. '{$NF = "x" ; print}') >> $GITHUB_ENV + echo RELEASE_VERSION_WITHOUT_SUFFIX=$(echo ${{ inputs.version }} | awk -F- '{print $1}') >> $GITHUB_ENV + if [[ "${{ inputs.version }}" =~ (alpha|beta|rc)[0-9]+$ ]]; then + echo NEXT_VERSION=$(echo ${{ inputs.version }} | awk -F- '{print $1}') >> $GITHUB_ENV + echo RELEASE_BRANCH=${{ github.ref_name }} >> $GITHUB_ENV + else + echo NEXT_VERSION=$(echo ${{ inputs.version }} | awk -F. -v OFS=. '{$NF += 1 ; print}') >> $GITHUB_ENV + echo RELEASE_BRANCH=$(echo ${{ inputs.version }} | awk -F. -v OFS=. '{$NF = "x" ; print}') >> $GITHUB_ENV + fi + + - name: "Ensure current snapshot version matches release version" + run: | + grep -q "version = '${{ env.RELEASE_VERSION_WITHOUT_SUFFIX }}-SNAPSHOT'" build.gradle + if [[ $? != 0 ]]; then + echo '❌ Release failed: version in build.gradle is not a snapshot for release version ${{ inputs.version }}' >> $GITHUB_STEP_SUMMARY + exit 1 + fi - name: "Ensure release tag does not already exist" run: | - if [[ $(git tag -l r${RELEASE_VERSION}) == r${RELEASE_VERSION} ]]; then + if [[ $(git tag -l r${{ env.RELEASE_VERSION }}) == r${{ env.RELEASE_VERSION }} ]]; then echo '❌ Release failed: tag for version ${{ inputs.version }} already exists' >> $GITHUB_STEP_SUMMARY exit 1 fi # For patch releases (A.B.C where C != 0), we expect the release to be - # triggered from the A.B.x maintenance branch + # triggered from the A.B.x maintenance branch. We use the release version + # without suffixes to avoid mistakes when making pre-releases - name: "Fail if patch release is created from wrong release branch" - if: ${{ !endsWith(inputs.version, '.0') && env.RELEASE_BRANCH != github.ref_name }} + if: ${{ !endsWith(env.RELEASE_VERSION_WITHOUT_SUFFIX, '.0') && env.RELEASE_BRANCH != github.ref_name }} run: | echo '❌ Release failed due to branch mismatch: expected ${{ inputs.version }} to be released from ${{ env.RELEASE_BRANCH }}, got ${{ github.ref_name }}' >> $GITHUB_STEP_SUMMARY exit 1 # For non-patch releases (A.B.C where C == 0), we expect the release to - # be triggered from master or the A.B.x maintenance branch + # be triggered from master or the A.B.x maintenance branch. This includes + # pre-releases for any non-patch releases, e.g. 5.2.0-beta1 - name: "Fail if non-patch release is created from wrong release branch" - if: ${{ endsWith(inputs.version, '.0') && env.RELEASE_BRANCH != github.ref_name && github.ref_name != 'master' }} + if: ${{ endsWith(env.RELEASE_VERSION_WITHOUT_SUFFIX, '.0') && env.RELEASE_BRANCH != github.ref_name && github.ref_name != 'master' }} run: | echo '❌ Release failed due to branch mismatch: expected ${{ inputs.version }} to be released from ${{ env.RELEASE_BRANCH }} or master, got ${{ github.ref_name }}' >> $GITHUB_STEP_SUMMARY exit 1 - # If a non-patch release is created from a branch other than its - # maintenance branch, create that branch from the current one and push it - - name: "Create new release branch for non-patch release" - if: ${{ endsWith(inputs.version, '.0') && env.RELEASE_BRANCH != github.ref_name }} - run: | - echo '🆕 Creating new release branch ${RELEASE_BRANCH} from ${{ github.ref_name }}' >> $GITHUB_STEP_SUMMARY - git checkout -b ${RELEASE_BRANCH} - # Set commit author information to the user that triggered the release workflow - name: "Set git author information" run: | GITHUB_USER_NAME=$(gh api users/${{ github.actor }} --jq '.name') GITHUB_USER_ID=$(gh api users/${{ github.actor }} --jq '.id') - git config user.name "${GITHUB_USER_NAME}}" + git config user.name "${GITHUB_USER_NAME}" git config user.email "${GITHUB_USER_ID}+${{ github.actor }}@users.noreply.github.com" + # If a non-patch release is created from a branch other than its + # maintenance branch, create that branch from the current one and push it + # Pre-releases don't have this behaviour, so we can check the full release + # version including stability suffixes to exclude those + - name: "Create new release branch for non-patch release" + if: ${{ endsWith(env.RELEASE_VERSION, '.0') && env.RELEASE_BRANCH != github.ref_name }} + run: | + echo '🆕 Creating new release branch ${{ env.RELEASE_BRANCH }} from ${{ github.ref_name }}' >> $GITHUB_STEP_SUMMARY + git checkout -b ${{ env.RELEASE_BRANCH }} + NEXT_MINOR_VERSION=$(echo "${{ env.RELEASE_VERSION }}" | awk -F. -v OFS=. '{$2 += 1 ; $NF = 0 ; print}') + echo "➡️ Bumping version for ${{ github.ref_name }} branch to ${NEXT_MINOR_VERSION}" >> $GITHUB_STEP_SUMMARY + git checkout ${{ github.ref_name }} + .github/workflows/bump-version.sh "${{ env.RELEASE_VERSION_WITHOUT_SUFFIX }}-SNAPSHOT" "${NEXT_MINOR_VERSION}-SNAPSHOT" + git push origin ${{ github.ref_name }} + git checkout ${{ env.RELEASE_BRANCH }} + # This step bumps version numbers in build.gradle and creates git artifacts for the release - name: "Bump version numbers and create release tag" - run: .github/workflows/bump-and-tag.sh + run: .github/workflows/bump-and-tag.sh "${{ env.RELEASE_VERSION_WITHOUT_SUFFIX }}" "${{ env.RELEASE_VERSION }}" "${{ env.NEXT_VERSION }}" - name: "Push release branch and tag" run: | - git push origin ${RELEASE_BRANCH} + git push origin ${{ env.RELEASE_BRANCH }} git push origin r${{ env.RELEASE_VERSION }} - name: "Create draft release with generated changelog" run: | + if [[ "${{ inputs.version }}" =~ (alpha|beta|rc) ]]; then + PRERELEASE="--prerelease --latest=false" + fi echo "RELEASE_URL=$(\ gh release create r${RELEASE_VERSION} \ + ${PRERELEASE} \ --target ${{ env.RELEASE_BRANCH }} \ --title "Java Driver ${{ env.RELEASE_VERSION }} ($(date '+%B %d, %Y'))" \ --generate-notes \