Install & Compatibility
Where this runs
tested against v3.5.0 · pip install
no network on importno background threads
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
muslpy 3.10–3.95 runs
installs and imports cleanly · install 0.0s · import 0.000s · 32.1MB
glibcpy 3.10–3.95 runs
installs and imports cleanly · install 3.1s · import 0.000s · 33MB
30MB installed
● package 30MB
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
tox-gh-actions
✓ Install `tox-gh-actions` alongside `tox`. It is automatically loaded by `tox`.
As a `tox` plugin, `tox-gh-actions` is not typically imported directly in user Python code. It extends `tox`'s functionality via its entry points.
This GitHub Actions workflow demonstrates how to use `tox-gh-actions`. It sets up a matrix of Python versions, installs `tox` and `tox-gh-actions`, and then simply runs `tox`. The plugin automatically detects the Python version from the `python-version` matrix variable and maps it to the appropriate `tox` environment.
name: Test
on: [push, pull_request]
jobs:
test:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: ["3.8", "3.9", "3.10", "3.11"]
steps:
- uses: actions/checkout@v4
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install tox tox-gh-actions
- name: Run tox
run: tox
Debug
Known issues
breakingVersion 3.0.0 introduced breaking changes for users upgrading from tox v3 to tox v4. tox-gh-actions v3.x is compatible with tox v4, while tox-gh-actions v2.x is for tox v3.fixIf you are using tox v4, ensure you are on tox-gh-actions v3.0.0 or later. If you are using tox v3, you must stick to tox-gh-actions v2.x.
affects: >=3.0.0 (when migrating from tox v3 to v4)
gotchaWhen using `tox`'s `requires` configuration in your `tox.ini` file, ensure `tox-gh-actions` is explicitly listed to guarantee the plugin is loaded correctly.fixAdd `requires = tox-gh-actions` to your `tox.ini` file, usually at the top-level `[tox]` section or within specific environment configurations if needed.
affects: All versions
gotchaEarly 3.1.x releases (3.1.0, 3.1.1, 3.1.2) had issues with `tox -p` (parallel execution) which could lead to `TypeError` or incorrect warning messages. These were resolved in subsequent patch releases.fixUpgrade to `tox-gh-actions` v3.1.3 or later to ensure stable behavior with parallel `tox` execution (`tox -p`).
affects: 3.1.0, 3.1.1, 3.1.2
Upgrade
Version history
3.5.0latest on PyPI · released Oct 22, 2025
Audit
Dependencies
toxrequired`tox-gh-actions` is a plugin for `tox` and requires it to function. It should be installed in the same Python environment as `tox`.