interesting
/
PeerTube
mirror of https://github.com/Chocobozzz/PeerTube.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Add doc to unpublish a plugin

This commit is contained in:
Chocobozzz 2021-05-10 18:35:38 +02:00
parent 38ce2aa7a8
commit d61515e12a
No known key found for this signature in database
GPG Key ID: 583A612D890159BE
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
support/doc/plugins/guide.md
View File

@ -39,6 +39,7 @@
- [Build your plugin](#build-your-plugin) - [Build your plugin](#build-your-plugin)
- [Test your plugin/theme](#test-your-plugintheme) - [Test your plugin/theme](#test-your-plugintheme)
- [Publish](#publish) - [Publish](#publish)
- [Unpublish](#unpublish)
- [Plugin & Theme hooks/helpers API](#plugin--theme-hookshelpers-api) - [Plugin & Theme hooks/helpers API](#plugin--theme-hookshelpers-api)
- [Tips](#tips) - [Tips](#tips)
- [Compatibility with PeerTube](#compatibility-with-peertube) - [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` 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. 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 ## Plugin & Theme hooks/helpers API