Show update notifications when a new version of kit is available #418
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Print a message before running commands if we find a newer version of Kit is available on GitHub. If the current version of Kit doesn't look to be a regular release, or if any error occurs while checking, we don't print anything (but do print some debug logs).
Add flag to version subcommand disable update notifications: kit version --show-update-notifications=false Settings is 'saved' by touching a file in $KITOPS_HOME Note, flag is attached to the 'version' subcommand as it seems there is no convenient way to specify it on the root command; it cannot be handled in PersistentPreRun and handling it in the root command's RunE breaks the help text for 'kit' (specifically, the 'usage' field)
amisevsk
changed the title
gorkem
reviewed
Jul 19, 2024
| HarnessSubpath = "harness" | ||
| HarnessProcessFile = "process.pid" | ||
| HarnessLogFile = "harness.log" | ||
| UpdateNotificationsConfigFilename = "disable-update-notifications" |
There was a problem hiding this comment.
Should we just have a kitconfig.json where this is just a key?
There was a problem hiding this comment.
That's a much bigger task :)
If we have a kitconfig.json, I'd expect to be able to almost configure everything there (e.g. something like viper). What that looks like is pretty nebulous.
pkg/lib/update/update.go
Outdated
Comment on lines
68
to
83
| client := &http.Client{ | ||
| Timeout: 1 * time.Second, | ||
| } | ||
| resp, err := client.Get(releaseUrl) | ||
| if err != nil { | ||
| output.Debugf("Failed to check for updates: %s", err) | ||
| return | ||
| } | ||
| defer resp.Body.Close() | ||
|
|
||
| respBody, err := io.ReadAll(resp.Body) | ||
| if err != nil { | ||
| output.Debugf("Failed to read GitHub response body: %s", err) | ||
| return | ||
| } | ||
| info := &ghReleaseInfo{} |
There was a problem hiding this comment.
The code for retrieving the release info could be refactored into a function for clarity.
We could potentially put it in |
gorkem
approved these changes
Jul 19, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Show an update notification in the CLI if a newer version is available on GitHub:
Notifications can be disabled by running
kit version --show-update-notifications=false(use=trueto re-enable).Errors in checking for an update are delegated to debug-level logs and not shown to the user by default.
To test this PR, you will need to build kit with at least
-ldflags="-s -w -X kitops/pkg/lib/constants.Version=${version}"Note: I had to put the enable/disable flag under the version subcommand, as trying to include it in the root command would either not run it or would break the default help text.
Linked issues
Closes #365