From d61515e12a8803a1662d1122a171201622a0ed77 Mon Sep 17 00:00:00 2001 From: Chocobozzz Date: Mon, 10 May 2021 18:35:38 +0200 Subject: Add doc to unpublish a plugin --- support/doc/plugins/guide.md | 9 +++++++++ 1 file changed, 9 insertions(+) (limited to 'support/doc/plugins/guide.md') 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 @@ - [Build your plugin](#build-your-plugin) - [Test your plugin/theme](#test-your-plugintheme) - [Publish](#publish) + - [Unpublish](#unpublish) - [Plugin & Theme hooks/helpers API](#plugin--theme-hookshelpers-api) - [Tips](#tips) - [Compatibility with PeerTube](#compatibility-with-peertube) @@ -909,6 +910,14 @@ $ npm publish Every time you want to publish another version of your plugin/theme, just update the `version` key from the `package.json` and republish it on NPM. Remember that the PeerTube index will take into account your new plugin/theme version after ~24 hours. +### Unpublish + +If for a particular reason you don't want to maintain your plugin/theme anymore +you can deprecate it. The plugin index will automatically remove it preventing users to find/install it from the PeerTube admin interface: + +```bash +$ npm deprecate peertube-plugin-xxx@"> 0.0.0" "explain here why you deprecate your plugin/theme" +``` ## Plugin & Theme hooks/helpers API -- cgit v1.2.3