From 459d20c019c4ae6be4a89d3d5188a5156e2b11c7 Mon Sep 17 00:00:00 2001 From: Vince Grassia <593223+vgrassia@users.noreply.github.com> Date: Tue, 12 Mar 2024 20:10:11 +0000 Subject: [PATCH] DEVOPS-1840 - Update for automatic version bump calculation (#3043) --- .github/workflows/version-auto-bump.yml | 24 +--- .github/workflows/version-bump.yml | 168 +++++++++++++++++------- 2 files changed, 126 insertions(+), 66 deletions(-) diff --git a/.github/workflows/version-auto-bump.yml b/.github/workflows/version-auto-bump.yml index 1805c2f52..aa2fc20e9 100644 --- a/.github/workflows/version-auto-bump.yml +++ b/.github/workflows/version-auto-bump.yml @@ -11,24 +11,6 @@ jobs: name: Bump Mobile Version runs-on: ubuntu-22.04 steps: - - name: Checkout Branch - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 - - - name: Calculate bumped version - id: version - env: - RELEASE_TAG: ${{ github.ref }} - run: | - CURR_MAJOR=$(echo $RELEASE_TAG | sed -r 's/refs\/tags\/v([0-9]{4}\.[0-9]{1,2})\.([0-9]{1,2})/\1/') - CURR_PATCH=$(echo $RELEASE_TAG | sed -r 's/refs\/tags\/v([0-9]{4}\.[0-9]{1,2})\.([0-9]{1,2})/\2/') - echo "Current Major: $CURR_MAJOR" - echo "Current Patch: $CURR_PATCH" - - NEW_PATCH=$((CURR_PATCH+1)) - NEW_VER=$CURR_MAJOR.$NEW_PATCH - echo "New Version: $NEW_VER" - echo "new_version=$NEW_VER" >> $GITHUB_OUTPUT - - name: Login to Azure - CI Subscription uses: Azure/login@e15b166166a8746d1a47596803bd8c1b595455cf # v1.6.0 with: @@ -41,9 +23,9 @@ jobs: keyvault: bitwarden-ci secrets: "github-pat-bitwarden-devops-bot-repo-scope" - - name: "Bump version to ${{ steps.version.outputs.new_version }}" + - name: Trigger Version Bump workflow env: GH_TOKEN: ${{ steps.retrieve-bot-secrets.outputs.github-pat-bitwarden-devops-bot-repo-scope }} run: | - echo '{"cut_rc_branch": "false", "version_number": "${{ steps.version.outputs.new_version }}"}' | \ - gh workflow run version-bump.yml --json --repo bitwarden/mobile \ No newline at end of file + echo '{"cut_rc_branch": "false"}' | \ + gh workflow run version-bump.yml --json --repo bitwarden/mobile diff --git a/.github/workflows/version-bump.yml b/.github/workflows/version-bump.yml index 20d525891..c73dd5b8c 100644 --- a/.github/workflows/version-bump.yml +++ b/.github/workflows/version-bump.yml @@ -1,13 +1,13 @@ --- name: Version Bump -run-name: Version Bump - v${{ inputs.version_number }} on: workflow_dispatch: inputs: - version_number: - description: "New version (example: '2024.1.0')" - required: true + version_number_override: + description: "New version override (leave blank for automatic calculation, example: '2024.1.0')" + required: false + type: string cut_rc_branch: description: "Cut RC branch?" default: true @@ -15,22 +15,16 @@ on: jobs: bump_version: - name: "Bump Version to v${{ inputs.version_number }}" + name: Bump Version runs-on: ubuntu-22.04 + outputs: + version: ${{ steps.set-final-version-output.outputs.version }} steps: - - name: Login to Azure - CI Subscription - uses: Azure/login@e15b166166a8746d1a47596803bd8c1b595455cf # v1.6.0 + - name: Validate version input + if: ${{ inputs.version_number_override != '' }} + uses: bitwarden/gh-actions/version-check@main with: - creds: ${{ secrets.AZURE_KV_CI_SERVICE_PRINCIPAL }} - - - name: Retrieve secrets - id: retrieve-secrets - uses: bitwarden/gh-actions/get-keyvault-secrets@main - with: - keyvault: "bitwarden-ci" - secrets: "github-gpg-private-key, - github-gpg-private-key-passphrase, - github-pat-bitwarden-devops-bot-repo-scope" + version: ${{ inputs.version_number_override }} - name: Checkout Branch uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 @@ -47,6 +41,20 @@ jobs: exit 1 fi + - name: Login to Azure - CI Subscription + uses: Azure/login@e15b166166a8746d1a47596803bd8c1b595455cf # v1.6.0 + with: + creds: ${{ secrets.AZURE_KV_CI_SERVICE_PRINCIPAL }} + + - name: Retrieve secrets + id: retrieve-secrets + uses: bitwarden/gh-actions/get-keyvault-secrets@main + with: + keyvault: "bitwarden-ci" + secrets: "github-gpg-private-key, + github-gpg-private-key-passphrase, + github-pat-bitwarden-devops-bot-repo-scope" + - name: Import GPG key uses: crazy-max/ghaction-import-gpg@01dd5d3ca463c7f10f7f4f7b4f177225ac661ee4 # v6.1.0 with: @@ -55,25 +63,38 @@ jobs: git_user_signingkey: true git_commit_gpgsign: true + - name: Setup git + run: | + git config --local user.email "106330231+bitwarden-devops-bot@users.noreply.github.com" + git config --local user.name "bitwarden-devops-bot" + - name: Create Version Branch id: create-branch run: | - NAME=version_bump_${{ github.ref_name }}_${{ inputs.version_number }} + NAME=version_bump_${{ github.ref_name }}_$(date +"%Y-%m-%d") git switch -c $NAME echo "name=$NAME" >> $GITHUB_OUTPUT - name: Install xmllint - run: sudo apt install -y libxml2-utils + run: | + sudo apt-get update + sudo apt-get install -y libxml2-utils - - name: Verify input version - env: - NEW_VERSION: ${{ inputs.version_number }} + - name: Get current version + id: current-version run: | CURRENT_VERSION=$(xmllint --xpath ' - string(/manifest/@*[local-name()="versionName" + string(/manifest/@*[local-name()="versionName" and namespace-uri()="http://schemas.android.com/apk/res/android"]) ' src/App/Platforms/Android/AndroidManifest.xml) + echo "version=$CURRENT_VERSION" >> $GITHUB_OUTPUT + - name: Verify input version + if: ${{ inputs.version_number_override != '' }} + env: + CURRENT_VERSION: ${{ steps.current-version.outputs.version }} + NEW_VERSION: ${{ inputs.version_number_override }} + run: | # Error if version has not changed. if [[ "$NEW_VERSION" == "$CURRENT_VERSION" ]]; then echo "Version has not changed." @@ -89,40 +110,93 @@ jobs: exit 1 fi - - name: Bump Version - Android XML + - name: Calculate next release version + if: ${{ inputs.version_number_override == '' }} + id: calculate-next-version + uses: bitwarden/gh-actions/version-next@main + with: + version: ${{ steps.current-version.outputs.version }} + + - name: Bump Version - Android XML - Version Override + if: ${{ inputs.version_number_override != '' }} + id: bump-version-override uses: bitwarden/gh-actions/version-bump@main with: - version: ${{ inputs.version_number }} file_path: "src/App/Platforms/Android/AndroidManifest.xml" + version: ${{ inputs.version_number_override }} - - name: Bump Version - iOS.Autofill + - name: Bump Version - Android XML - Automatic Calculation + if: ${{ inputs.version_number_override == '' }} + id: bump-version-automatic + uses: bitwarden/gh-actions/version-bump@main + with: + file_path: "src/App/Platforms/Android/AndroidManifest.xml" + version: ${{ steps.calculate-next-version.outputs.version }} + + - name: Bump Version - iOS.Autofill - Version Override + if: ${{ inputs.version_number_override != '' }} uses: bitwarden/gh-actions/version-bump@main with: - version: ${{ inputs.version_number }} file_path: "src/iOS.Autofill/Info.plist" + version: ${{ inputs.version_number_override }} - - name: Bump Version - iOS.Extension + - name: Bump Version - iOS.Autofill - Automatic Calculation + if: ${{ inputs.version_number_override == '' }} + uses: bitwarden/gh-actions/version-bump@main + with: + file_path: "src/iOS.Autofill/Info.plist" + version: ${{ steps.calculate-next-version.outputs.version }} + + - name: Bump Version - iOS.Extension - Version Override + if: ${{ inputs.version_number_override != '' }} uses: bitwarden/gh-actions/version-bump@main with: - version: ${{ inputs.version_number }} file_path: "src/iOS.Extension/Info.plist" + version: ${{ inputs.version_number_override }} - - name: Bump Version - iOS.ShareExtension + - name: Bump Version - iOS.Extension - Automatic Calculation + if: ${{ inputs.version_number_override == '' }} + uses: bitwarden/gh-actions/version-bump@main + with: + file_path: "src/iOS.Extension/Info.plist" + version: ${{ steps.calculate-next-version.outputs.version }} + + - name: Bump Version - iOS.ShareExtension - Version Override + if: ${{ inputs.version_number_override != '' }} uses: bitwarden/gh-actions/version-bump@main with: - version: ${{ inputs.version_number }} file_path: "src/iOS.ShareExtension/Info.plist" + version: ${{ inputs.version_number_override }} - - name: Bump Version - iOS + - name: Bump Version - iOS.ShareExtension - Automatic Calculation + if: ${{ inputs.version_number_override == '' }} uses: bitwarden/gh-actions/version-bump@main with: - version: ${{ inputs.version_number }} - file_path: "src/App/Platforms/iOS/Info.plist" + file_path: "src/iOS.ShareExtension/Info.plist" + version: ${{ steps.calculate-next-version.outputs.version }} - - name: Setup git + - name: Bump Version - iOS - Version Override + if: ${{ inputs.version_number_override != '' }} + uses: bitwarden/gh-actions/version-bump@main + with: + file_path: "src/App/Platforms/iOS/Info.plist" + version: ${{ inputs.version_number_override }} + + - name: Bump Version - iOS - Automatic Calculation + if: ${{ inputs.version_number_override == '' }} + uses: bitwarden/gh-actions/version-bump@main + with: + file_path: "src/App/Platforms/iOS/Info.plist" + version: ${{ steps.calculate-next-version.outputs.version }} + + - name: Set Job output + id: set-final-version-output run: | - git config --local user.email "106330231+bitwarden-devops-bot@users.noreply.github.com" - git config --local user.name "bitwarden-devops-bot" + if [[ "${{ steps.bump-version-override.outcome }}" == "success" ]]; then + echo "version=${{ inputs.version_number_override }}" >> $GITHUB_OUTPUT + elif [[ "${{ steps.bump-version-automatic.outcome }}" == "success" ]]; then + echo "version=${{ steps.calculate-next-version.outputs.version }}" >> $GITHUB_OUTPUT + fi - name: Check if version changed id: version-changed @@ -136,7 +210,7 @@ jobs: - name: Commit files if: ${{ steps.version-changed.outputs.changes_to_commit == 'TRUE' }} - run: git commit -m "Bumped version to ${{ inputs.version_number }}" -a + run: git commit -m "Bumped version to ${{ steps.set-final-version-output.outputs.version }}" -a - name: Push changes if: ${{ steps.version-changed.outputs.changes_to_commit == 'TRUE' }} @@ -150,7 +224,7 @@ jobs: env: GH_TOKEN: ${{ steps.retrieve-secrets.outputs.github-pat-bitwarden-devops-bot-repo-scope }} PR_BRANCH: ${{ steps.create-branch.outputs.name }} - TITLE: "Bump version to ${{ inputs.version_number }}" + TITLE: "Bump version to ${{ steps.set-final-version-output.outputs.version }}" run: | PR_URL=$(gh pr create --title "$TITLE" \ --base "main" \ @@ -166,16 +240,18 @@ jobs: - [X] Other ## Objective - Automated version bump to ${{ inputs.version_number }}") + Automated version bump to ${{ steps.set-final-version-output.outputs.version }}") echo "pr_number=${PR_URL##*/}" >> $GITHUB_OUTPUT - name: Approve PR + if: ${{ steps.version-changed.outputs.changes_to_commit == 'TRUE' }} env: GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} PR_NUMBER: ${{ steps.create-pr.outputs.pr_number }} run: gh pr review $PR_NUMBER --approve - name: Merge PR + if: ${{ steps.version-changed.outputs.changes_to_commit == 'TRUE' }} env: GH_TOKEN: ${{ steps.retrieve-secrets.outputs.github-pat-bitwarden-devops-bot-repo-scope }} PR_NUMBER: ${{ steps.create-pr.outputs.pr_number }} @@ -183,28 +259,30 @@ jobs: cut_rc: name: Cut RC branch - needs: bump_version if: ${{ inputs.cut_rc_branch == true }} + needs: bump_version runs-on: ubuntu-22.04 steps: - name: Checkout Branch uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 with: ref: main - + - name: Install xmllint - run: sudo apt install -y libxml2-utils + run: | + sudo apt-get update + sudo apt-get install -y libxml2-utils - name: Verify version has been updated env: - NEW_VERSION: ${{ inputs.version_number }} + NEW_VERSION: ${{ needs.bump_version.outputs.version }} run: | # Wait for version to change. while : ; do echo "Waiting for version to be updated..." git pull --force CURRENT_VERSION=$(xmllint --xpath ' - string(/manifest/@*[local-name()="versionName" + string(/manifest/@*[local-name()="versionName" and namespace-uri()="http://schemas.android.com/apk/res/android"]) ' src/App/Platforms/Android/AndroidManifest.xml)