diff options
author | Chocobozzz <me@florianbigard.com> | 2021-05-10 18:35:38 +0200 |
---|---|---|
committer | Chocobozzz <me@florianbigard.com> | 2021-05-10 18:35:38 +0200 |
commit | d61515e12a8803a1662d1122a171201622a0ed77 (patch) | |
tree | 87a3c3acc069188a9853c50c9da1eacc5617cd0a /support/doc/plugins | |
parent | 38ce2aa7a8cc51a833b85a32222da2d2c2a43cb9 (diff) | |
download | PeerTube-d61515e12a8803a1662d1122a171201622a0ed77.tar.gz PeerTube-d61515e12a8803a1662d1122a171201622a0ed77.tar.zst PeerTube-d61515e12a8803a1662d1122a171201622a0ed77.zip |
Add doc to unpublish a plugin
Diffstat (limited to 'support/doc/plugins')
-rw-r--r-- | support/doc/plugins/guide.md | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/support/doc/plugins/guide.md b/support/doc/plugins/guide.md index 5b7d1cb31..d3b9db0ed 100644 --- a/support/doc/plugins/guide.md +++ b/support/doc/plugins/guide.md | |||
@@ -39,6 +39,7 @@ | |||
39 | - [Build your plugin](#build-your-plugin) | 39 | - [Build your plugin](#build-your-plugin) |
40 | - [Test your plugin/theme](#test-your-plugintheme) | 40 | - [Test your plugin/theme](#test-your-plugintheme) |
41 | - [Publish](#publish) | 41 | - [Publish](#publish) |
42 | - [Unpublish](#unpublish) | ||
42 | - [Plugin & Theme hooks/helpers API](#plugin--theme-hookshelpers-api) | 43 | - [Plugin & Theme hooks/helpers API](#plugin--theme-hookshelpers-api) |
43 | - [Tips](#tips) | 44 | - [Tips](#tips) |
44 | - [Compatibility with PeerTube](#compatibility-with-peertube) | 45 | - [Compatibility with PeerTube](#compatibility-with-peertube) |
@@ -909,6 +910,14 @@ $ npm publish | |||
909 | Every time you want to publish another version of your plugin/theme, just update the `version` key from the `package.json` | 910 | Every time you want to publish another version of your plugin/theme, just update the `version` key from the `package.json` |
910 | and republish it on NPM. Remember that the PeerTube index will take into account your new plugin/theme version after ~24 hours. | 911 | and republish it on NPM. Remember that the PeerTube index will take into account your new plugin/theme version after ~24 hours. |
911 | 912 | ||
913 | ### Unpublish | ||
914 | |||
915 | If for a particular reason you don't want to maintain your plugin/theme anymore | ||
916 | you can deprecate it. The plugin index will automatically remove it preventing users to find/install it from the PeerTube admin interface: | ||
917 | |||
918 | ```bash | ||
919 | $ npm deprecate peertube-plugin-xxx@"> 0.0.0" "explain here why you deprecate your plugin/theme" | ||
920 | ``` | ||
912 | 921 | ||
913 | ## Plugin & Theme hooks/helpers API | 922 | ## Plugin & Theme hooks/helpers API |
914 | 923 | ||