From a0b84d52ef8b968c788c036087ffeb598be4b829 Mon Sep 17 00:00:00 2001 From: Jose Diaz-Gonzalez Date: Sun, 2 Jul 2023 02:03:41 -0400 Subject: [PATCH] docs: clarify that a branch can be specified when updating a plugin Installing/Updating a plugin to a particular commit object will ensure future calls to plugin:update are pinned to that object. Closes #4551 --- docs/advanced-usage/plugin-management.md | 10 ++++++++-- plugins/plugin/help-functions | 4 ++-- 2 files changed, 10 insertions(+), 4 deletions(-) diff --git a/docs/advanced-usage/plugin-management.md b/docs/advanced-usage/plugin-management.md index 99438774e..ea0b80b09 100644 --- a/docs/advanced-usage/plugin-management.md +++ b/docs/advanced-usage/plugin-management.md @@ -5,13 +5,13 @@ ``` plugin:disable # Disable an installed plugin (third-party only) plugin:enable # Enable a previously disabled plugin -plugin:install [--core|git-url [--committish tag|branch|commit|--name custom-plugin-name]] # Optionally download git-url (with custom tag/committish) & run install trigger for active plugins (or only core ones) +plugin:install [--core|--git-url] [--committish branch|commit|tag] [--name custom-plugin-name] # Optionally download git-url (and pin to the specified branch/commit/tag) & run install trigger for active plugins (or only core ones) plugin:installed # Checks if a plugin is installed plugin:install-dependencies [--core] # Run install-dependencies trigger for active plugins (or only core ones) plugin:list # Print active plugins plugin:trigger . # Trigger an arbitrary plugin hook plugin:uninstall # Uninstall a plugin (third-party only) -plugin:update [name [committish]] # Optionally update named plugin from git (with custom tag/committish) & run update trigger for active plugins +plugin:update [name [branch|commit|tag]] # Optionally update named plugin from git (and pin to the specified branch/commit/tag) & run update trigger for active plugins ``` ```shell @@ -165,6 +165,12 @@ An optional commit SHA-like object may be specified. dokku plugin:update postgres 2.0.0 ``` +Any future invocation of `plugin:update` will respect the previously specified SHA-like object. To follow a particular branch again, specify that branch: + +```shell +dokku plugin:update postgres main +``` + ### Uninstalling a plugin Third party plugins can be uninstalled using the `plugin:uninstall` command: diff --git a/plugins/plugin/help-functions b/plugins/plugin/help-functions index 909045612..29087e0e7 100755 --- a/plugins/plugin/help-functions +++ b/plugins/plugin/help-functions @@ -29,11 +29,11 @@ fn-help-content() { cat <, Disable an installed plugin (third-party only) plugin:enable , Enable a previously disabled plugin - plugin:install [--core|git-url [--committish tag|branch|commit|--name custom-plugin-name]], Optionally download git-url (with custom tag/committish) & run install trigger for active plugins (or only core ones) + plugin:install [--core|--git-url] [--committish branch|commit|commit] [--name custom-plugin-name], Optionally download git-url (and pin to the specified branch/commit/tag) & run install trigger for active plugins (or only core ones) plugin:install-dependencies [--core], Run install-dependencies trigger for active plugins (or only core ones) plugin:list, Print active plugins plugin:trigger , Trigger an arbitrary plugin hook plugin:uninstall , Uninstall a plugin (third-party only) - plugin:update [name [committish]], Optionally update named plugin from git (with custom tag/committish) & run update trigger for active plugins + plugin:update [name [branch|commit|tag]], Optionally update named plugin from git (and pin to the specified branch/commit/tag) & run update trigger for active plugins help_content }