Skip to content

docs: add advice for maintaining a plugin #6977

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Secrus merged 2 commits into from
Dec 31, 2022
Merged

docs: add advice for maintaining a plugin #6977

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f82b5bc
docs: add advice for maintaining a plugin
radoering Nov 5, 2022
35b93c5
Merge branch 'master' into docs/plugin-maintaining
Secrus Dec 31, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions docs/plugins.md
View file
Open in desktop
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.