Skip to content

Commit

Permalink
Merge branch 'master' into improve_poetry_init_validate
Browse files Browse the repository at this point in the history
  • Loading branch information
nahco314 authored Jan 3, 2023
2 parents ab48086 + 7c86992 commit 394a5c3
Show file tree
Hide file tree
Showing 38 changed files with 276 additions and 1,368 deletions.
13 changes: 7 additions & 6 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ ci:

repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.3.0
rev: v4.4.0
hooks:
- id: trailing-whitespace
- id: end-of-file-fixer
Expand Down Expand Up @@ -47,7 +47,7 @@ repos:
- flake8-pie==0.16.0

- repo: https://github.com/asottile/pyupgrade
rev: v3.2.2
rev: v3.3.1
hooks:
- id: pyupgrade
args: [--py37-plus]
Expand All @@ -60,7 +60,7 @@ repos:
args: [--all]

- repo: https://github.com/pycqa/isort
rev: 5.10.1
rev: 5.11.4
hooks:
- id: isort
name: "isort (python)"
Expand All @@ -77,17 +77,18 @@ repos:
args: [--lines-after-imports, "-1"]

- repo: https://github.com/psf/black
rev: 22.10.0
rev: 22.12.0
hooks:
- id: black

- repo: https://github.com/pycqa/flake8
rev: 5.0.4
# freeze to commit rev to prevent automatic updates, since newer versions of flake8 are not compatible with plugins
rev: 6027577d325b0dd8bf1e465ebd29b71b5f0d005b
hooks:
- id: flake8
additional_dependencies: *flake8_deps

- repo: https://github.com/pre-commit/pre-commit
rev: v2.20.0
rev: v2.21.0
hooks:
- id: validate_manifest
15 changes: 15 additions & 0 deletions docs/plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -249,3 +249,18 @@ If you want to uninstall a plugin, you can run:
```shell
$POETRY_HOME/bin/pip uninstall poetry-plugin
```


## Maintaining a plugin

When writing a plugin, you will probably access internals of Poetry, since there is no
stable public API. Although we try our best to deprecate methods first, before
removing them, sometimes the signature of an internal method has to be changed.

As the author of a plugin, you are probably testing your plugin
against the latest release of Poetry.
Additionally, you should consider testing against the latest release branch and the
master branch of Poetry and schedule a CI job that runs regularly even if you did not
make any changes to your plugin.
This way, you will notice internal changes that break your plugin immediately
and can prepare for the next Poetry release.
Loading

0 comments on commit 394a5c3

Please sign in to comment.