CI: rework caching and build/test environment

.github/actions/common-setup/action.yml

@@ -9,46 +9,42 @@ inputs:
 runs:
   using: "composite"
   steps:
-    - name: Set up Python 🐍
-      uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
-      with:
-        python-version: ${{ inputs.python_version }}
+  - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
 
-    - name: Default shell
-      run: |
-        if [ "$RUNNER_OS" == "Linux" ]; then
-              echo shellos=bash >> $GITHUB_ENV
-        elif [ "$RUNNER_OS" == "Windows" ]; then
-              echo shellos=powershell >> $GITHUB_ENV
-        else
-              echo "$RUNNER_OS not supported"
-              exit 1
-        fi
-      shell: bash
+  - name: Set up Python 🐍
+    id: setup-python
+    uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548 # v6.1.0
+    with:
+      python-version: ${{ inputs.python_version }}
+      pip-install: poetry
+      cache: 'pip'
 
-    - name: Install Poetry
-      uses: abatilo/actions-poetry@65c61eae400c65c9510a584af85138c1ae19bbc0 # v3.0.2
-      with:
-        poetry-version: 2.1.3
+  - name: Setup a local virtual environment
+    run: |
+      poetry config virtualenvs.create true --local
+      poetry config virtualenvs.in-project true --local
+    shell: bash
 
-    # Cache your dependencies (i.e. all the stuff in your `pyproject.toml`). Note the cache
-    # key: if you're using multiple Python versions, or multiple OSes, you'd need to include
-    # them in the cache key. I'm not, so it can be simple and just depend on the poetry.lock.
-    - name: cache deps
-      id: cache-deps
-      uses: actions/cache@5a3ec84eff668545956fd18022155c47e93e2684 # v4.2.3
-      with:
-        path: ~/.cache/pypoetry
-        key: pydeps-${{ inputs.python_version }}-${{ env.shellos }}-${{ hashFiles('**/poetry.lock') }}
+  - name: Default shell
+    run: |
+      if [ "$RUNNER_OS" == "Linux" ]; then
+            echo shellos=bash >> $GITHUB_ENV
+      elif [ "$RUNNER_OS" == "Windows" ]; then
+            echo shellos=powershell >> $GITHUB_ENV
+      else
+            echo "$RUNNER_OS not supported"
+            exit 1
+      fi
+    shell: bash
 
-    # Install dependencies. `--no-root` means "install all dependencies but not the project
-    # itself", which is what you want to avoid caching _your_ code. The `if` statement
-    # ensures this only runs on a cache miss.
-    - name: Install dependencies
-      run: poetry install --no-interaction --no-root
-      shell: ${{ env.shellos }}
-      if: steps.cache-deps.outputs.cache-hit != 'true'
+  - uses: actions/cache@9255dc7a253b0ccc959486e2bca901246202afeb # v5.0.1
+    id: cache-venv
+    name: Cache definition for Poetry (Python ${{ inputs.python_version }}, ${{ env.shellos }})
+    with:
+      path: ./.venv
+      key: venv-${{ hashFiles('poetry.lock') }}-py${{ inputs.python_version }}-${{ env.shellos }}
 
-    - name: Install project
-      run: poetry install --no-interaction
-      shell: ${{ env.shellos }}
+  - name: Install project
+    if: steps.cache-venv.outputs.cache-hit != 'true'
+    run: poetry install --no-interaction
+    shell: ${{ env.shellos }}

.github/workflows/ci.yml

@@ -16,37 +16,49 @@ jobs:
     strategy:
       matrix:
         task: ["fmt", "lint"]
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
 
     steps:
-      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
 
       - uses: ./.github/actions/common-setup
+        with:
+          python_version: ${{ matrix.python-version }}
 
-      - name: check code
+      - name: Check code (${{ matrix.task }})
+        continue-on-error: true
         run: poetry run poe ${{ matrix.task }}
 
   build:
     needs: code_checks
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
 
     steps:
-      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
 
       - uses: ./.github/actions/common-setup
+        with:
+          python_version: ${{ matrix.python-version }}
 
       - name: Build 🔨
         run: poetry build
 
   build_windows:
     needs: code_checks
     runs-on: windows-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
 
     steps:
-      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
 
       - uses: ./.github/actions/common-setup
         with:
-          python_version: 3.13
+          python_version: ${{ matrix.python-version }}
 
       - name: Add entrypoint to bypass issue with relative imports in PyInstaller
         run: powershell -Command 'Invoke-WebRequest https://gist.githubusercontent.com/Wenzel/e38d227d94f16e026b3aed03ea6a6661/raw/383ec56d62c58e444f6c5962ee6940a5c583d341/stub.py -OutFile stub.py'
@@ -56,6 +68,7 @@ jobs:
         shell: bash
 
       - name: Upload Windows release artefact
+        if: ${{ matrix.python-version == 3.13 }}
         uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
         with:
           name: checksec.exe
@@ -67,21 +80,25 @@ jobs:
         shell: bash
 
   test:
-    needs: build
+    needs: ['build', 'build_windows']
+
     strategy:
       matrix:
         os: [ubuntu-latest, windows-latest]
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
     runs-on: ${{ matrix.os }}
     defaults:
       run:
         shell: bash
 
     steps:
-      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
         with:
           submodules: true
 
       - uses: ./.github/actions/common-setup
+        with:
+          python_version: ${{ matrix.python-version }}
 
       - name: Run tests
         run: poetry run poe test_e2e
@@ -97,7 +114,7 @@ jobs:
     # push on master and tag is 'v*'
     if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v')
     steps:
-      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
       - name: Get the version
         id: get_version
         run: echo ::set-output name=VERSION::${GITHUB_REF/refs\/tags\//}
@@ -122,7 +139,7 @@ jobs:
       # the deploy action below depends on a checkout of the repo
       # otherwise it fails trying to remote the 'origin' remote
       # https://github.com/JamesIves/github-pages-deploy-action/issues/335
-      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
 
       # download artifacts
       - uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4.3.0
@@ -144,7 +161,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
 
       - uses: ./.github/actions/common-setup
 

pyproject.toml

@@ -43,7 +43,7 @@ branch = true
 
 [tool.poe.tasks]
 fmt = "black ."
-flake8 = "flake8 --show-source --statistics"
+flake8 = "flake8 --show-source --statistics --extend-exclude .venv,dist ."
 isort = "isort --line-length 120 --profile black ."
 lint = ["flake8", "isort"]
 mypy = "mypy ."