INTPYTHON-615 Set up GitHub workflows for automated releases

blink1073 · blink1073 · commit 76db8927c665 · 2025-04-30T14:30:44.000-05:00
diff --git a/.github/workflows/release-python.yml b/.github/workflows/release-python.yml
@@ -1,12 +1,25 @@
-name: Python Wheels
+name: Release
 
 on:
-  push:
-    branches: ["main"]
-    tags:
-      - "**"
-  pull_request:
   workflow_dispatch:
+    inputs:
+      following_version:
+        description: "The post (dev) version to set"
+      dry_run:
+        description: "Dry Run?"
+        default: false
+        type: boolean
+  schedule:
+    - cron:  '30 5 * * *'
+
+env:
+  # Changes per repo
+  PRODUCT_NAME: python-bsonjs
+  # Constant
+  # inputs will be empty on a scheduled run.  so, we only set dry_run
+  # to 'false' when the input is set to 'false'.
+  DRY_RUN: ${{ ! contains(inputs.dry_run, 'false') }}
+  FOLLOWING_VERSION: ${{ inputs.following_version || '' }}
 
 concurrency:
   group: wheels-${{ github.ref }}
@@ -17,83 +30,90 @@ defaults:
     shell: bash -eux {0}
 
 jobs:
-
-  build_dist:
-    name: Build Distribution Files
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-          persist-credentials: false
-
-      - uses: actions/setup-python@v5
-        with:
-          # Build sdist on lowest supported Python
-          python-version: '3.10'
-
-      - name: Install build
-        run: |
-          python -m pip install build
-
-      - name: build the dist files
-        run: |
-          python -m build .
-
-      - name: Upload the dist files
-        uses: actions/upload-artifact@v4
-        with:
-          name: dist-${{ github.run_id }}
-          path: ./dist/*.*
-
-  test_dist:
-    needs: [build_dist]
-    name: Test Distribution Files
+  pre-publish:
+    environment: release
     runs-on: ubuntu-latest
+    if: github.repository_owner == 'mongodb-labs' || github.event_name == 'workflow_dispatch'
+    permissions:
+      id-token: write
+      contents: write
+    outputs:
+      version: ${{ steps.pre-publish.outputs.version }}
     steps:
-      - uses: actions/checkout@v4
+      - uses: mongodb-labs/drivers-github-tools/secure-checkout@v2
         with:
-          fetch-depth: 0
-          persist-credentials: false
-
-      - uses: actions/setup-python@v5
+          app_id: ${{ vars.APP_ID }}
+          private_key: ${{ secrets.APP_PRIVATE_KEY }}
+      - uses: mongodb-labs/drivers-github-tools/setup@v2
         with:
-          # Build sdist on lowest supported Python
-          python-version: '3.10'
-
-      - name: Download the dists
-        uses: actions/download-artifact@v4
+          aws_role_arn: ${{ secrets.AWS_ROLE_ARN }}
+          aws_region_name: ${{ vars.AWS_REGION_NAME }}
+          aws_secret_id: ${{ secrets.AWS_SECRET_ID }}
+          artifactory_username: ${{ vars.ARTIFACTORY_USERNAME }}
+      - uses: mongodb-labs/drivers-github-tools/python-labs/pre-publish@v2
+        id: pre-publish
         with:
-          name: dist-${{ github.run_id }}
-          path: dist/
+          dry_run: ${{ env.DRY_RUN }}
 
-      - name: Test the sdist
-        run: |
-          cd dist
-          pip install *.tar.gz
-          python -c "import pymongo_voyageai"
-          pip uninstall -y pymongo_voyageai
+  build-dist:
+    needs: [pre-publish]
+    uses: ./.github/workflows/dist.yml
+    with:
+      ref: ${{ needs.pre-publish.outputs.version }}
 
-      - name: Test the wheel
-        run: |
-          cd dist
-          pip install *.whl
-          python -c "import pymongo_voyageai"
-          pip uninstall -y pymongo_voyageai
+  static-scan:
+    needs: [pre-publish]
+    uses: ./.github/workflows/codeql.yml
+    with:
+      ref: ${{ needs.pre-publish.outputs.version }}
 
   publish:
     # https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/#publishing-the-distribution-to-pypi
-    needs: [test_dist]
-    if: startsWith(github.ref, 'refs/tags/')
+    needs: [build-dist, static-scan]
+    if: (github.repository_owner == 'mongodb-labs' && github.event_name != 'pull_request')  || github.event_name == 'workflow_dispatch'
     runs-on: ubuntu-latest
     environment: release
     permissions:
       id-token: write
     steps:
-    - name: Download the dists
+    - name: Download all the dists
       uses: actions/download-artifact@v4
       with:
-        name: dist-${{ github.run_id }}
+        name: all-dist-${{ github.run_id }}
         path: dist/
+    - name: Publish package distributions to TestPyPI
+      uses: pypa/gh-action-pypi-publish@76f52bc884231f62b9a034ebfe128415bbaabdfc # release/v1
+      with:
+        repository-url: https://test.pypi.org/legacy/
+        skip-existing: true
+        attestations: ${{ env.DRY_RUN }}
     - name: Publish distribution 📦 to PyPI
-      uses: pypa/gh-action-pypi-publish@release/v1
+      if: startsWith(env.DRY_RUN, 'false')
+      uses: pypa/gh-action-pypi-publish@76f52bc884231f62b9a034ebfe128415bbaabdfc # release/v1
+
+  post-publish:
+    needs: [publish]
+    runs-on: ubuntu-latest
+    environment: release
+    permissions:
+      id-token: write
+      contents: write
+      attestations: write
+      security-events: write
+    steps:
+      - uses: mongodb-labs/drivers-github-tools/secure-checkout@v2
+        with:
+          app_id: ${{ vars.APP_ID }}
+          private_key: ${{ secrets.APP_PRIVATE_KEY }}
+      - uses: mongodb-labs/drivers-github-tools/setup@v2
+        with:
+          aws_role_arn: ${{ secrets.AWS_ROLE_ARN }}
+          aws_region_name: ${{ vars.AWS_REGION_NAME }}
+          aws_secret_id: ${{ secrets.AWS_SECRET_ID }}
+          artifactory_username: ${{ vars.ARTIFACTORY_USERNAME }}
+      - uses: mongodb-labs/drivers-github-tools/python-labs/post-publish@v2
+        with:
+          following_version: ${{ env.FOLLOWING_VERSION }}
+          product_name: ${{ env.PRODUCT_NAME }}
+          token: ${{ github.token }}
+          dry_run: ${{ env.DRY_RUN }}
diff --git a/.github/workflows/test-python.yml b/.github/workflows/test-python.yml
@@ -25,11 +25,11 @@ jobs:
         persist-credentials: false
         fetch-depth: 0
     - name: Install uv
-      uses: astral-sh/setup-uv@v5
+      uses: astral-sh/setup-uv@d4b2f3b6ecc6e67c4457f6d3e41ec42d3d0fcb86 # v5
       with:
         enable-cache: true
         python-version: ${{ matrix.python-version }}
-    - uses: extractions/setup-just@v3
+    - uses: extractions/setup-just@e33e0265a09d6d736e2ee1e0eb685ef1de4669ff # v3
     - run: just install
     - run: just lint
     - run: just docs
@@ -47,11 +47,11 @@ jobs:
           persist-credentials: false
           fetch-depth: 0
       - name: Install uv
-        uses: astral-sh/setup-uv@v5
+        uses: astral-sh/setup-uv@d4b2f3b6ecc6e67c4457f6d3e41ec42d3d0fcb86 # v5
         with:
           enable-cache: true
           python-version: ${{ matrix.python-version }}
-      - uses: extractions/setup-just@v3
+      - uses: extractions/setup-just@e33e0265a09d6d736e2ee1e0eb685ef1de4669ff # v3
       - uses: mongodb-labs/drivers-evergreen-tools@master
         with:
           local-atlas: '1'
@@ -66,17 +66,17 @@ jobs:
         persist-credentials: false
         fetch-depth: 0
     - name: Install uv
-      uses: astral-sh/setup-uv@v5
+      uses: astral-sh/setup-uv@d4b2f3b6ecc6e67c4457f6d3e41ec42d3d0fcb86 # v5
       with:
         enable-cache: true
         python-version: ${{ env.MIN_PYTHON }}
-    - uses: extractions/setup-just@v3
+    - uses: extractions/setup-just@e33e0265a09d6d736e2ee1e0eb685ef1de4669ff # v3
     - name: Install uv
-      uses: astral-sh/setup-uv@v5
+      uses: astral-sh/setup-uv@d4b2f3b6ecc6e67c4457f6d3e41ec42d3d0fcb86 # v5
       with:
         enable-cache: true
         python-version: ${{ env.MIN_PYTHON }}
-    - uses: extractions/setup-just@v3
+    - uses: extractions/setup-just@e33e0265a09d6d736e2ee1e0eb685ef1de4669ff # v3
     - uses: mongodb-labs/drivers-evergreen-tools@master
       with:
         local-atlas: '1'
diff --git a/.github/workflows/zizmor.yml b/.github/workflows/zizmor.yml
@@ -18,15 +18,15 @@ jobs:
         with:
           persist-credentials: false
       - name: Setup Rust
-        uses: actions-rust-lang/setup-rust-toolchain@v1
+        uses: actions-rust-lang/setup-rust-toolchain@9d7e65c320fdb52dcd45ffaa68deb6c02c8754d9 # v1
       - name: Get zizmor
         run: cargo install zizmor
       - name: Run zizmor
         run: zizmor --format sarif . > results.sarif
         env:
           GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       - name: Upload SARIF file
-        uses: github/codeql-action/upload-sarif@v3
+        uses: github/codeql-action/upload-sarif@28deaeda66b76a05916b6923827895f2b14ab387 # v3
         with:
           sarif_file: results.sarif
           category: zizmor
