tox-gh is a tox plugin which helps running tox on GitHub Actions with multiple different Python versions on multiple workers in parallel.
When running tox on GitHub Actions, tox-gh
- detects which environment to run based on configurations and
- provides utilities such as grouping log lines.
- Add configurations under
[gh]
section along with your tox configuration. - Install
tox-gh
package in the GitHub Actions workflow before runningtox
command.
Add [gh]
section to the same file as tox configuration. If you're using tox.ini
:
[gh]
python =
3.12 = py312
3.11 = py311, type
3.10 = py310
3.9 = py39
3.8 = py38
3.7 = py37
This will run different set of tox environments on different python versions set up via GitHub setup-python
action:
- on Python 3.7 job, tox runs
py37
environment, - on Python 3.8 job, tox runs
py38
environment, - on Python 3.9 job, tox runs
py39
environment, - on Python 3.10 job, tox runs
py310
environment, - in Python 3.11 job, tox runs
py311
andtype
environments, - on Python 3.12 job, tox runs
py312
environment.
.github/workflows/check.yml
:
name: check
on:
push:
pull_request:
schedule:
- cron: "0 8 * * *"
concurrency:
group: check-${{ github.ref }}
cancel-in-progress: true
jobs:
test:
name: test with ${{ matrix.py }} on ${{ matrix.os }}
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
py:
- "3.12"
- "3.11"
- "3.10"
- "3.9"
- "3.8"
- "3.7"
os:
- ubuntu-latest
- macos-latest
- windows-latest
steps:
- uses: actions/checkout@v3
with:
fetch-depth: 0
- name: Setup python for test ${{ matrix.py }}
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.py }}
- name: Install tox
run: python -m pip install tox-gh>=1.2
- name: Setup test suite
run: tox -vv --notest
- name: Run test suite
run: tox --skip-pkg-install
- When a list of environments to run is specified explicitly via
-e
option orTOXENV
environment variabletox-gh
respects the given environments and simply runs the given environments without enforcing its configuration. - The plugin only activates if the environment variable
GITHUB_ACTIONS
istrue
.