diff options
author | lutangar <johan.dufour@gmail.com> | 2021-06-30 10:32:15 +0200 |
---|---|---|
committer | Chocobozzz <chocobozzz@cpy.re> | 2021-06-30 11:44:54 +0200 |
commit | 4c0a6954fb6df177f842de4bf3e3a97eb171a11b (patch) | |
tree | 46ddc29735f4784a3f40b1c14eb9602497bfa0f2 /support/doc/plugins | |
parent | 50cebb54beb2f5bb02ebf9b804dcb8442c7ce2b7 (diff) | |
download | PeerTube-4c0a6954fb6df177f842de4bf3e3a97eb171a11b.tar.gz PeerTube-4c0a6954fb6df177f842de4bf3e3a97eb171a11b.tar.zst PeerTube-4c0a6954fb6df177f842de4bf3e3a97eb171a11b.zip |
Document a way to update the last available version of a plugin manually
May comes in very handy to quickly test a plugin in a production like environment before it reaches a greater world.
> This magic trick comes from @Chocobozzz himself, who passed it on to @JohnXLivingston, who then passed it down to me.
Diffstat (limited to 'support/doc/plugins')
-rw-r--r-- | support/doc/plugins/guide.md | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/support/doc/plugins/guide.md b/support/doc/plugins/guide.md index 3715a5086..568c0662f 100644 --- a/support/doc/plugins/guide.md +++ b/support/doc/plugins/guide.md | |||
@@ -754,6 +754,8 @@ Left menu links can be filtered (add/remove a section or add/remove links) using | |||
754 | 754 | ||
755 | PeerTube plugins and themes should be published on [NPM](https://www.npmjs.com/) so that PeerTube indexes take into account your plugin (after ~ 1 day). An official plugin index is available on [packages.joinpeertube.org](https://packages.joinpeertube.org/api/v1/plugins), with no interface to present packages. | 755 | PeerTube plugins and themes should be published on [NPM](https://www.npmjs.com/) so that PeerTube indexes take into account your plugin (after ~ 1 day). An official plugin index is available on [packages.joinpeertube.org](https://packages.joinpeertube.org/api/v1/plugins), with no interface to present packages. |
756 | 756 | ||
757 | > The official plugin index source code is available at https://framagit.org/framasoft/peertube/plugin-index | ||
758 | |||
757 | ## Write a plugin/theme | 759 | ## Write a plugin/theme |
758 | 760 | ||
759 | Steps: | 761 | Steps: |
@@ -937,6 +939,12 @@ $ npm publish | |||
937 | Every time you want to publish another version of your plugin/theme, just update the `version` key from the `package.json` | 939 | Every time you want to publish another version of your plugin/theme, just update the `version` key from the `package.json` |
938 | and republish it on NPM. Remember that the PeerTube index will take into account your new plugin/theme version after ~24 hours. | 940 | and republish it on NPM. Remember that the PeerTube index will take into account your new plugin/theme version after ~24 hours. |
939 | 941 | ||
942 | > If you need to force your plugin update on a specific __PeerTube__ instance, you may update the latest available version manually: | ||
943 | > ```sql | ||
944 | > UPDATE "plugin" SET "latestVersion" = 'X.X.X' WHERE "plugin"."name" = 'plugin-shortname'; | ||
945 | > ``` | ||
946 | > You'll then be able to click the __Update plugin__ button on the plugin list. | ||
947 | |||
940 | ### Unpublish | 948 | ### Unpublish |
941 | 949 | ||
942 | If for a particular reason you don't want to maintain your plugin/theme anymore | 950 | If for a particular reason you don't want to maintain your plugin/theme anymore |