Add Environment Variable to Skip Latest Extension Version Check #9925

Activity

1. LangLangBart

   added

   enhancementa request to improve CLIa request to improve CLI

   on Nov 15, 2024
2. cliAutomation

   added

   needs-triageneeds to be reviewedneeds to be reviewed

   on Nov 15, 2024
3. andyfeller commented on Nov 16, 2024

   

   andyfeller

   on Nov 16, 2024

   Last edited by andyfeller

   Contributor

   More actions

   Thank you for sharing feedback on the new extension update checking feature and sharing suggestions on how to improve it, @LangLangBart! 🙇 Extending the GH_NO_UPDATE_NOTIFIER and dropping the 1 second timeout make sense. 👍

   Whether we should have a separate environment variable for extensions or not is a good question. 🤔 The cmd.go logic involved has a little bit of complexity especially with the updaterEnabled which looks like it would be statically set during compilation but I can't find anything that is changing its value:

   cli/internal/ghcmd/cmd.go

   Lines 219 to 238 in 9decf1b

   	func shouldCheckForUpdate() bool {
   	if os.Getenv("GH_NO_UPDATE_NOTIFIER") != "" {
   	return false
   	}
   	if os.Getenv("CODESPACES") != "" {
   	return false
   	}
   	return updaterEnabled != "" && !isCI() && isTerminal(os.Stdout) && isTerminal(os.Stderr)
   	}
   	func isTerminal(f *os.File) bool {
   	return isatty.IsTerminal(f.Fd()) || isatty.IsCygwinTerminal(f.Fd())
   	}
   	// based on https://github.com/watson/ci-info/blob/HEAD/index.js
   	func isCI() bool {
   	return os.Getenv("CI") != "" || // GitHub Actions, Travis CI, CircleCI, Cirrus CI, GitLab CI, AppVeyor, CodeShip, dsari
   	os.Getenv("BUILD_NUMBER") != "" || // Jenkins, TeamCity
   	os.Getenv("RUN_ID") != "" // TaskCluster, dsari
   	}

   All of that aside, I'll admit I struggled a bit with some of the complexity of the different extension types and whether to duplicate or completely refactor the update logic to cache information about the latest release found:

   cli/internal/update/update.go

   Lines 22 to 56 in 9decf1b

   	// ReleaseInfo stores information about a release
   	type ReleaseInfo struct {
   	Version string `json:"tag_name"`
   	URL string `json:"html_url"`
   	PublishedAt time.Time `json:"published_at"`
   	}
   	type StateEntry struct {
   	CheckedForUpdateAt time.Time `yaml:"checked_for_update_at"`
   	LatestRelease ReleaseInfo `yaml:"latest_release"`
   	}
   	// CheckForUpdate checks whether this software has had a newer release on GitHub
   	func CheckForUpdate(ctx context.Context, client *http.Client, stateFilePath, repo, currentVersion string) (*ReleaseInfo, error) {
   	stateEntry, _ := getStateEntry(stateFilePath)
   	if stateEntry != nil && time.Since(stateEntry.CheckedForUpdateAt).Hours() < 24 {
   	return nil, nil
   	}
   	releaseInfo, err := getLatestReleaseInfo(ctx, client, repo)
   	if err != nil {
   	return nil, err
   	}
   	err = setStateEntry(stateFilePath, time.Now(), *releaseInfo)
   	if err != nil {
   	return nil, err
   	}
   	if versionGreaterThan(releaseInfo.Version, currentVersion) {
   	return releaseInfo, nil
   	}
   	return nil, nil
   	}

   From #6977, it appears this updaterEnabled is being set via Homebrew in https://github.com/Homebrew/homebrew-core/blob/5269b1788711898ab5732f74bf781b1e9f6ba7e4/Formula/g/gh.rb#L27-L43

     def install
       gh_version = if build.stable?
         version.to_s
       else
         Utils.safe_popen_read("git", "describe", "--tags", "--dirty").chomp
       end
   
       with_env(
         "GH_VERSION" => gh_version,
         "GO_LDFLAGS" => "-s -w -X main.updaterEnabled=cli/cli",
       ) do
         system "make", "bin/gh", "manpages"
       end
       bin.install "bin/gh"
       man1.install Dir["share/man/man1/gh*.1"]
       generate_completions_from_executable(bin/"gh", "completion", "-s")
     end
4. andyfeller

   added

   gh-extensionrelating to the gh extension commandrelating to the gh extension command

   on Nov 16, 2024
5. Roxyfundz1 commented on Nov 25, 2024

   

   Roxyfundz1

   on Nov 25, 2024 · Hidden as spam

   show commentMore actions
6. cli

   blocked Roxyfundz1on Nov 28, 2024
7. BagToad

   added

   coreThis issue is not accepting PRs from outside contributorsThis issue is not accepting PRs from outside contributors

   and removed

   needs-triageneeds to be reviewedneeds to be reviewed

   on Nov 28, 2024
8. andyfeller

   closed this as completedin #9934on Jan 13, 2025
9. andyfeller commented on Jan 30, 2025

   

   andyfeller

   on Jan 30, 2025

   Last edited by andyfeller

   Contributor

   More actions

   Circling back to this issue now that v2.66.0 has been released, the team decided to use the new GH_NO_EXTENSION_UPDATE_NOTIFIER environment variable for opting out of extension update notices. This will give users greater control over awareness of new features, bug fixes, or security without making it all or nothing.

   Otherwise, extension update notices are now on par with core gh notices.

   For more information, see gh help environment docs

   👍React with 👍1Reacted by LangLangBart
10. tmeijn

    added a commit that references this issue on Feb 4, 2025

    build(deps): update cli/cli to v2.66.1

    ...

    4ccb00f