Skip to content

Perform Release

Perform Release #52

name: "Perform Release"
on:
pull_request_review:
types: [submitted]
workflow_dispatch:
inputs:
release_pr_number:
description: "The PR number of the release PR"
required: true
env:
MVN_CLI_ARGS: "--batch-mode --no-transfer-progress --fail-at-end --show-version"
DOCS_REPO: SAP/cloud-sdk
jobs:
prerequisites:
name: "Prerequisites"
if: ${{ github.event_name == 'workflow_dispatch' || (github.event_name == 'pull_request_review' && github.event.review.state == 'approved' && startsWith(github.event.pull_request.head.ref, 'RELEASE-')) }}
outputs:
release-version: ${{ steps.determine-branch-names.outputs.RELEASE_VERSION }}
release-tag: ${{ steps.determine-branch-names.outputs.RELEASE_TAG }}
code-branch: ${{ steps.determine-branch-names.outputs.CODE_BRANCH_NAME }}
docs-branch: ${{ steps.determine-branch-names.outputs.DOCS_BRANCH_NAME }}
release-notes-branch: ${{ steps.determine-branch-names.outputs.RELEASE_NOTES_BRANCH_NAME }}
permissions:
pull-requests: read
runs-on: ubuntu-latest
steps:
- name: "Determine Branch Names"
id: determine-branch-names
run: |
if [[ "${{ github.event_name }}" == "pull_request_review" ]]; then
echo "[DEBUG] Taking branch name from pull request event"
BRANCH_NAME=${{ github.event.pull_request.head.ref }}
elif [[ "${{ github.event_name }}" == "workflow_dispatch" ]]; then
echo "[DEBUG] Taking branch name from workflow dispatch event"
BRANCH_NAME=$(gh pr view ${{ github.event.inputs.release_pr_number }} --repo "${{ github.repository }}" --json headRefName | jq -r '.headRefName')
else
echo "Cannot determine branch name from event '${{ github.event_name }}'"
exit 1
fi
RELEASE_VERSION=$(echo "$BRANCH_NAME" | cut -d '-' -f2)
DOCS_BRANCH=java/release-docs-$RELEASE_VERSION
RELEASE_NOTES_BRANCH=java/release-notes-$RELEASE_VERSION
echo "RELEASE_VERSION=$RELEASE_VERSION" >> $GITHUB_OUTPUT
echo "RELEASE_TAG=rel/$RELEASE_VERSION" >> $GITHUB_OUTPUT
echo "CODE_BRANCH_NAME=$BRANCH_NAME" >> $GITHUB_OUTPUT
echo "DOCS_BRANCH_NAME=$DOCS_BRANCH" >> $GITHUB_OUTPUT
echo "RELEASE_NOTES_BRANCH_NAME=$RELEASE_NOTES_BRANCH" >> $GITHUB_OUTPUT
env:
GH_TOKEN: ${{ github.token }}
- name: "Checkout Repository"
uses: actions/checkout@v4
with:
ref: ${{ steps.determine-branch-names.outputs.CODE_BRANCH_NAME }}
- name: "Check Whether Code PR Can Be Merged"
uses: ./.github/actions/pr-is-mergeable
with:
pr-ref: ${{ steps.determine-branch-names.outputs.CODE_BRANCH_NAME }}
- name: "Check Whether Docs PR Can Be Merged"
uses: ./.github/actions/pr-is-mergeable
with:
pr-ref: ${{ steps.determine-branch-names.outputs.DOCS_BRANCH_NAME }}
repo: ${{ env.DOCS_REPO }}
token: ${{ secrets.BOT_SDK_JS_FOR_DOCS_REPO_PR }}
- name: "Check Whether Release Notes PR Can Be Merged"
uses: ./.github/actions/pr-is-mergeable
with:
pr-ref: ${{ steps.determine-branch-names.outputs.RELEASE_NOTES_BRANCH_NAME }}
repo: ${{ env.DOCS_REPO }}
token: ${{ secrets.BOT_SDK_JS_FOR_DOCS_REPO_PR }}
release:
name: "Release"
needs: [ prerequisites ]
runs-on: ubuntu-latest
permissions:
contents: write # needed to modify the release draft
pull-requests: write # needed to merge the release PR
steps:
- name: "Setup java"
uses: actions/setup-java@v3
with:
distribution: "temurin"
java-version: "17"
server-id: ossrh
server-username: MAVEN_CENTRAL_USER # env variable for username in deploy
server-password: MAVEN_CENTRAL_PASSWORD # env variable for token in deploy
- name: "Download Release Asset"
id: download-asset
run: |
gh release download ${{ needs.prerequisites.outputs.release-tag }} --dir ./ --repo "${{ github.repository }}"
# x=extract v=verbose z=decompress f=file C=destination directory
tar -xvzf apidocs-*.tar.gz -C .
tar -xvzf release-*.tar.gz -C .
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: "Import GPG Key"
run: |
echo "${{ secrets.PGP_PRIVATE_KEY }}" | gpg --batch --passphrase "$PASSPHRASE" --import
env:
PASSPHRASE: ${{ secrets.GPG_PASSPHRASE }}
- name: "Perform Release"
run: >
mvn
$MVN_CLI_ARGS
-DrepositoryId=local
-Durl=file:./temp_local_repo
-Dmaven.install.skip=true
-Dgpg.passphrase="$GPG_PASSPHRASE"
-Dgpg.keyname="$MAVEN_CENTRAL_USER"
deploy
mvn
$MVN_CLI_ARGS
org.sonatype.plugins:nexus-staging-maven-plugin:1.6.13:deploy-staged-repository
-DserverId=ossrh
-DnexusUrl=https://oss.sonatype.org
-DrepositoryDirectory=./temp_local_repo
-DstagingProfileId=$MAVEN_CENTRAL_PROFILE_ID
env:
MAVEN_CENTRAL_USER: ${{ secrets.MAVEN_CENTRAL_USER }}
MAVEN_CENTRAL_PASSWORD: ${{ secrets.MAVEN_CENTRAL_PASSWORD }}
MAVEN_CENTRAL_PROFILE_ID: ${{ secrets.MAVEN_CENTRAL_PROFILE_ID }}
GPG_PASSPHRASE: ${{ secrets.GPG_PASSPHRASE }}
- name: "Merge Code PR"
run: gh pr merge --squash "${{ needs.prerequisites.outputs.code-branch }}" --delete-branch --repo "${{ github.repository }}"
env:
GH_TOKEN: ${{ github.token }}
- name: "Publish the Draft Release"
run: gh release edit ${{ needs.prerequisites.outputs.release-tag }} --draft=false --repo "${{ github.repository }}"
env:
GH_TOKEN: ${{ github.token }}
- name: "Merge Docs PR"
run: gh pr merge --squash "${{ needs.prerequisites.outputs.docs-branch }}" --delete-branch --repo "${{ env.DOCS_REPO }}"
env:
GH_TOKEN: ${{ secrets.BOT_SDK_JS_FOR_DOCS_REPO_PR }}
- name: "Merge Release Notes PR"
run: |
# https://github.com/cli/cli/issues/8092#issuecomment-1814439651
# The Release Notes mergeability computation hasn't completed yet
# Because the base branch just changed from merging the Javadoc.
# Sleep and retry to work around "Base branch was modified." error.
for i in {1..3}; do
sleep 5
if gh pr merge --squash "${{ needs.prerequisites.outputs.release-notes-branch }}" --delete-branch --repo "${{ env.DOCS_REPO }}"; then
exit 0
fi
done
exit 1
env:
GH_TOKEN: ${{ secrets.BOT_SDK_JS_FOR_DOCS_REPO_PR }}
notify-job:
runs-on: ubuntu-latest
needs: [ prerequisites, release ]
if: ${{ failure() }}
steps:
- name: "Checkout"
uses: actions/checkout@v4
- name: "Notify"
run: python .pipeline/scripts/notify.py
env:
SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}
WORKFLOW: ${{ github.workflow }}
WORKFLOW_RUN_URL: https://github.com/SAP/cloud-sdk-java/actions/runs/${{ github.run_id }}
BRANCH_NAME: ${{ needs.prerequisites.outputs.code-branch }}