Skip to content

Commit

Permalink
Document repeating the env names in .tox and .github/workflows/main.yml
Browse files Browse the repository at this point in the history
  • Loading branch information
encukou committed Aug 11, 2020
1 parent ceb4dec commit 5befc32
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
![Tox sanity test](https://github.com/fedora-python/tox-github-action/workflows/Tox%20sanity%20test/badge.svg)
![Run Tox tests](https://github.com/fedora-python/tox-github-action/workflows/Run%20Tox%20tests/badge.svg)

# Tox Github Action

Expand All @@ -20,9 +20,14 @@ Add the action to your workflow file, e.g. `.github/workflows/main.yml`,
after checking out your code.

You can use the `matrix` strategy to run with multiple Tox environments.

For an example, see [this project's workflow](.github/workflows/main.yml).
Unfortunately, you need to repeat all the environment names
from your Tox configuration.
(As far as we know, this is required in order to have individual environments
show up as separate runs on GitHub. Discuss this limitation in [issue 8].)


[issue 8]: https://github.com/fedora-python/tox-github-action/issues/8

## License

Expand Down

0 comments on commit 5befc32

Please sign in to comment.