tox-gh
tox-gh 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
- detects which environment to run based on configurations and
- provides utilities such as grouping log lines.
Usage
- Add configurations under
[gh]section along with your tox configuration. - Install
tox-ghpackage in the GitHub Actions workflow before runningtoxcommand.
Examples
Basic Example
Add [gh] section to the same file as tox configuration. If you're using tox.ini:
[gh]
python =
3.6 = py36
3.7 = py37
3.8 = py38
3.9 = py39, type
This will run different set of tox environments on different python versions set up via GitHub setup-python action:
- on Python 3.6 job, tox runs
py36environment, - on Python 3.7 job, tox runs
py37environment, - on Python 3.8 job, tox runs
py38environment, - in Python 3.9 job, tox runs
py39andtypeenvironments.
Workflow Configuration
.github/workflows/check.yml:
name: check
on:
push:
pull_request:
schedule:
- cron: "0 8 * * *"
jobs:
test:
name: test ${{ matrix.py }} - ${{ matrix.os }}
runs-on: ${{ matrix.os }}-latest
strategy:
fail-fast: false
matrix:
os:
- Ubuntu
- Windows
- MacOs
py:
- "3.10.0-rc.1"
- "3.9"
- "3.8"
- "3.7"
- "3.6"
steps:
- name: Setup python for test ${{ matrix.py }}
uses: actions/[email protected]
with:
python-version: ${{ matrix.py }}
- uses: actions/[email protected]
- name: Install tox-gh
run: python -m pip install tox-gh
- name: Setup test suite
run: tox4 r -vv --notest
- name: Run test suite
run: tox4 r --skip-pkg-install
env:
PYTEST_ADDOPTS: "-vv --durations=10"
FAQ
- When a list of environments to run is specified explicitly via
-eoption orTOXENVenvironment variabletox-ghrespects the given environments and simply runs the given environments without enforcing its configuration. - The plugin only activates if the environment variable
GITHUB_ACTIONSistrue.
![[pre-commit.ci] pre-commit autoupdate](https://avatars.githubusercontent.com/in/68672?v=4)
4 Jan 02, 2022
3 Aug 05, 2022
12.5k Jan 07, 2023
1 Jan 30, 2022
336 Dec 15, 2022
31 Dec 25, 2022
2 May 17, 2022
5.9k Dec 31, 2022
420 Dec 11, 2022
49 Dec 08, 2022
14 Sep 28, 2022
1 Dec 15, 2021
1 May 28, 2022
1 Dec 19, 2021
651 Dec 29, 2022
1 Jun 08, 2022
201 Dec 30, 2022
1 Feb 10, 2022
36 Dec 09, 2022
9 Aug 10, 2022