Shared GitHub Workflows

These are shared GitHub workflows used by my repositories.

poetry-build-and-test

Implements the standard build and test process for my Python libraries and utilities.

Example workflow:

name: Test Suite
on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - main
  schedule:
    - cron: '35 19 10 * *'  # 10th of the month at 7:35pm UTC
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
jobs:
  build-and-test:
    uses: Elmeric/my-gha-workflows/.github/workflows/poetry-build-and-test.yml@v1
    secrets: inherit
    with:
      matrix-os-version: "[ 'ubuntu-latest', 'macos-latest', 'windows-latest' ]"
      matrix-python-version: "[ '3.7', '3.8', '3.9', '3.10', '3.11' ]"
      poetry-version: "1.2.2"

The following input parameters are accepted:

Input	Type	Required	Description
matrix-os-version	String	Yes	JSON array as a string, a list of operating systems for the matrix build
matrix-python-version	String	Yes	JSON array as a string, a list of Python versions for the matrix build
poetry-version	String	Yes	Version of Poetry to use for the build (>=1.2.0)
poetry-cache-venv	Boolean	No	Whether to cache the Poetry virtualenv; defaults to true
poetry-cache-install	Boolean	No	Whether to cache the Poetry install; defaults to true
timeout-minutes	Number	No	Job timeout in minutes
test-suite-command	String	No	Shell command used to execute the test suite

The default test suite command for v1 of the shared workflow is:

./run suite

If you need a different command, and it's more complicated than a single line like this, it's best to extract a script to somewhere in the repository and invoke script that in the test-suite-command. However, in any repo that follows the standard run script convention, it's best just to adjust the suite task to do what you need.

The matrix versions are passed in as JSON strings because GitHub Actions does not support workflow inputs of type array. As of this writing (October of 2022), passing in JSON like this is the most highly rated solution solution.