name: Version Bump on: workflow_dispatch: inputs: bump_browser: description: "Bump Browser?" type: boolean default: false bump_cli: description: "Bump CLI?" type: boolean default: false bump_desktop: description: "Bump Desktop?" type: boolean default: false bump_web: description: "Bump Web?" type: boolean default: false 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 type: boolean enable_slack_notification: description: "Enable Slack notifications for upcoming release?" default: false type: boolean jobs: bump_version: name: Bump Version runs-on: ubuntu-22.04 outputs: version_browser: ${{ steps.set-final-version-output.outputs.version_browser }} version_cli: ${{ steps.set-final-version-output.outputs.version_cli }} version_desktop: ${{ steps.set-final-version-output.outputs.version_desktop }} version_web: ${{ steps.set-final-version-output.outputs.version_web }} steps: - name: Validate version input if: ${{ inputs.version_number_override != '' }} uses: bitwarden/gh-actions/version-check@main with: version: ${{ inputs.version_number_override }} - name: Slack Notification Check run: | if [[ "${{ inputs.enable_slack_notification }}" == true ]]; then echo "Slack notifications enabled." else echo "Slack notifications disabled." fi - name: Checkout Branch uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1 with: ref: main - name: Check if RC branch exists if: ${{ inputs.cut_rc_branch == true }} run: | remote_rc_branch_check=$(git ls-remote --heads origin rc | wc -l) if [[ "${remote_rc_branch_check}" -gt 0 ]]; then echo "Remote RC branch exists." echo "Please delete current RC branch before running again." 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" - name: Import GPG key uses: crazy-max/ghaction-import-gpg@01dd5d3ca463c7f10f7f4f7b4f177225ac661ee4 # v6.1.0 with: gpg_private_key: ${{ steps.retrieve-secrets.outputs.github-gpg-private-key }} passphrase: ${{ steps.retrieve-secrets.outputs.github-gpg-private-key-passphrase }} 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: | CLIENTS=() if [[ ${{ inputs.bump_browser }} == true ]]; then CLIENTS+=("browser") fi if [[ ${{ inputs.bump_cli }} == true ]]; then CLIENTS+=("cli") fi if [[ ${{ inputs.bump_desktop }} == true ]]; then CLIENTS+=("desktop") fi if [[ ${{ inputs.bump_web }} == true ]]; then CLIENTS+=("web") fi printf -v joined '%s,' "${CLIENTS[@]}" echo "client=${joined%,}" >> $GITHUB_OUTPUT NAME=version_bump_${{ github.ref_name }}_$(date +"%Y-%m-%d") git switch -c $NAME echo "name=$NAME" >> $GITHUB_OUTPUT ######################## # VERSION BUMP SECTION # ######################## ### Browser - name: Get current Browser version if: ${{ inputs.bump_browser == true }} id: current-browser-version run: | CURRENT_VERSION=$(cat package.json | jq -r '.version') echo "version=$CURRENT_VERSION" >> $GITHUB_OUTPUT working-directory: apps/browser - name: Browser - Verify input version if: ${{ inputs.bump_browser == true && inputs.version_number_override != '' }} env: CURRENT_VERSION: ${{ steps.current-browser-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." exit 1 fi # Check if version is newer. printf '%s\n' "${CURRENT_VERSION}" "${NEW_VERSION}" | sort -C -V if [ $? -eq 0 ]; then echo "Version check successful." else echo "Version check failed." exit 1 fi working-directory: apps/browser - name: Calculate next Browser release version if: ${{ inputs.bump_browser == true && inputs.version_number_override == '' }} id: calculate-next-browser-version uses: bitwarden/gh-actions/version-next@main with: version: ${{ steps.current-browser-version.outputs.version }} - name: Bump Browser Version - Version Override if: ${{ inputs.bump_browser == true && inputs.version_number_override != '' }} id: bump-browser-version-override run: npm version --workspace=@bitwarden/browser ${{ inputs.version_number_override }} - name: Bump Browser Version - Automatic Calculation if: ${{ inputs.bump_browser == true && inputs.version_number_override == '' }} id: bump-browser-version-automatic env: VERSION: ${{ steps.calculate-next-browser-version.outputs.version }} run: npm version --workspace=@bitwarden/browser $VERSION - name: Bump Browser Version - Manifest - Version Override if: ${{ inputs.bump_browser == true && inputs.version_number_override != '' }} uses: bitwarden/gh-actions/version-bump@main with: file_path: "apps/browser/src/manifest.json" version: ${{ inputs.version_number_override }} - name: Bump Browser Version - Manifest - Automatic Calculation if: ${{ inputs.bump_browser == true && inputs.version_number_override == '' }} uses: bitwarden/gh-actions/version-bump@main with: file_path: "apps/browser/src/manifest.json" version: ${{ steps.calculate-next-browser-version.outputs.version }} - name: Bump Browser Version - Manifest v3 - Version Override if: ${{ inputs.bump_browser == true && inputs.version_number_override != '' }} uses: bitwarden/gh-actions/version-bump@main with: file_path: "apps/browser/src/manifest.v3.json" version: ${{ inputs.version_number_override }} - name: Bump Browser Version - Manifest v3 - Automatic Calculation if: ${{ inputs.bump_browser == true && inputs.version_number_override == '' }} uses: bitwarden/gh-actions/version-bump@main with: file_path: "apps/browser/src/manifest.v3.json" version: ${{ steps.calculate-next-browser-version.outputs.version }} - name: Run Prettier after Browser Version Bump if: ${{ inputs.bump_browser == true }} run: | npm install -g prettier prettier --write apps/browser/src/manifest.json prettier --write apps/browser/src/manifest.v3.json ### CLI - name: Get current CLI version if: ${{ inputs.bump_cli == true }} id: current-cli-version run: | CURRENT_VERSION=$(cat package.json | jq -r '.version') echo "version=$CURRENT_VERSION" >> $GITHUB_OUTPUT working-directory: apps/cli - name: CLI - Verify input version if: ${{ inputs.bump_cli == true && inputs.version_number_override != '' }} env: CURRENT_VERSION: ${{ steps.current-cli-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." exit 1 fi # Check if version is newer. printf '%s\n' "${CURRENT_VERSION}" "${NEW_VERSION}" | sort -C -V if [ $? -eq 0 ]; then echo "Version check successful." else echo "Version check failed." exit 1 fi working-directory: apps/cli - name: Calculate next CLI release version if: ${{ inputs.bump_cli == true && inputs.version_number_override == '' }} id: calculate-next-cli-version uses: bitwarden/gh-actions/version-next@main with: version: ${{ steps.current-cli-version.outputs.version }} - name: Bump CLI Version - Version Override if: ${{ inputs.bump_cli == true && inputs.version_number_override != '' }} id: bump-cli-version-override run: npm version --workspace=@bitwarden/cli ${{ inputs.version_number_override }} - name: Bump CLI Version - Automatic Calculation if: ${{ inputs.bump_cli == true && inputs.version_number_override == '' }} id: bump-cli-version-automatic env: VERSION: ${{ steps.calculate-next-cli-version.outputs.version }} run: npm version --workspace=@bitwarden/cli $VERSION ### Desktop - name: Get current Desktop version if: ${{ inputs.bump_desktop == true }} id: current-desktop-version run: | CURRENT_VERSION=$(cat package.json | jq -r '.version') echo "version=$CURRENT_VERSION" >> $GITHUB_OUTPUT working-directory: apps/desktop - name: Desktop - Verify input version if: ${{ inputs.bump_desktop == true && inputs.version_number_override != '' }} env: CURRENT_VERSION: ${{ steps.current-desktop-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." exit 1 fi # Check if version is newer. printf '%s\n' "${CURRENT_VERSION}" "${NEW_VERSION}" | sort -C -V if [ $? -eq 0 ]; then echo "Version check successful." else echo "Version check failed." exit 1 fi working-directory: apps/desktop - name: Calculate next Desktop release version if: ${{ inputs.bump_desktop == true && inputs.version_number_override == '' }} id: calculate-next-desktop-version uses: bitwarden/gh-actions/version-next@main with: version: ${{ steps.current-desktop-version.outputs.version }} - name: Bump Desktop Version - Root - Version Override if: ${{ inputs.bump_desktop == true && inputs.version_number_override != '' }} id: bump-desktop-version-override run: npm version --workspace=@bitwarden/desktop ${{ inputs.version_number_override }} - name: Bump Desktop Version - Root - Automatic Calculation if: ${{ inputs.bump_desktop == true && inputs.version_number_override == '' }} id: bump-desktop-version-automatic env: VERSION: ${{ steps.calculate-next-desktop-version.outputs.version }} run: npm version --workspace=@bitwarden/desktop $VERSION - name: Bump Desktop Version - App - Version Override if: ${{ inputs.bump_desktop == true && inputs.version_number_override != '' }} run: npm version ${{ inputs.version_number_override }} working-directory: "apps/desktop/src" - name: Bump Desktop Version - App - Automatic Calculation if: ${{ inputs.bump_desktop == true && inputs.version_number_override == '' }} env: VERSION: ${{ steps.calculate-next-desktop-version.outputs.version }} run: npm version $VERSION working-directory: "apps/desktop/src" ### Web - name: Get current Web version if: ${{ inputs.bump_web == true }} id: current-web-version run: | CURRENT_VERSION=$(cat package.json | jq -r '.version') echo "version=$CURRENT_VERSION" >> $GITHUB_OUTPUT working-directory: apps/web - name: Web - Verify input version if: ${{ inputs.bump_web == true && inputs.version_number_override != '' }} env: CURRENT_VERSION: ${{ steps.current-web-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." exit 1 fi # Check if version is newer. printf '%s\n' "${CURRENT_VERSION}" "${NEW_VERSION}" | sort -C -V if [ $? -eq 0 ]; then echo "Version check successful." else echo "Version check failed." exit 1 fi working-directory: apps/web - name: Calculate next Web release version if: ${{ inputs.bump_web == true && inputs.version_number_override == '' }} id: calculate-next-web-version uses: bitwarden/gh-actions/version-next@main with: version: ${{ steps.current-web-version.outputs.version }} - name: Bump Web Version - Version Override if: ${{ inputs.bump_web == true && inputs.version_number_override != '' }} id: bump-web-version-override run: npm version --workspace=@bitwarden/web-vault ${{ inputs.version_number_override }} - name: Bump Web Version - Automatic Calculation if: ${{ inputs.bump_web == true && inputs.version_number_override == '' }} id: bump-web-version-automatic env: VERSION: ${{ steps.calculate-next-web-version.outputs.version }} run: npm version --workspace=@bitwarden/web-vault $VERSION ######################## - name: Set final version output id: set-final-version-output run: | if [[ "${{ steps.bump-browser-version-override.outcome }}" = "success" ]]; then echo "version_browser=${{ inputs.version_number_override }}" >> $GITHUB_OUTPUT elif [[ "${{ steps.bump-browser-version-automatic.outcome }}" = "success" ]]; then echo "version_browser=${{ steps.calculate-next-browser-version.outputs.version }}" >> $GITHUB_OUTPUT fi if [[ "${{ steps.bump-cli-version-override.outcome }}" = "success" ]]; then echo "version_cli=${{ inputs.version_number_override }}" >> $GITHUB_OUTPUT elif [[ "${{ steps.bump-cli-version-automatic.outcome }}" = "success" ]]; then echo "version_cli=${{ steps.calculate-next-cli-version.outputs.version }}" >> $GITHUB_OUTPUT fi if [[ "${{ steps.bump-desktop-version-override.outcome }}" = "success" ]]; then echo "version_desktop=${{ inputs.version_number_override }}" >> $GITHUB_OUTPUT elif [[ "${{ steps.bump-desktop-version-automatic.outcome }}" = "success" ]]; then echo "version_desktop=${{ steps.calculate-next-desktop-version.outputs.version }}" >> $GITHUB_OUTPUT fi if [[ "${{ steps.bump-web-version-override.outcome }}" = "success" ]]; then echo "version_web=${{ inputs.version_number_override }}" >> $GITHUB_OUTPUT elif [[ "${{ steps.bump-web-version-automatic.outcome }}" = "success" ]]; then echo "version_web=${{ steps.calculate-next-web-version.outputs.version }}" >> $GITHUB_OUTPUT fi - name: Check if version changed id: version-changed run: | if [ -n "$(git status --porcelain)" ]; then echo "changes_to_commit=TRUE" >> $GITHUB_OUTPUT else echo "changes_to_commit=FALSE" >> $GITHUB_OUTPUT echo "No changes to commit!"; fi - name: Commit files if: ${{ steps.version-changed.outputs.changes_to_commit == 'TRUE' }} run: git commit -m "Bumped client version(s)" -a - name: Push changes if: ${{ steps.version-changed.outputs.changes_to_commit == 'TRUE' }} env: PR_BRANCH: ${{ steps.create-branch.outputs.name }} run: git push -u origin $PR_BRANCH - name: Generate PR message if: ${{ steps.version-changed.outputs.changes_to_commit == 'TRUE' }} id: pr-message run: | MESSAGE="" if [[ "${{ inputs.bump_browser }}" == "true" ]]; then MESSAGE+=$' Browser version bump to ${{ steps.set-final-version-output.outputs.version_browser }}\n' fi if [[ "${{ inputs.bump_cli }}" == "true" ]]; then MESSAGE+=$' CLI version bump to ${{ steps.set-final-version-output.outputs.version_cli }}\n' fi if [[ "${{ inputs.bump_desktop }}" == "true" ]]; then MESSAGE+=$' Desktop version bump to ${{ steps.set-final-version-output.outputs.version_desktop }}\n' fi if [[ "${{ inputs.bump_web }}" == "true" ]]; then MESSAGE+=$' Web version bump to ${{ steps.set-final-version-output.outputs.version_web }}\n' fi echo "MESSAGE<> $GITHUB_ENV echo "$MESSAGE" >> $GITHUB_ENV echo "EOF" >> $GITHUB_ENV - name: Generate GH App token uses: actions/create-github-app-token@5d869da34e18e7287c1daad50e0b8ea0f506ce69 # v1.11.0 id: app-token with: app-id: ${{ secrets.BW_GHAPP_ID }} private-key: ${{ secrets.BW_GHAPP_KEY }} owner: ${{ github.repository_owner }} - name: Create Version PR if: ${{ steps.version-changed.outputs.changes_to_commit == 'TRUE' }} id: create-pr env: GH_TOKEN: ${{ steps.app-token.outputs.token }} PR_BRANCH: ${{ steps.create-branch.outputs.name }} TITLE: "Bump client(s) version" run: | PR_URL=$(gh pr create --title "$TITLE" \ --base "main" \ --head "$PR_BRANCH" \ --label "version update" \ --label "automated pr" \ --body " ## Type of change - [ ] Bug fix - [ ] New feature development - [ ] Tech debt (refactoring, code cleanup, dependency upgrades, etc) - [ ] Build/deploy pipeline (DevOps) - [X] Other ## Objective $MESSAGE") 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.app-token.outputs.token }} PR_NUMBER: ${{ steps.create-pr.outputs.pr_number }} run: gh pr merge $PR_NUMBER --squash --auto --delete-branch - name: Report upcoming browser release version to Slack if: ${{ steps.version-changed.outputs.changes_to_commit == 'TRUE' && steps.set-final-version-output.outputs.version_browser != '' && inputs.enable_slack_notification == true }} uses: bitwarden/gh-actions/report-upcoming-release-version@main with: version: ${{ steps.set-final-version-output.outputs.version_browser }} project: browser AZURE_KV_CI_SERVICE_PRINCIPAL: ${{ secrets.AZURE_KV_CI_SERVICE_PRINCIPAL }} - name: Report upcoming cli release version to Slack if: ${{ steps.version-changed.outputs.changes_to_commit == 'TRUE' && steps.set-final-version-output.outputs.version_cli != '' && inputs.enable_slack_notification == true }} uses: bitwarden/gh-actions/report-upcoming-release-version@main with: version: ${{ steps.set-final-version-output.outputs.version_cli }} project: cli AZURE_KV_CI_SERVICE_PRINCIPAL: ${{ secrets.AZURE_KV_CI_SERVICE_PRINCIPAL }} - name: Report upcoming desktop release version to Slack if: ${{ steps.version-changed.outputs.changes_to_commit == 'TRUE' && steps.set-final-version-output.outputs.version_desktop != '' && inputs.enable_slack_notification == true }} uses: bitwarden/gh-actions/report-upcoming-release-version@main with: version: ${{ steps.set-final-version-output.outputs.version_desktop }} project: desktop AZURE_KV_CI_SERVICE_PRINCIPAL: ${{ secrets.AZURE_KV_CI_SERVICE_PRINCIPAL }} - name: Report upcoming web release version to Slack if: ${{ steps.version-changed.outputs.changes_to_commit == 'TRUE' && steps.set-final-version-output.outputs.version_web != '' && inputs.enable_slack_notification == true }} uses: bitwarden/gh-actions/report-upcoming-release-version@main with: version: ${{ steps.set-final-version-output.outputs.version_web }} project: web AZURE_KV_CI_SERVICE_PRINCIPAL: ${{ secrets.AZURE_KV_CI_SERVICE_PRINCIPAL }} cut_rc: name: Cut RC branch if: ${{ inputs.cut_rc_branch == true }} needs: bump_version runs-on: ubuntu-22.04 steps: - name: Checkout Branch uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1 with: ref: main ### Browser - name: Browser - Verify version has been updated if: ${{ inputs.bump_browser == true }} env: NEW_VERSION: ${{ needs.bump_version.outputs.version_browser }} run: | # Wait for version to change. while : ; do echo "Waiting for version to be updated..." git pull --force CURRENT_VERSION=$(cat package.json | jq -r '.version') # If the versions don't match we continue the loop, otherwise we break out of the loop. [[ "$NEW_VERSION" != "$CURRENT_VERSION" ]] || break sleep 10 done working-directory: apps/browser ### CLI - name: CLI - Verify version has been updated if: ${{ inputs.bump_cli == true }} env: NEW_VERSION: ${{ needs.bump_version.outputs.version_cli }} run: | # Wait for version to change. while : ; do echo "Waiting for version to be updated..." git pull --force CURRENT_VERSION=$(cat package.json | jq -r '.version') # If the versions don't match we continue the loop, otherwise we break out of the loop. [[ "$NEW_VERSION" != "$CURRENT_VERSION" ]] || break sleep 10 done working-directory: apps/cli ### Desktop - name: Desktop - Verify version has been updated if: ${{ inputs.bump_desktop == true }} env: NEW_VERSION: ${{ needs.bump_version.outputs.version_desktop }} run: | # Wait for version to change. while : ; do echo "Waiting for version to be updated..." git pull --force CURRENT_VERSION=$(cat package.json | jq -r '.version') # If the versions don't match we continue the loop, otherwise we break out of the loop. [[ "$NEW_VERSION" != "$CURRENT_VERSION" ]] || break sleep 10 done working-directory: apps/desktop ### Web - name: Web - Verify version has been updated if: ${{ inputs.bump_web == true }} env: NEW_VERSION: ${{ needs.bump_version.outputs.version_web }} run: | # Wait for version to change. while : ; do echo "Waiting for version to be updated..." git pull --force CURRENT_VERSION=$(cat package.json | jq -r '.version') # If the versions don't match we continue the loop, otherwise we break out of the loop. [[ "$NEW_VERSION" != "$CURRENT_VERSION" ]] || break sleep 10 done working-directory: apps/web - name: Cut RC branch run: | git switch --quiet --create rc git push --quiet --set-upstream origin rc