Skip to content

Commit

Permalink
Preparation for 3.0.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
ymyzk committed Dec 23, 2022
1 parent c9b535e commit 9f5b430
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 9 deletions.
13 changes: 5 additions & 8 deletions README.md
Expand Up @@ -9,15 +9,12 @@
with multiple different Python versions on multiple workers in parallel.
This project is inspired by [tox-travis](https://github.com/tox-dev/tox-travis).

This branch is under active development to support tox v4.
We're planning to release the stable version by the end of 2022.

## Versions and Compatibility
Currently, tox-gh-actions supports both tox 3 and 4, but users need to install the appropriate version by following the table below.

| tox | tox-gh-actions | Supported by tox-gh-actions | Branch |
|-----|----------------|-----------------------------|-----------------------------------------------------------|
| 4.x | 3.x | Yes (beta) | [master](https://github.com/ymyzk/tox-gh-actions) |
| 4.x | 3.x | Yes (stable) | [master](https://github.com/ymyzk/tox-gh-actions) |
| 3.x | 2.x | Yes (stable) | [tox3](https://github.com/ymyzk/tox-gh-actions/tree/tox3) |

- [Features](#features)
Expand Down Expand Up @@ -132,8 +129,7 @@ jobs:
- name: Install dependencies
run: |
python -m pip install --upgrade pip
python -m pip install tox
python -m pip install --pre tox-gh-actions
python -m pip install tox tox-gh-actions
- name: Test with tox
run: tox
```
Expand Down Expand Up @@ -265,8 +261,7 @@ jobs:
- name: Install dependencies
run: |
python -m pip install --upgrade pip
python -m pip install tox
python -m pip install --pre tox-gh-actions
python -m pip install tox tox-gh-actions
- name: Test with tox
run: tox
env:
Expand Down Expand Up @@ -318,6 +313,8 @@ The major version can be also incremented when we require a new version of tox.
This project tries not to introduce backward incompatibles changes as much as possible so that users don't need to
update their project's configuration too frequently.

tox-gh-actions 3.x may drop support of unsupported Python 3.y versions in the future without bumping its major version.

## Understanding Behavior of tox-gh-actions
### How tox-gh-actions Works
See [ARCHITECTURE.md](./ARCHITECTURE.md) for more details.
Expand Down
2 changes: 1 addition & 1 deletion setup.cfg
Expand Up @@ -16,7 +16,7 @@ platforms = any
license = MIT
license_file = LICENSE
classifiers =
Development Status :: 4 - Beta
Development Status :: 5 - Production/Stable
Framework :: tox
Intended Audience :: Developers
License :: OSI Approved :: MIT License
Expand Down

0 comments on commit 9f5b430

Please sign in to comment.