This repo contains a set of reusable workflows for use in GitHub Actions.

They are used by repos in the pyapp-kit organization, but you may use them as well if you find them useful for your own projects.

1. test-pyrepo.yml - use to run tests for your python package
2. test-dependents.yml - use to test that updates to your package don't break another package that depends on your package

uses: pyapp-kit/workflows/.github/workflows/test-pyrepo.yml@v2

Standard workflow to setup python and test a python package, in the following order:

1. Checks out the repo using actions/checkout with inputs.fetch-depth
2. Runs actions/setup-python with python-version
3. If inputs.qt != '': Installs Qt libs using tlambert03/setup-qt-libs
4. Installs dependencies using pip install .[extras]
5. Runs coverage run -m pytest ${{inputs.pytest-args}} unless overridden.
   • If inputs.qt != '': Runs headlessly using aganders3/headless-gui
6. Uploads coverage reports using codecov/codecov-action
7. If report-failures != '' Opens an issue to report failures. Useful for cron jobs for pre-release testing.

(All inputs are optional)

Secrets:

See complete up-to-date list of options in test-pyrepo.yml

You can mix and match the inputs to suit your needs. But here are some common patterns.

name: CI jobs: run_tests: uses: pyapp-kit/workflows/.github/workflows/test-pyrepo.yml@v2 with: os: ${{ matrix.os }} python-version: ${{ matrix.python-version }} extras: 'test' # this is the default... but you can specify others strategy: fail-fast: false matrix: os: [ubuntu-latest, macos-latest, windows-latest] python-version: ["3.10", "3.11", "3.12"]

Note that the default value for report-failures is ${{ github.event_name == 'schedule' }}, so you don't need to specify it unless you want to override the default. However, you may wish to use pip-install-pre-release: ${{ github.event_name == 'schedule' }} to test pre-release versions when triggered by a cron job.

name: CI on: schedule: - cron: "0 0 * * *" jobs: run_tests: uses: pyapp-kit/workflows/.github/workflows/test-pyrepo.yml@v2 with: os: ${{ matrix.os }} python-version: ${{ matrix.python-version }} # Test pre-release versions when triggered by a schedule # and open an issue if the tests fail pip-install-pre-release: ${{ github.event_name == 'schedule' }} strategy: matrix: os: [ubuntu-latest, macos-latest, windows-latest] python-version: ["3.10", "3.11", "3.12"]

Use the qt input to:

• install the specified Qt binding
• install libraries on linux using tlambert03/setup-qt-libs
• run headless tests using aganders3/headless-gui

name: CI jobs: run_tests: uses: pyapp-kit/workflows/.github/workflows/test-pyrepo.yml@v2 with: os: ${{ matrix.os }} python-version: ${{ matrix.python-version }} qt: ${{ matrix.qt }} strategy: matrix: os: [ubuntu-latest, macos-latest, windows-latest] python-version: ["3.10", "3.11", "3.12"] qt: ["", "PyQt6", "PySide6"]

Because codecov can often fail, you might want to combine all reports and upload in a single step. For this, change the coverage-upload input to artifact and add a separate job to upload the coverage report using upload-coverage.yml.

name: CI jobs: tests: uses: pyapp-kit/workflows/.github/workflows/test-pyrepo.yml@v2 with: os: ${{ matrix.os }} python-version: ${{ matrix.python-version }} # changing this to "artifact" prevents uploading to codecov here, # instead it uploads an artifact with the coverage data coverage-upload: artifact strategy: fail-fast: false matrix: os: [ubuntu-latest, macos-latest, windows-latest] python-version: ["3.10", "3.11", "3.12"] # now add an additional job to combine and upload the coverage upload_coverage: if: always() needs: [tests] uses: pyapp-kit/workflows/.github/workflows/upload-coverage.yml@v2 secrets: codecov_token: ${{ secrets.CODECOV_TOKEN }}

uses: pyapp-kit/workflows/.github/workflows/test-dependents.yml@v2

This workflow is useful when your package is a dependency of other packages, and you would like to ensure that your changes don't break those packages.

1. Checks out the "host" repo (the repo using this workflow) using actions/checkout.
2. Checks out dependency-repo @ dependency-ref using actions/checkout.
3. Runs actions/setup-python with python-version
4. If inputs.qt != '': Installs Qt libs using tlambert03/setup-qt-libs
5. Installs dependencies for dependency-repo followed by the host repo.
6. Runs pytest inputs.pytest-args (add specific paths or -k flags here)
   • If inputs.qt != '': Runs headlessly using aganders3/headless-gui

(Only dependency-repo is required)

Here's an example where package Package B depends on Package A.

This workflow would go into Package A's repository, and tests that changes made to Package A don't break Package B.

name: CI jobs: test-package-b: uses: pyapp-kit/workflows/.github/workflows/test-dependents.yml@v2 with: os: ${{ matrix.os }} python-version: ${{ matrix.python-version }} dependency-repo: some-org/package-b dependency-ref: ${{ matrix.package-b-version }} dependency-group: "test" # Group to use when installing dependency-repo. strategy: matrix: os: [ubuntu-latest, windows-latest] python-version: ["3.10", "3.12"] package-b-version: ["", "v0.5.0"]

uses: pyapp-kit/workflows/.github/workflows/upload-coverage.yml@v2

This workflow is designed to be used in conjunction with the test-pyrepo.yml workflow when the coverage-upload input is set to artifact.

Secrets: