tox-gh-actions
tox-gh-actions is a tox plugin which helps running tox on GitHub Actions with multiple different Python versions on multiple workers in parallel. This project is inspired by tox-travis.
Features
When running tox on GitHub Actions, tox-gh-actions
- detects which environment to run based on configurations and
- privides utilities such as grouping log lines.
Usage
-
Add configurations under
[gh-actions]
section along with tox's configuration.- It will be
pyproject.toml
,tox.ini
, orsetup.cfg
. See tox's documentation for more details.
- It will be
-
Install
tox-gh-actions
package in the GitHub Actions workflow before runningtox
command.
Examples
Basic Example
The following configuration will create 5 jobs when running the workflow on GitHub Actions.
- On Python 2.7 job, tox runs
py27
environment - On Python 3.6 job, tox runs
py36
environment - On Python 3.7 job, tox runs
py37
environment - On Python 3.8 job, tox runs
py38
andmypy
environments - On Python 3.9 job, tox runs
py39
environment
tox-gh-actions Configuration
Add [gh-actions]
section to the same file as tox's cofiguration.
If you're using tox.ini
:
[tox]
envlist = py27, py36, py37, py38, py39, mypy
[gh-actions]
python =
2.7: py27
3.6: py36
3.7: py37
3.8: py38, mypy
3.9: py39
[testenv]
...
If you're using setup.cfg
:
[tox:tox]
envlist = py27, py36, py37, py38, py39, mypy
[gh-actions]
python =
2.7: py27
3.6: py36
3.7: py37
3.8: py38, mypy
3.9: py39
[testenv]
...
If you're using pyproject.toml
:
[tool.tox]
legacy_tox_ini = """
[tox]
envlist = py27, py36, py37, py38, py39, mypy
[gh-actions]
python =
2.7: py27
3.6: py36
3.7: py37
3.8: py38, mypy
3.9: py39
[testenv]
"""
Workflow Configuration
.github/workflows/<workflow>.yml
:
name: Python package
on: [push]
jobs:
build:
runs-on: ubuntu-latest
strategy:
max-parallel: 5
matrix:
python-version: [2.7, 3.6, 3.7, 3.8, 3.9]
steps:
- uses: actions/checkout@v1
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v2
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install tox tox-gh-actions
- name: Test with tox
run: tox
Advanced Examples
Factor-Conditional Settings: Python Version
The following configuration will create 2 jobs when running the workflow on GitHub Actions.
- On Python 2.7 job, tox runs
py27-django111
environment - On Python 3.7 job, tox runs
py37-django111
andpy37-django20
environments
tox.ini
:
[tox]
envlist = py27-django{111}, py37-django{111,20}
[gh-actions]
python =
2.7: py27
3.7: py37
[testenv]
...
PyPy is also supported in the python
configuration key.
tox.ini
:
[tox]
envlist = py27, py38, pypy2, pypy3
[gh-actions]
python =
2.7: py27
3.8: py38, mypy
pypy2: pypy2
pypy3: pypy3
[testenv]
...
Factor-Conditional Settings: Environment Variable
You can also use environment variable to decide which environment to run. The following is an example to install different dependency based on platform. It will create 12 jobs when running the workflow on GitHub Actions.
- On Python 2.7/ubuntu-latest job, tox runs
py27-linux
environment - On Python 3.5/ubuntu-latest job, tox runs
py35-linux
environment - and so on.
.github/workflows/<workflow>.yml
:
name: Python package
on: [push]
jobs:
build:
runs-on: ${{ matrix.platform }}
strategy:
max-parallel: 4
matrix:
platform: [ubuntu-latest, macos-latest, windows-latest]
python-version: [2.7, 3.6, 3.7, 3.8]
steps:
- uses: actions/checkout@v1
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v2
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install tox tox-gh-actions
- name: Test with tox
run: tox
env:
PLATFORM: ${{ matrix.platform }}
tox.ini
:
[tox]
envlist = py{27,36,37,38}-{linux,macos,windows}
[gh-actions]
python =
2.7: py27
3.8: py38, mypy
pypy2: pypy2
pypy3: pypy3
[gh-actions:env]
PLATFORM =
ubuntu-latest: linux
macos-latest: macos
windows-latest: windows
[testenv]
deps =
<common dependency>
linux: <Linux specific deps>
macos: <macOS specific deps>
windows: <Windows specific deps>
...
See tox's documentation about factor-conditional settings as well.
Overriding Environments to Run
Changed in 2.0: When a list of environments to run is specified explicitly via -e
option or TOXENV
environment variable (tox's help),
tox-gh-actions respects the given environments and simply runs the given environments without enforcing its configuration.
Before 2.0, tox-gh-actions was always enforcing its configuration even when a list of environments is given explicitly.
Investigation
tox-gh-actions writes log messages using tox.reporter
.
This is handy for understanding behavior of tox-gh-actions
and when debugging tox-gh-actions.
To see the messages, please run tox -vv
.