Skip to content

Commit 7105971

Browse files
authored
docs: add advice for maintaining a plugin (#6977)
1 parent 7b40c84 commit 7105971

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

Diff for: docs/plugins.md

+15
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)