feat: simplify patch release workflow (#8196)

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: Richie Foreman <richie.foreman@gmail.com>

.github/actions/publish-release/action.yml

@@ -19,9 +19,10 @@ inputs:
     required: true
   dry-run:
     description: 'Whether to run in dry-run mode.'
+    type: 'boolean'
     required: true
-  release-branch:
-    description: 'The branch to target for the release.'
+  release-tag:
+    description: 'The release tag for the release (e.g., v0.1.11).'
     required: true
   previous-tag:
     description: 'The previous tag to use for generating release notes.'
@@ -34,6 +35,44 @@ inputs:
 runs:
   using: 'composite'
   steps:
+    - name: 'Configure Git User'
+      working-directory: '${{ inputs.working-directory }}'
+      shell: 'bash'
+      run: |-
+        git config user.name "gemini-cli-robot"
+        git config user.email "gemini-cli-robot@google.com"
+
+    - name: 'Create and switch to a release branch'
+      working-directory: '${{ inputs.working-directory }}'
+      id: 'release_branch'
+      shell: 'bash'
+      run: |
+        BRANCH_NAME="release/${{ inputs.release-tag }}"
+        git switch -c "${BRANCH_NAME}"
+        echo "BRANCH_NAME=${BRANCH_NAME}" >> "${GITHUB_OUTPUT}"
+
+    - name: 'Update package versions'
+      working-directory: '${{ inputs.working-directory }}'
+      shell: 'bash'
+      run: 'npm run release:version "${{ inputs.release-version }}"'
+
+    - name: 'Commit and Conditionally Push package versions'
+      working-directory: '${{ inputs.working-directory }}'
+      shell: 'bash'
+      env:
+        BRANCH_NAME: '${{ steps.release_branch.outputs.BRANCH_NAME }}'
+        DRY_RUN: '${{ inputs.dry-run }}'
+        RELEASE_TAG: '${{ inputs.release-tag }}'
+      run: |-
+        git add package.json package-lock.json packages/*/package.json
+        git commit -m "chore(release): ${RELEASE_TAG}"
+        if [[ "${DRY_RUN}" == "false" ]]; then
+          echo "Pushing release branch to remote..."
+          git push --set-upstream origin "${BRANCH_NAME}" --follow-tags
+        else
+          echo "Dry run enabled. Skipping push."
+        fi
+
     - name: 'Build and Prepare Packages'
       working-directory: '${{ inputs.working-directory }}'
       run: |-
@@ -61,7 +100,7 @@ runs:
 
     - name: 'Install latest core package'
       working-directory: '${{ inputs.working-directory }}'
-      if: '${{ inputs.dry-run == "false" }}'
+      if: '${{ inputs.dry-run == false }}'
       run: |-
         npm install "@google/gemini-cli-core@${{ inputs.release-version }}" \
         --workspace="@google/gemini-cli" \
@@ -86,14 +125,28 @@ runs:
 
     - name: 'Create GitHub Release'
       working-directory: '${{ inputs.working-directory }}'
-      if: '${{ inputs.dry-run == "false" }}'
+      if: '${{ inputs.dry-run == false }}'
       env:
         GITHUB_TOKEN: '${{ inputs.github-token }}'
       run: |-
-        gh release create "v${{ inputs.release-version }}" \
+        gh release create "${{ inputs.release-tag }}" \
           bundle/gemini.js \
-          --target "${{ inputs.release-branch }}" \
-          --title "Release v${{ inputs.release-version }}" \
+          --target "${{ steps.release_branch.outputs.BRANCH_NAME }}" \
+          --title "Release ${{ inputs.release-tag }}" \
           --notes-start-tag "${{ inputs.previous-tag }}" \
           --generate-notes
       shell: 'bash'
+
+    - name: 'Create Issue on Failure'
+      if: |-
+        ${{ failure() }}
+      env:
+        GITHUB_TOKEN: '${{ inputs.github-token }}'
+        RELEASE_TAG: '${{ inputs.release-tag }} || "N/A"'
+        DETAILS_URL: '${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}'
+      run: |-
+        gh issue create \
+          --title "Release Failed for ${RELEASE_TAG} on $(date +'%Y-%m-%d')" \
+          --body "The release workflow failed. See the full run for details: ${DETAILS_URL}" \
+          --label "kind/bug,release-failure,priority/p0"
+      shell: 'bash'

.github/actions/run-tests/action.yml

@@ -0,0 +1,24 @@
+name: 'Run Tests'
+description: 'Runs the preflight checks and integration tests.'
+
+inputs:
+  force_skip_tests:
+    description: 'Whether to force skip the tests.'
+    required: false
+    default: 'false'
+  gemini_api_key:
+    description: 'The API key for running integration tests.'
+    required: true
+
+runs:
+  using: 'composite'
+  steps:
+    - name: 'Run Tests'
+      if: "inputs.force_skip_tests != 'true'"
+      env:
+        GEMINI_API_KEY: '${{ inputs.gemini_api_key }}'
+      run: |-
+        npm run preflight
+        npm run test:integration:sandbox:none
+        npm run test:integration:sandbox:docker
+      shell: 'bash'

.github/workflows/nightly-release.yml

@@ -10,6 +10,11 @@ on:
         required: true
         type: 'boolean'
         default: true
+      force_skip_tests:
+        description: 'Select to skip the "Run Tests" step in testing. Prod releases should run tests'
+        required: false
+        type: 'boolean'
+        default: false
 
 jobs:
   release:
@@ -29,6 +34,12 @@ jobs:
       - name: 'Install Dependencies'
         run: 'npm ci'
 
+      - name: 'Run Tests'
+        uses: './.github/actions/run-tests'
+        with:
+          force_skip_tests: '${{ github.event.inputs.force_skip_tests }}'
+          gemini_api_key: '${{ secrets.GEMINI_API_KEY }}'
+
       - name: 'Get Nightly Version'
         id: 'nightly_version'
         env:
@@ -44,10 +55,10 @@ jobs:
         uses: './.github/actions/publish-release'
         with:
           release-version: '${{ steps.nightly_version.outputs.RELEASE_VERSION }}'
+          release-tag: '${{ steps.nightly_version.outputs.RELEASE_TAG }}'
           npm-tag: '${{ steps.nightly_version.outputs.NPM_TAG }}'
           wombat-token-core: '${{ secrets.WOMBAT_TOKEN_CORE }}'
           wombat-token-cli: '${{ secrets.WOMBAT_TOKEN_CLI }}'
           github-token: '${{ secrets.GITHUB_TOKEN }}'
           dry-run: '${{ github.event.inputs.dry_run }}'
-          release-branch: 'main'
           previous-tag: '${{ steps.nightly_version.outputs.PREVIOUS_TAG }}'

.github/workflows/patch-release.yml

@@ -0,0 +1,94 @@
+name: 'Patch Release'
+
+on:
+  workflow_dispatch:
+    inputs:
+      type:
+        description: 'The type of release to patch from.'
+        required: true
+        type: 'choice'
+        options:
+          - 'stable'
+          - 'preview'
+      ref:
+        description: 'The branch or ref (full git sha) to release from.'
+        required: true
+        type: 'string'
+        default: 'main'
+      dry_run:
+        description: 'Run a dry-run of the release process; no branches, npm packages or GitHub releases will be created.'
+        required: true
+        type: 'boolean'
+        default: true
+      force_skip_tests:
+        description: 'Select to skip the "Run Tests" step in testing. Prod releases should run tests'
+        required: false
+        type: 'boolean'
+        default: false
+
+jobs:
+  release:
+    runs-on: 'ubuntu-latest'
+    environment:
+      name: 'production-release'
+      url: '${{ github.server_url }}/${{ github.repository }}/releases/tag/${{ steps.version.outputs.RELEASE_TAG }}'
+    if: |-
+      ${{ github.repository == 'google-gemini/gemini-cli' }}
+    permissions:
+      contents: 'write'
+      packages: 'write'
+      id-token: 'write'
+      issues: 'write' # For creating issues on failure
+    outputs:
+      RELEASE_TAG: '${{ steps.version.outputs.RELEASE_TAG }}'
+
+    steps:
+      - name: 'Checkout'
+        uses: 'actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8' # ratchet:actions/checkout@v5
+        with:
+          ref: '${{ github.event.inputs.ref || github.sha }}'
+          fetch-depth: 0
+
+      - name: 'Setup Node.js'
+        uses: 'actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020' # ratchet:actions/setup-node@v4
+        with:
+          node-version-file: '.nvmrc'
+          cache: 'npm'
+
+      - name: 'Install Dependencies'
+        run: |-
+          npm ci
+
+      - name: 'Get the version'
+        id: 'version'
+        env:
+          GITHUB_TOKEN: '${{ secrets.GITHUB_TOKEN }}'
+        run: |-
+          VERSION_JSON="$(node scripts/get-release-version.js --type=patch --patch-from=${{ github.event.inputs.type }})"
+          echo "${VERSION_JSON}"
+          echo "RELEASE_TAG=$(echo "${VERSION_JSON}" | jq -r .releaseTag)" >> "${GITHUB_OUTPUT}"
+          echo "RELEASE_VERSION=$(echo "${VERSION_JSON}" | jq -r .releaseVersion)" >> "${GITHUB_OUTPUT}"
+          echo "NPM_TAG=$(echo "${VERSION_JSON}" | jq -r .npmTag)" >> "${GITHUB_OUTPUT}"
+          echo "PREVIOUS_TAG=$(echo "${VERSION_JSON}" | jq -r .previousReleaseTag)" >> "${GITHUB_OUTPUT}"
+
+      - name: 'Print Calculated Version'
+        run: |-
+          echo "Calculated version: ${{ steps.version.outputs.RELEASE_VERSION }}"
+
+      - name: 'Run Tests'
+        uses: './.github/actions/run-tests'
+        with:
+          force_skip_tests: '${{ github.event.inputs.force_skip_tests }}'
+          gemini_api_key: '${{ secrets.GEMINI_API_KEY }}'
+
+      - name: 'Publish Release'
+        uses: './.github/actions/publish-release'
+        with:
+          release-version: '${{ steps.version.outputs.RELEASE_VERSION }}'
+          release-tag: '${{ steps.version.outputs.RELEASE_TAG }}'
+          npm-tag: '${{ steps.version.outputs.NPM_TAG }}'
+          wombat-token-core: '${{ secrets.WOMBAT_TOKEN_CORE }}'
+          wombat-token-cli: '${{ secrets.WOMBAT_TOKEN_CLI }}'
+          github-token: '${{ secrets.GITHUB_TOKEN }}'
+          dry-run: '${{ github.event.inputs.dry_run }}'
+          previous-tag: '${{ steps.version.outputs.PREVIOUS_TAG }}'

.github/workflows/promote-release.yml

@@ -8,6 +8,11 @@ on:
         required: true
         type: 'boolean'
         default: true
+      force_skip_tests:
+        description: 'Select to skip the "Run Tests" step in testing. Prod releases should run tests'
+        required: false
+        type: 'boolean'
+        default: false
 
 jobs:
   calculate-versions:
@@ -99,50 +104,22 @@ jobs:
         working-directory: './release'
         run: 'npm ci'
 
-      - name: 'Configure Git User'
-        working-directory: './release'
-        run: |-
-          git config user.name "gemini-cli-robot"
-          git config user.email "gemini-cli-robot@google.com"
-
-      - name: 'Create and switch to a release branch'
-        working-directory: './release'
-        id: 'release_branch'
-        run: |
-          BRANCH_NAME="release/v${{ matrix.version }}"
-          git switch -c "${BRANCH_NAME}"
-          echo "BRANCH_NAME=${BRANCH_NAME}" >> "${GITHUB_OUTPUT}"
-
-      - name: 'Update package versions'
-        working-directory: './release'
-        run: 'npm run release:version "${{ matrix.version }}"'
-
-      - name: 'Commit and Conditionally Push package versions'
-        working-directory: './release'
-        env:
-          BRANCH_NAME: '${{ steps.release_branch.outputs.BRANCH_NAME }}'
-          DRY_RUN: '${{ github.event.inputs.dry_run }}'
-          RELEASE_TAG: 'v${{ matrix.version }}'
-        run: |-
-          git add package.json package-lock.json packages/*/package.json
-          git commit -m "chore(release): ${RELEASE_TAG}"
-          if [[ "${DRY_RUN}" == "false" ]]; then
-            echo "Pushing release branch to remote..."
-            git push --set-upstream origin "${BRANCH_NAME}" --follow-tags
-          else
-            echo "Dry run enabled. Skipping push."
-          fi
+      - name: 'Run Tests'
+        uses: './.github/actions/run-tests'
+        with:
+          force_skip_tests: '${{ github.event.inputs.force_skip_tests }}'
+          gemini_api_key: '${{ secrets.GEMINI_API_KEY }}'
 
       - name: 'Publish Release'
         uses: './.github/actions/publish-release'
         with:
           release-version: '${{ matrix.version }}'
+          release-tag: 'v${{ matrix.version }}'
           npm-tag: '${{ matrix.npm-tag }}'
           wombat-token-core: '${{ secrets.WOMBAT_TOKEN_CORE }}'
           wombat-token-cli: '${{ secrets.WOMBAT_TOKEN_CLI }}'
           github-token: '${{ secrets.GITHUB_TOKEN }}'
           dry-run: '${{ github.event.inputs.dry_run }}'
-          release-branch: '${{ steps.release_branch.outputs.BRANCH_NAME }}'
           previous-tag: '${{ matrix.previous-tag }}'
           working-directory: './release'