Zowe Release v2 #74
This file contains 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: Zowe Release v2 | |
| on: | |
| workflow_dispatch: | |
| inputs: | |
| zowe-artifact-dir: | |
| description: 'ZOWE_ARTIFACT_DIR' | |
| default: '2.@@.@-RC|SNAPSHOT' | |
| required: true | |
| zowe-build-name: | |
| description: 'ZOWE_BUILD_NAME' | |
| default: 'zowe-install-packaging/v2.x/rc|master' | |
| required: true | |
| zowe-build-number: | |
| description: 'ZOWE_BUILD_NUMBER' | |
| required: true | |
| default: '@@@@' | |
| zowe-release-version: | |
| description: 'ZOWE_RELEASE_VERSION' | |
| default: '2.@@.@|-RC@' | |
| required: true | |
| force-sign: | |
| type: boolean | |
| description: 'Force sign' | |
| required: false | |
| default: false | |
| force-tag: | |
| type: boolean | |
| description: 'Force tag' | |
| required: false | |
| default: false | |
| env: | |
| ZOWE_INSTALL_PACKAGING_OWNER: zowe | |
| ZOWE_INSTALL_PACKAGING_REPO: zowe-install-packaging | |
| STAGING_BRANCH: v2.x/staging | |
| CORRECT_NUM_OF_RELEASE_ARTIFACTS: 9 | |
| CORRECT_NUM_OF_SIGNED_ARTIFACTS: 20 | |
| LOCAL_RELEASE_FOLDER: .release | |
| TAG_DIR: .tag | |
| ORIGINAL_STAGING_DIR: .original-zowe-install-packaging-staging | |
| PROMOTE_PTF_DIR: .promote-ptf | |
| jobs: | |
| check-permission: | |
| runs-on: ubuntu-latest | |
| steps: | |
| # this action will fail the whole workflow if permission check fails | |
| - name: check permission | |
| id: permission-check | |
| uses: zowe-actions/shared-actions/permission-check@main | |
| with: | |
| github-token: ${{ secrets.GITHUB_TOKEN }} | |
| - name: parse permission returned | |
| run: | | |
| if [[ "${{ steps.permission-check.outputs.user-permission }}" != "admin" ]]; then | |
| echo "I am not seeing an admin running this workflow. For security, I am going to stop this workflow here..." | |
| exit 1 | |
| fi | |
| input-check: | |
| runs-on: ubuntu-latest | |
| needs: check-permission | |
| steps: | |
| - name: Check input zowe-artifact-dir | |
| if: ${{ !startsWith(github.event.inputs.zowe-artifact-dir, '2') }} | |
| uses: actions/github-script@v6 | |
| with: | |
| script: | | |
| core.setFailed('Input zowe-artifact-dir is not corresponding to Zowe version 2') | |
| - name: Check input zowe-build-name | |
| if: ${{ !contains(github.event.inputs.zowe-build-name, 'zowe-install-packaging/v2.x') }} | |
| uses: actions/github-script@v6 | |
| with: | |
| script: | | |
| core.setFailed('Input zowe-build-name is not corresponding to Zowe version 2') | |
| - name: Check input zowe-release-version | |
| if: ${{ !startsWith(github.event.inputs.zowe-release-version, '2') }} | |
| uses: actions/github-script@v6 | |
| with: | |
| script: | | |
| core.setFailed('Input zowe-release-version is not corresponding to Zowe version 2') | |
| promote-and-release: | |
| runs-on: ubuntu-latest | |
| needs: input-check | |
| steps: | |
| - name: '[Prep 1] Checkout' | |
| uses: actions/checkout@v2 | |
| - name: '[Prep 2] Setup jFrog CLI' | |
| uses: jfrog/setup-jfrog-cli@v2 | |
| env: | |
| JF_ENV_1: ${{ secrets.JF_ARTIFACTORY_TOKEN }} | |
| - name: '[Prep 3] Replace JFROG_CLI_BUILD_NAME' | |
| run: echo JFROG_CLI_BUILD_NAME=${{ github.event.repository.name }}/${GITHUB_REF_NAME} >> $GITHUB_ENV | |
| - name: '[Prep 4] process zowe-release-v2.json' | |
| run: | | |
| sed -e "s#{ZOWE_ARTIFACT_DIR}#${{ github.event.inputs.zowe-artifact-dir }}#g" \ | |
| zowe-release-v2-template.json > zowe-release-v2.json | |
| echo "Current zowe-release-v2.json is:" | |
| cat zowe-release-v2.json | |
| echo ZOWE_RELEASE_JSON=zowe-release-v2.json >> $GITHUB_ENV | |
| - name: '[Prep 5] Create various folders for later steps to use' | |
| run: | | |
| # create folders under root project dir | |
| mkdir ${{ env.LOCAL_RELEASE_FOLDER }} | |
| mkdir ${{ env.TAG_DIR }} | |
| mkdir ${{ env.ORIGINAL_STAGING_DIR }} | |
| mkdir ${{ env.PROMOTE_PTF_DIR }} | |
| - name: '[Validate 1] Validate v2 zowe artifacts' | |
| id: validate | |
| uses: ./validate | |
| with: | |
| build-name: ${{ github.event.inputs.zowe-build-name }} | |
| build-num: ${{ github.event.inputs.zowe-build-number }} | |
| release-version: ${{ github.event.inputs.zowe-release-version }} | |
| validate-docker-amd64: false | |
| validate-docker-amd64-sources: false | |
| validate-docker-s390x: false | |
| validate-docker-s390x-sources: false | |
| # Above step 'Validate' will generate a file (name is stored in its outputs.PROMOTE_JSON_FILE_NAME_FULL) | |
| # file name is: promote-artifacts.json | |
| # this can be used in many later step: promote, sign | |
| - name: '[Validate 2] Print promote-artifacts.json' | |
| run: cat ${{ steps.validate.outputs.PROMOTE_JSON_FILE_NAME_FULL }} | |
| - name: '[Source - formal release only!] Generate source build' | |
| timeout-minutes: 10 | |
| if: env.IS_FORMAL_RELEASE == 'true' | |
| run: | | |
| export GITHUB_USERNAME=${{ secrets.ZOWE_ROBOT_USER }} | |
| export GITHUB_PASSWORD=${{ secrets.ZOWE_ROBOT_TOKEN }} | |
| ./.dependency/prepare_source_zip.sh | |
| zip -r ${{ env.LOCAL_RELEASE_FOLDER }}/zowe_sources-${{ github.event.inputs.zowe-release-version }}.zip ${{ env.LOCAL_RELEASE_FOLDER }}/source_zip | |
| - name: '[Promote 1] Promote (jfrog rt copy)' | |
| timeout-minutes: 10 | |
| id: promote | |
| uses: ./promote | |
| with: | |
| promote-json-file-name-full: ${{ steps.validate.outputs.PROMOTE_JSON_FILE_NAME_FULL }} | |
| release-version: ${{ github.event.inputs.zowe-release-version }} | |
| env: | |
| DEBUG: 'zowe-release:promote' | |
| # promote step above will also create a release artifacts download spec file for next download step to consume | |
| # file name is stored in its outputs.RELEASE_ARTIFACTS_DOWNLOAD_SPEC_FILE | |
| # file name will be: release-artifacts-download-spec.json | |
| - name: '[Promote 2] Print release-artifacts-download-spec.json' | |
| run: cat ${{ steps.promote.outputs.RELEASE_ARTIFACTS_DOWNLOAD_SPEC_FILE }} | |
| - name: '[Sign 1 - formal release or force sign only!] Download released artifacts' | |
| timeout-minutes: 20 | |
| if: ${{ env.IS_FORMAL_RELEASE == 'true' || github.event.inputs.force-sign == 'true' }} | |
| run: | | |
| GREEN='\033[0;32m' | |
| RED='\033[0;31m' | |
| NC='\033[0m' | |
| success_count=$(jfrog rt download --threads 10 --spec ${{ steps.promote.outputs.RELEASE_ARTIFACTS_DOWNLOAD_SPEC_FILE }} | jq -r ".totals.success") | |
| if [[ -z "$success_count" ]] || [[ "$success_count" != ${{ env.CORRECT_NUM_OF_RELEASE_ARTIFACTS }} ]]; then | |
| echo -e "${RED}\nmissing some release artifacts, I have only found $success_count. Should be ${{ env.CORRECT_NUM_OF_RELEASE_ARTIFACTS }}." | |
| exit 1 | |
| else | |
| echo | |
| echo -e "${GREEN}I have downloaded $success_count artifacts, looks okay, may proceed.${NC}\n" | |
| fi | |
| - name: '[Sign 2 - formal release or force sign only!] Sign prep' | |
| if: ${{ env.IS_FORMAL_RELEASE == 'true' || github.event.inputs.force-sign == 'true' }} | |
| id: sign-prep | |
| run: | | |
| private_keyfile_path="${{ runner.temp }}/private.key" | |
| echo "${{ secrets.GPG_PRIVATE_KEY }}" > $private_keyfile_path | |
| echo PRIVATE_KEYFILE_PATH=$private_keyfile_path >> $GITHUB_OUTPUT | |
| - name: '[Sign 3 - formal release or force sign only!] Actual sign work' | |
| if: ${{ env.IS_FORMAL_RELEASE == 'true' || github.event.inputs.force-sign == 'true' }} | |
| id: sign | |
| timeout-minutes: 20 | |
| uses: ./sign | |
| with: | |
| promote-json-file-name-full: ${{ steps.validate.outputs.PROMOTE_JSON_FILE_NAME_FULL }} | |
| release-version: ${{ github.event.inputs.zowe-release-version }} | |
| key-id: ${{ secrets.GPG_KEY_ID }} | |
| private-key-path: ${{ steps.sign-prep.outputs.PRIVATE_KEYFILE_PATH }} | |
| private-key-passphrase: ${{ secrets.GPG_KEY_PASSPHRASE }} | |
| # sign step will produce a file sign-and-upload-artifacts.json which will be used next to upload, | |
| # file name is stored in output SIGN_JSON_FILE_NAME_FULL | |
| - name: '[Sign 4 - formal release or force sign only!] Print sign-and-upload-artifacts.json' | |
| if: ${{ env.IS_FORMAL_RELEASE == 'true' || github.event.inputs.force-sign == 'true' }} | |
| run: cat ${{ steps.sign.outputs.SIGN_JSON_FILE_NAME_FULL }} | |
| - name: '[Sign 5 - formal release or force sign only!] Upload sign and hash files' | |
| if: ${{ env.IS_FORMAL_RELEASE == 'true' || github.event.inputs.force-sign == 'true' }} | |
| timeout-minutes: 20 | |
| run: | | |
| GREEN='\033[0;32m' | |
| RED='\033[0;31m' | |
| NC='\033[0m' | |
| expected_artifacts_count=${{ env.CORRECT_NUM_OF_SIGNED_ARTIFACTS }} | |
| if [[ -z "${{ env.IS_FORMAL_RELEASE }}" ]]; then | |
| ((expected_artifacts_count--)) | |
| fi | |
| success_count=$(jfrog rt upload --threads 10 --spec ${{ steps.sign.outputs.SIGN_JSON_FILE_NAME_FULL }} | jq -r ".totals.success") | |
| if [[ -z "$success_count" ]] || [[ "$success_count" != "$expected_artifacts_count" ]]; then | |
| echo -e "${RED}\nmissing some signed upload artifacts, I have only uploaded $success_count. Should be $expected_artifacts_count." | |
| exit 1 | |
| else | |
| echo | |
| echo -e "${GREEN}I have uploaded $success_count artifacts, looks okay, may proceed.${NC}\n" | |
| fi | |
| - name: '[Tag 1 - formal release or force tag only!] Get zowe revision' | |
| if: ${{ env.IS_FORMAL_RELEASE == 'true' || github.event.inputs.force-tag == 'true' }} | |
| id: tag-prep | |
| run: | | |
| zowe_revision=$(cat ${{ steps.validate.outputs.PROMOTE_JSON_FILE_NAME_FULL }} | jq -r '.zowe.revision') | |
| if [[ -z "$zowe_revision" ]] || [[ "$zowe_revision" == "null" ]]; then | |
| RED='\033[0;31m' | |
| echo -e "${RED}\n missing zowe revision - it is not parsed properly, please check step: [Validate] Print promote-artifacts.json to find out what went wrong" | |
| exit 1 | |
| fi | |
| echo ZOWE_REVISION=$zowe_revision >> $GITHUB_OUTPUT | |
| - name: '[Tag 2 - formal release or force tag only!] Clone master branch to prepare for tagging' | |
| if: ${{ env.IS_FORMAL_RELEASE == 'true' || github.event.inputs.force-tag == 'true' }} | |
| uses: actions/checkout@v2 | |
| with: | |
| repository: ${{ env.ZOWE_INSTALL_PACKAGING_OWNER }}/${{ env.ZOWE_INSTALL_PACKAGING_REPO }} | |
| ref: ${{ steps.tag-prep.outputs.ZOWE_REVISION }} | |
| token: ${{ secrets.ZOWE_ROBOT_TOKEN }} | |
| path: ${{ env.TAG_DIR }} | |
| - name: '[Tag 3 - formal release or force tag only!] Actual tag branch work' | |
| if: ${{ env.IS_FORMAL_RELEASE == 'true' || github.event.inputs.force-tag == 'true' }} | |
| timeout-minutes: 10 | |
| run: | | |
| GREEN='\033[0;32m' | |
| RED='\033[0;31m' | |
| NC='\033[0m' | |
| zowe_release_version=${{ github.event.inputs.zowe-release-version }} | |
| zowe_revision=${{ steps.tag-prep.outputs.ZOWE_REVISION }} | |
| echo ">>> Tagging $zowe_revision as $zowe_release_version ..." | |
| cd ${{ env.TAG_DIR }} | |
| commit=$(git show --format="%H" -s HEAD) | |
| if [[ "$commit" != "$zowe_revision" ]]; then | |
| echo -e "${RED}\n Failed to checkout $zowe_revision for tagging. The head of this branch is $commit " | |
| exit 1 | |
| fi | |
| git tag "v$zowe_release_version" | |
| git push origin "v$zowe_release_version" | |
| - name: '[Promote PTF 1 - formal release only!] Clone staging branch' | |
| if: ${{ env.IS_FORMAL_RELEASE == 'true' && env.SMPE_PTF_PROMOTE_TAR_PATH != '' }} | |
| uses: actions/checkout@v2 | |
| with: | |
| repository: ${{ env.ZOWE_INSTALL_PACKAGING_OWNER }}/${{ env.ZOWE_INSTALL_PACKAGING_REPO }} | |
| ref: ${{ env.STAGING_BRANCH }} | |
| token: ${{ secrets.ZOWE_ROBOT_TOKEN }} | |
| path: ${{ env.ORIGINAL_STAGING_DIR }} | |
| - name: '[Promote PTF 2 - formal release only!] Clone staging branch to a diff path to make new branch from it' | |
| if: ${{ env.IS_FORMAL_RELEASE == 'true' && env.SMPE_PTF_PROMOTE_TAR_PATH != '' }} | |
| uses: actions/checkout@v2 | |
| with: | |
| repository: ${{ env.ZOWE_INSTALL_PACKAGING_OWNER }}/${{ env.ZOWE_INSTALL_PACKAGING_REPO }} | |
| ref: ${{ env.STAGING_BRANCH }} | |
| token: ${{ secrets.ZOWE_ROBOT_TOKEN }} | |
| path: ${{ env.PROMOTE_PTF_DIR }} | |
| - name: '[Promote PTF 3 - formal release only!] Create a new branch (git checkout -b)' | |
| if: ${{ env.IS_FORMAL_RELEASE == 'true' && env.SMPE_PTF_PROMOTE_TAR_PATH != '' }} | |
| run: | | |
| cd ${{ env.PROMOTE_PTF_DIR }} | |
| git checkout -b "users/robot/promote-ptf-from-${{ github.run_number }}" | |
| - name: '[Promote PTF 4 - formal release only!] Download smpe-promote.tar' | |
| if: ${{ env.IS_FORMAL_RELEASE == 'true' && env.SMPE_PTF_PROMOTE_TAR_PATH != '' }} | |
| uses: zowe-actions/shared-actions/jfrog-download@main | |
| with: | |
| default-target-path: ${{ env.LOCAL_RELEASE_FOLDER }}/promote-ptf/smpe-promote.tar | |
| source-path-or-pattern: ${{ env.SMPE_PTF_PROMOTE_TAR_PATH }} | |
| extra-options: --flat=true | |
| expected-count: 1 | |
| - name: '[Promote PTF 5 - formal release only!] Doing remaining work' | |
| if: ${{ env.IS_FORMAL_RELEASE == 'true' && env.SMPE_PTF_PROMOTE_TAR_PATH != '' }} | |
| run: | | |
| # at the beginning, we are at root project dir of zowe-release | |
| # store the path of original project root dir | |
| original_staging_dir_path=$GITHUB_WORKSPACE/${{ env.ORIGINAL_STAGING_DIR }} | |
| # clone smpe-promote.sh to smpe-promote.sh.bak | |
| cd ${{ env.PROMOTE_PTF_DIR }}/smpe/bld | |
| cp smpe-promote.sh smpe-promote.sh.bak | |
| # copy the original smpe-promote.sh to the new checkout branch | |
| cp "$original_staging_dir_path/smpe/bld/smpe-promote.sh" . | |
| # run the original smpe-promote shell script | |
| ./smpe-promote.sh -d -p "$GITHUB_WORKSPACE/${{ env.LOCAL_RELEASE_FOLDER }}/promote-ptf/smpe-promote.tar" | |
| # rename(revert) the smpe-promote.sh.bak to discard git changes | |
| mv smpe-promote.sh.bak smpe-promote.sh | |
| # don't commit in this PR yet | |
| # now, show change status | |
| cd $GITHUB_WORKSPACE/${{ env.PROMOTE_PTF_DIR }} | |
| git status | |
| git config user.name ${{ secrets.ZOWE_ROBOT_USER }} | |
| git config user.email ${{ secrets.ZOWE_ROBOT_EMAIL }} | |
| # commit all changes | |
| git add . | |
| git commit -s -m "Promote PTF after release v${{ github.event.inputs.zowe-release-version }}" | |
| # push before creating PR | |
| git push https://${{ secrets.ZOWE_ROBOT_USER }}:${{ secrets.ZOWE_ROBOT_TOKEN }}@github.com/${{ env.ZOWE_INSTALL_PACKAGING_OWNER }}/${{ env.ZOWE_INSTALL_PACKAGING_REPO }} "users/robot/promote-ptf-from-${{ github.run_number }}" | |
| - name: '[Promote PTF 6 - formal release only!] Create a new Pull Request' | |
| uses: actions/github-script@v5 | |
| if: ${{ env.IS_FORMAL_RELEASE == 'true' && env.SMPE_PTF_PROMOTE_TAR_PATH != '' }} | |
| id: promote-ptf-6 | |
| with: | |
| github-token: ${{ secrets.ZOWE_ROBOT_TOKEN }} | |
| script: | | |
| // await means to wait this functions finishes then proceed | |
| var out = await github.rest.pulls.create({ | |
| owner: '${{ env.ZOWE_INSTALL_PACKAGING_OWNER }}', | |
| repo: '${{ env.ZOWE_INSTALL_PACKAGING_REPO }}', | |
| title: 'Automatically Promote PTF for v${{ github.event.inputs.zowe-release-version }} after release by zowe robot', | |
| head: 'users/robot/promote-ptf-from-${{ github.run_number }}', | |
| base: '${{ env.STAGING_BRANCH }}' | |
| }); | |
| console.log(`The pull request is at: ${out.data.html_url}`); | |
| return out.data.number; | |
| result-encoding: string | |
| - name: '[Promote PTF 7 - formal release only!] Add PR reviewers' | |
| if: ${{ env.IS_FORMAL_RELEASE == 'true' && env.SMPE_PTF_PROMOTE_TAR_PATH != '' && steps.promote-ptf-6.outputs.result != '' }} | |
| uses: actions/github-script@v5 | |
| with: | |
| github-token: ${{ secrets.ZOWE_ROBOT_TOKEN }} | |
| script: | | |
| github.rest.pulls.requestReviewers({ | |
| owner: '${{ env.ZOWE_INSTALL_PACKAGING_OWNER }}', | |
| repo: '${{ env.ZOWE_INSTALL_PACKAGING_REPO }}', | |
| pull_number: ${{ steps.promote-ptf-6.outputs.result }}, | |
| reviewers: [ | |
| 'MarkAckert','ojcelis' | |
| ] | |
| }); | |
| - name: Release result message (DevOps please click here to copy and announce) | |
| timeout-minutes: 2 | |
| uses: ./message | |
| with: | |
| release-artifact-download-file: ${{ steps.promote.outputs.RELEASE_ARTIFACTS_DOWNLOAD_SPEC_FILE }} | |
| release-version: ${{ github.event.inputs.zowe-release-version }} | |
| build-num: ${{ github.event.inputs.zowe-build-number }} |