Skip to content

Commit

Permalink
docs: add advice for maintaining a plugin
Browse files Browse the repository at this point in the history
  • Loading branch information
radoering committed Nov 5, 2022
1 parent b28339d commit 6a6b4e1
Showing 1 changed file with 15 additions and 0 deletions.
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
official stable 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.

0 comments on commit 6a6b4e1

Please sign in to comment.