Check Regal version at start-up #824
Merged
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
charlieegan3
commented
Jun 11, 2024
cmd/lint.go
Outdated
| dir = regalDir.Name() | ||
| } | ||
|
|
||
| if userConfig.Features.RemoteFeatures.CheckVersion && |
There was a problem hiding this comment.
Config loading is handled in a few places, lint, fix and the lsp, in each place, there are minor differences in when and how the config is loaded. Depending on config for this version check functionality makes it more tightly coupled, and harder to just run anywhere. So not sure, about the config stuff in this PR, but we can remove if we don't like it and just offer the env var.
This adds functionality to the regal LS and lint commands what will check the current version against the latest release in GH. In order to keep the number of requests down, the version is cached to disk in the .regal dir. The task runs in another goroutine to keep things fast too. Config has been updated with a features key, and REGAL_FEATURES_REMOTE_CHECK_VERSION can also be set to disable to functionality. Sharing for review, if we think it looks good, I'll add some docs and we can get this in. Signed-off-by: Charlie Egan <charlie@styra.com>
charlieegan3
force-pushed
the
check-version
branch
from
7a8d7c9 to
0b7db0a
Compare
srenatus
reviewed
Jun 11, 2024
internal/update/update.rego
Outdated
srenatus
reviewed
Jun 11, 2024
Signed-off-by: Charlie Egan <charlie@styra.com>
Signed-off-by: Charlie Egan <charlie@styra.com>
Signed-off-by: Charlie Egan <charlie@styra.com>
Signed-off-by: Charlie Egan <charlie@styra.com>
|
This is all updated again, I just need to do some docs for it. |
|
dedd3bb adds the docs. |
anderseknert
approved these changes
Jun 12, 2024
|
There's some build failures. I just realized it might be good to mention this briefly in the README too, and provide a link to the docs page on that! |
Signed-off-by: Charlie Egan <charlie@styra.com>
|
Have fixed the md lint error and updated readme too. |
srenatus
pushed a commit
to srenatus/regal
that referenced
this pull request
Oct 1, 2024
* Check Regal version at start-up This adds functionality to the regal LS and lint commands what will check the current version against the latest release in GH. In order to keep the number of requests down, the version is cached to disk in the .regal dir. The task runs in another goroutine to keep things fast too. Config has been updated with a features key, and REGAL_FEATURES_REMOTE_CHECK_VERSION can also be set to disable to functionality. Sharing for review, if we think it looks good, I'll add some docs and we can get this in. Signed-off-by: Charlie Egan <charlie@styra.com> * Share logic for sharing of defaulting config Signed-off-by: Charlie Egan <charlie@styra.com> * Rename var to disable the check version feature Signed-off-by: Charlie Egan <charlie@styra.com> * Use global config dir for version state Signed-off-by: Charlie Egan <charlie@styra.com> * Use shorter var name Signed-off-by: Charlie Egan <charlie@styra.com> * Extract check to func * Add docs Signed-off-by: Charlie Egan <charlie@styra.com> * Set lang in docs Signed-off-by: Charlie Egan <charlie@styra.com> --------- Signed-off-by: Charlie Egan <charlie@styra.com>
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
This adds functionality to the regal LS and lint commands what will check the current version against the latest release in GH.
In order to keep the number of requests down, the version is cached to disk in the .regal dir. The task runs in another goroutine to keep things fast too.
Config has been updated with a features key, and
REGAL_FEATURES_REMOTE_CHECK_VERSION can also be set to disable to functionality.
Sharing for review, if we think it looks good, I'll add some docs and we can get this in.
Fixes #802