STACKITGit/cli
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Enhance help docs on ext upgrade notices

Browse source 
- 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
This commit is contained in:
Andy Feller 2025-01-13 08:41:10 -05:00
parent 0a1c9be656
commit 3ada5af872
2 changed files with 7 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

3
pkg/cmd/extension/command.go
View file

@ -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 <extname>%[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 <https://github.com/topics/gh-extension>.
`, "`"),
Aliases: []string{"extensions", "ext"},

8
pkg/cmd/root/help_topic.go
View file

@ -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):