chore: rework release workflow to reuse the tests workflow.

ferringb · ferringb · commit c8ffbf0a50bc · 2025-11-21T17:23:11.000+01:00
High level: * add test-release target that is wired against test-pypi. This is currently against a project I control (including OIDC) but that's required for the dev work of this. I'll unwind/transfer after. * release process now runs the full test suite. This is being done for obvious reasons, but also since the previous setup hid a bug in the man page generation pathway. * to support that, test workflow was rewired to use a custom action that can pivot between git cloning, or using a git artifact (IE, the release tarball being tested). https://github.com/ferringb/gh-actions/blob/main/get-source/action.yml shows why an action encapsulating this was necessary. lesser stuff: * disable format check for releases. If we've tagged, by the time the tag is in github web kind of just have to roll with it. Signed-off-by: Brian Harring <ferringb@gmail.com>
diff --git a/.github/workflows/_publish.yml b/.github/workflows/_publish.yml
@@ -0,0 +1,47 @@
+name: publish
+
+on:
+  workflow_call:
+    inputs:
+      is_test:
+        type: boolean
+        required: true
+        default: true
+      release-artifact-ids:
+        type: string
+        required: true
+        description: what artifact ids to fetch.  Comma delimited.
+      artifact-runner-id:
+        type: string
+        required: true
+
+
+jobs:
+  publish:
+    environment: ${{ inputs.is_test && 'test-release' || 'release' }}
+    permissions:
+      id-token: write # Used to authenticate to PyPI via OIDC
+      contents: read
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Download artifacts
+      uses: actions/download-artifact@v5
+      with:
+        artifact-ids: ${{ inputs.release-artifact-ids }}
+        artifact-runner: ${{ inputs.artifact-runner-id }}
+
+    - name: Publish github source
+      if: ${{ ! inputs.is_test }}
+      uses: softprops/action-gh-release@v2
+      with:
+        files: '*.tar.*'
+        fail_on_unmatched_files: true
+        draft: true
+
+    - name: Publish to PyPi server
+      uses: pypa/gh-action-pypi-publish@release/v1.13
+      with:
+        packages-dir: ./
+        repository-url: https://${{ inputs.is_test && 'test.pypi.org' || 'pypi.org' }}/legacy
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -2,25 +2,28 @@ name: release
 
 on:
   push:
-    branches: [deploy]
+    branches: [deploy, release-test-pypi]
     tags: [v*]
   workflow_dispatch:
 
+
 jobs:
-  build-and-deploy:
+  build:
     runs-on: ubuntu-latest
-    environment: release
+    outputs:
+      release-artifact-id: ${{ steps.upload-release.outputs.artifact-id }}
+      wheel-artifact-id: ${{ steps.upload-wheel.outputs.artifact-id }}
+      artifact-runner: ${{ github.job }}
 
     permissions:
-      id-token: write # Used to authenticate to PyPI via OIDC
-
       contents: write # Used to authenticate github release publish
 
     steps:
     - name: Checkout code
-      uses: actions/checkout@v4
+      uses: actions/checkout@v5
 
     - name: Reject any VCS dependencies
+      if: false
       shell: python
       run: |
         import re, tomllib
@@ -41,12 +44,7 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install build ".[test,doc]"
-
-    - name: Test with pytest
-      env:
-        PY_COLORS: 1 # forcibly enable pytest colors
-      run: pytest
+        pip install build ".[doc]"
 
     - name: Build sdist
       run: |
@@ -60,21 +58,42 @@ jobs:
     - name: Output dist file info
       run: |
         sha512sum dist/*
+        echo ::group::Release contents
         tar -ztf dist/*.tar.gz | sort
+        echo ::endgroup::
+        echo ::group::All generated content in dist
+        find .
+        echo ::endgroup::
 
-    - uses: actions/upload-artifact@v4
+    - name: Upload wheel
+      id: upload-wheel
+      uses: actions/upload-artifact@v5
       with:
-        name: results
-        path: dist/*
+        name: wheel-release
+        path: dist/*.whl
+        if-no-files-found: error
 
-    - name: publish
-      uses: pypa/gh-action-pypi-publish@release/v1
-      if: startsWith(github.ref, 'refs/tags/')
-
-    - name: Create GitHub release
-      uses: softprops/action-gh-release@v1
-      if: startsWith(github.ref, 'refs/tags/')
+    - name: Upload release source
+      id: upload-release
+      uses: actions/upload-artifact@v5
       with:
-        files: dist/*.tar.gz
-        fail_on_unmatched_files: true
-        draft: true
+        name: release-source
+        path: dist/*.tar.gz
+        if-no-files-found: error
+
+  test:
+    uses: ./.github/workflows/test.yml
+    needs: [build]
+    with:
+        release-artifact-id: ${{ needs.build.outputs.release-artifact-id }}
+        artifact-runner-id: ${{ github.runner }}
+        format-check: false
+
+  publish:
+    if: github.ref_type == 'tag' || ( github.ref_type == 'branch' || github.ref_name == 'release-test-pypi' )
+    needs: [build, test]
+    uses: ./.github/workflows/_publish.yml
+    with:
+      is_test: ${{ github.ref_type == 'tag' }}
+      release-artifact-ids: ${{ needs.build.outputs.release-artifact-id }},${{ needs.build.outputs.wheel-artifact-id }}
+      artifact-runner-id: ${{ github.runner }}
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -5,7 +5,21 @@ on:
     branches-ignore: [deploy]
   pull_request:
     branches: [master]
-
+  workflow_call:
+    inputs:
+      release-artifact-id:
+        required: false
+        type: string
+        default: ''
+        description: The artifact-id to run the tests against.
+      artifact-runner-id:
+        required: false
+        type: string
+        default: ''
+      format-check:
+        type: boolean
+        default: true
+        description: Run the ruff format check.  This should only be disabled for releases.
 jobs:
   build:
     runs-on: ${{ matrix.os }}
@@ -32,8 +46,11 @@ jobs:
       fail-fast: false
 
     steps:
-    - name: Checkout code
-      uses: actions/checkout@v4
+    - name: Checkout pkgcore
+      uses: ferringb/gh-actions/get-source@v1
+      with:
+        artifact-id: ${{ inputs.release-artifact-id }}
+        artifact-runner-id: ${{ inputs.artifact-runner-id }}
 
     - name: Pin dependencies to minimal versions
       if: ${{ matrix.deps == 'minimal-deps' }}
@@ -77,12 +94,14 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Checkout pkgcore
-      uses: actions/checkout@v4
+      uses: ferringb/gh-actions/get-source@v1
       with:
+        artifact-id: ${{ inputs.release-artifact-id }}
+        artifact-runner-id: ${{ inputs.artifact-runner-id }}
         path: pkgcore
 
     - name: Checkout pkgcheck
-      uses: actions/checkout@v4
+      uses: actions/checkout@v5
       with:
         repository: pkgcore/pkgcheck
         path: pkgcheck
@@ -99,7 +118,7 @@ jobs:
     - name: Install pip dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install -e "./pkgcore"
+        pip install "./pkgcore"
         pip install "./pkgcheck[test]"
 
     - name: Test with pytest
@@ -112,12 +131,13 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Checkout pkgcore
-      uses: actions/checkout@v4
+      uses: ferringb/gh-actions/get-source@v1
       with:
+        artifact-id: ${{ inputs.release-artifact-id }}
+        artifact-runner-id: ${{ inputs.artifact-runner-id }}
         path: pkgcore
-
     - name: Checkout pkgdev
-      uses: actions/checkout@v4
+      uses: actions/checkout@v5
       with:
         repository: pkgcore/pkgdev
         path: pkgdev
@@ -134,7 +154,7 @@ jobs:
     - name: Install pip dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install -e "./pkgcore"
+        pip install "./pkgcore"
         pip install "./pkgdev[test]"
 
     - name: Test with pytest
@@ -145,9 +165,10 @@ jobs:
 
   format:
     runs-on: ubuntu-latest
+    if: inputs.format-check
     steps:
-    - name: Checkout code
-      uses: actions/checkout@v4
+    - name: Checkout pkgcore
+      uses: actions/checkout@v5
     - uses: astral-sh/ruff-action@v3
       with:
         args: "format --check --diff"
@@ -156,8 +177,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Checkout pkgcore
-      uses: actions/checkout@v4
+      uses: ferringb/gh-actions/get-source@v1
       with:
+        artifact-id: ${{ inputs.release-artifact-id }}
+        artifact-runner-id: ${{ inputs.artifact-runner-id }}
         path: pkgcore
 
     - name: Checkout gentoo
@@ -174,7 +197,7 @@ jobs:
     - name: Install pip dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install -e "./pkgcore"
+        pip install "./pkgcore"
 
     - name: Run pmaint regen
       working-directory: ./gentoo
