Skip to content

Commit 394a5c3

Browse files
authored
Merge branch 'master' into improve_poetry_init_validate
2 parents ab48086 + 7c86992 commit 394a5c3

38 files changed

+276
-1368
lines changed

.pre-commit-config.yaml

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ ci:
33

44
repos:
55
- repo: https://github.com/pre-commit/pre-commit-hooks
6-
rev: v4.3.0
6+
rev: v4.4.0
77
hooks:
88
- id: trailing-whitespace
99
- id: end-of-file-fixer
@@ -47,7 +47,7 @@ repos:
4747
- flake8-pie==0.16.0
4848

4949
- repo: https://github.com/asottile/pyupgrade
50-
rev: v3.2.2
50+
rev: v3.3.1
5151
hooks:
5252
- id: pyupgrade
5353
args: [--py37-plus]
@@ -60,7 +60,7 @@ repos:
6060
args: [--all]
6161

6262
- repo: https://github.com/pycqa/isort
63-
rev: 5.10.1
63+
rev: 5.11.4
6464
hooks:
6565
- id: isort
6666
name: "isort (python)"
@@ -77,17 +77,18 @@ repos:
7777
args: [--lines-after-imports, "-1"]
7878

7979
- repo: https://github.com/psf/black
80-
rev: 22.10.0
80+
rev: 22.12.0
8181
hooks:
8282
- id: black
8383

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

9091
- repo: https://github.com/pre-commit/pre-commit
91-
rev: v2.20.0
92+
rev: v2.21.0
9293
hooks:
9394
- id: validate_manifest

docs/plugins.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -249,3 +249,18 @@ If you want to uninstall a plugin, you can run:
249249
```shell
250250
$POETRY_HOME/bin/pip uninstall poetry-plugin
251251
```
252+
253+
254+
## Maintaining a plugin
255+
256+
When writing a plugin, you will probably access internals of Poetry, since there is no
257+
stable public API. Although we try our best to deprecate methods first, before
258+
removing them, sometimes the signature of an internal method has to be changed.
259+
260+
As the author of a plugin, you are probably testing your plugin
261+
against the latest release of Poetry.
262+
Additionally, you should consider testing against the latest release branch and the
263+
master branch of Poetry and schedule a CI job that runs regularly even if you did not
264+
make any changes to your plugin.
265+
This way, you will notice internal changes that break your plugin immediately
266+
and can prepare for the next Poetry release.

0 commit comments

Comments
 (0)