From 3ada5af872cdd4916649d2d33f0090951344d591 Mon Sep 17 00:00:00 2001 From: Andy Feller Date: Mon, 13 Jan 2025 08:41:10 -0500 Subject: [PATCH] Enhance help docs on ext upgrade notices - update `gh help environment` to include that upgrade notices only happen when gh or extensions are executed - update `gh ext --help` to include reference to upgrade notices and points to `gh help environment` for info on disabling --- pkg/cmd/extension/command.go | 3 +++ pkg/cmd/root/help_topic.go | 8 ++++---- 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/pkg/cmd/extension/command.go b/pkg/cmd/extension/command.go index 410e96f53..dad4021b6 100644 --- a/pkg/cmd/extension/command.go +++ b/pkg/cmd/extension/command.go @@ -46,6 +46,9 @@ func NewCmdExtension(f *cmdutil.Factory) *cobra.Command { An extension cannot override any of the core gh commands. If an extension name conflicts with a core gh command, you can use %[1]sgh extension exec %[1]s. + When an extension is executed, gh will check for new versions once every 24 hours and display + an upgrade notice. See %[1]sgh help environment%[1]s for information on disabling extension notices. + For the list of available extensions, see . `, "`"), Aliases: []string{"extensions", "ext"}, diff --git a/pkg/cmd/root/help_topic.go b/pkg/cmd/root/help_topic.go index 4359e4212..9ae2c5c86 100644 --- a/pkg/cmd/root/help_topic.go +++ b/pkg/cmd/root/help_topic.go @@ -87,12 +87,12 @@ var HelpTopics = []helpTopic{ the number of columns available in the current viewport. %[1]sGH_NO_UPDATE_NOTIFIER%[1]s: set to any value to disable GitHub CLI update notifications. - By default, gh checks for new releases once every 24 hours and displays an upgrade notice on standard - error if a newer version was found. + When any command is executed, gh checks for new versions once every 24 hours. + If a newer version was found, an upgrade notice is displayed on standard error. %[1]sGH_NO_EXTENSION_UPDATE_NOTIFIER%[1]s: set to any value to disable GitHub CLI extension update notifications. - By default, gh checks for new releases once every 24 hours and displays an upgrade notice on standard - error if a newer version was found. + When an extension is executed, gh checks for new versions for the executed extension once every 24 hours. + If a newer version was found, an upgrade notice is displayed on standard error. %[1]sGH_CONFIG_DIR%[1]s: the directory where gh will store configuration files. If not specified, the default value will be one of the following paths (in order of precedence):