tox-gh

library1.7.1pypypiunverified

Seamless integration of tox into GitHub Actions. Automatically detects GitHub Actions environment variables for parallel tox execution and job summaries. Latest version: 1.7.1, requires Python >=3.10. Release cadence: irregular.

devops testing

pip install tox-gh

github ↗package ↗docs ↗

INSTALL

IMPORT

SIG · TOX-GH

tox-gh

devopspythonv1.7.1

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Minimal GitHub Actions workflow using tox-gh. The plugin is activated automatically; no import or special configuration needed.

name: CI on: [push, pull_request] jobs: test: runs-on: ubuntu-latest strategy: matrix: python: ['3.10', '3.11', '3.12'] steps: - uses: actions/checkout@v4 - uses: actions/setup-python@v5 with: python-version: ${{ matrix.python }} - name: Install dependencies run: pip install tox tox-gh - name: Run tox run: tox

tox --version

Debug

Known issues

breakingDrop of Python 3.9 support in v1.6.0. Upgrade to Python >=3.10 to use tox-gh >=1.6.0.

fix

Update your CI runners to use Python 3.10 or later.

affects: >=1.6.0

gotchatox-gh only works inside GitHub Actions. It will fail or misbehave if run locally or in other CI systems.

fix

Provide fallback: use condition like `if: ${{ github.actions }}` or check `GITHUB_ACTIONS` env var in scripts.

affects: all

deprecatedThe `tox-gh-action` is deprecated in favor of `tox-gh`. Use the pip-installable plugin approach with a GitHub Actions workflow step.

fix

Remove usage of `tox-gh-action` composite action; just `pip install tox tox-gh` and run `tox`.

affects: >=1.0

gotchaIf you set `tox_envdir` or customize tox directory, tox-gh may not detect the environment correctly for parallelism or summary.

fix

Avoid overriding `tox_envdir` or `work_dir` when using tox-gh.

affects: all

Errors

Common errors & fixes

tox-gh: GITHUB_ENV not set

tox-gh is being run outside GitHub Actions (e.g., locally).

fix

Run only in GitHub Actions workflow; for local testing, remove tox-gh or set a dummy GITHUB_ENV variable.

AttributeError: module 'tox' has no attribute 'plugins'

Using an outdated version of tox that doesn't support the plugin system (tox <4.0).

fix

Upgrade tox to version >=4.0: `pip install --upgrade tox>=4.0`.

Error: The `tox-gh` plugin is not compatible with this version of tox. Please update tox.

Version mismatch between tox-gh and tox.

fix

Ensure both tox and tox-gh are up-to-date: `pip install --upgrade tox tox-gh`.

Upgrade

Version history

1.7.1latest on PyPI · released Feb 23, 2026

Audit

Dependencies

toxrequiredtox-gh is a plugin for tox; tox must be installed.

Agent activity

12 hits · last 30 days

node

Resources

githubhttps://github.com/tox-dev/tox-gh#tox-gh ↗

packagehttps://pypi.org/project/tox-gh/ ↗

docshttps://github.com/tox-dev/tox-gh#tox-gh ↗