Skip to content

Commit

Permalink
Merge pull request #95 from enpaul/enp/docs
Browse files Browse the repository at this point in the history
Prep for 1.0 beta release
  • Loading branch information
enpaul authored Aug 2, 2023
2 parents f6dab54 + ef3cf00 commit e875008
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 13 deletions.
13 changes: 13 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,19 @@

See also: [Github Release Page](https://github.com/enpaul/tox-poetry-installer/releases).

## Version 1.0.0 Beta 1

View this release on:
[Github](https://github.com/enpaul/tox-poetry-installer/releases/tag/1.0.0b1),
[PyPI](https://pypi.org/project/tox-poetry-installer/1.0.0b1)

- Update Poetry compatibility to include >=1.5
- Update Tox compatibility to use Tox 4
- Remove support for Tox 3
- Remove deprecated `--require-poetry` command line option
- Remove deprecated `install_dev_deps` confguration option
- Remove deprecated `--parallelize-locked-install` command line option

## Version 0.10.3

View this release on:
Expand Down
11 changes: 0 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -205,10 +205,6 @@ configuration section.
| `require_poetry` | Boolean | False | Whether Tox should be forced to fail if the plugin cannot import Poetry locally. If `False` then the plugin will be skipped for the test environment if Poetry cannot be imported. If `True` then the plugin will force the environment to error and the Tox run to fail. |
| `poetry_dep_groups` | List | `[]` | Names of Poetry dependency groups specified in `pyproject.toml` to install to the test environment. |

> ℹ️ **Note:** The `install_dev_deps` configuration option is deprecated and will be
> removed in version 1.0.0. Please set `poetry_dep_groups = [dev]` in `tox.ini` for
> environments that install the development dependencies.
### Runtime Options

All arguments listed below can be passed to the `tox` command to modify runtime behavior
Expand All @@ -218,13 +214,6 @@ of the plugin.
| :--------------------------- | :-----: | :-----: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--parallel-install-threads` | Integer | `10` | Number of worker threads to use to install dependencies in parallel. Installing in parallel with more threads can greatly speed up the install process, but can cause race conditions during install. Pass this option with the value `0` to entirely disable parallel installation. |

> ℹ️ **Note:** The `--require-poetry` runtime option is deprecated and will be removed in
> version 1.0.0. Please set `require_poetry = true` in `tox.ini` for environments that
> should fail if Poetry is not available.
> ℹ️ **Note:** The `--parallelize-locked-install` option is deprecated and will be removed
> in version 1.0.0. Please use the `--parallel-install-threads` option.
### Errors

There are several errors that the plugin can encounter for a test environment when Tox is
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "tox-poetry-installer"
version = "0.10.3"
version = "1.0.0b1"
license = "MIT"
authors = ["Ethan Paul <[email protected]>"]
description = "A plugin for Tox that lets you install test environment dependencies from the Poetry lockfile"
Expand Down
2 changes: 1 addition & 1 deletion tox_poetry_installer/__about__.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# pylint: disable=missing-docstring
__title__ = "tox-poetry-installer"
__summary__ = "A plugin for Tox that lets you install test environment dependencies from the Poetry lockfile"
__version__ = "0.10.3"
__version__ = "1.0.0b1"
__url__ = "https://github.com/enpaul/tox-poetry-installer/"
__license__ = "MIT"
__authors__ = ["Ethan Paul <[email protected]>"]

0 comments on commit e875008

Please sign in to comment.