Skip to content

Commit

Permalink
#14: Add a note about Poetry's version setting
Browse files Browse the repository at this point in the history
  • Loading branch information
mtkennerly committed Oct 18, 2020
1 parent 42fdae3 commit 7b57245
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,9 @@ Note that you must install the plugin in your global Python installation,
**not** as a dev-dependency in pyproject.toml, because the virtual environment
that Poetry creates cannot see Poetry itself and therefore cannot patch it.

Poetry's typical `version` setting is still required in `[tool.poetry]`,
but you are encouraged to use `version = "0.0.0"` as a standard placeholder.

With the minimal configuration above, the plugin will automatically take effect
when you run commands such as `poetry build`. It will update the version in
pyproject.toml, then revert the change when the plugin deactivates. If you want
Expand Down

0 comments on commit 7b57245

Please sign in to comment.