Add more validation and help to config #814
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
vladaionescu
approved these changes
Feb 25, 2021
config/config.go
Outdated
| DebuggerPort int `yaml:"debugger_port" help:"What port should the debugger (and other interactive sessions) use to communicate."` | ||
| BuildkitRestartTimeoutS int `yaml:"buildkit_restart_timeout_s" help:"How long to wait for buildkit to (re)start, in seconds."` | ||
| BuildkitAdditionalArgs []string `yaml:"buildkit_additional_args" help:"Additional args to pass to buildkit when it starts. Useful for custom certs, or user namespace complications."` | ||
| BuildkitAdditionalConfig string `yaml:"buildkit_additional_config" help:"Additional config to use when starting the buildkit container; like mounting volumes."` |
There was a problem hiding this comment.
Actually mounting volumes would be done through BuilkditAdditionalArgs. An example might be "using self-signed certificates"
|
I got a panic when I ran this: If it's relevant, I don't have a |
|
I think there's a missing newline required somewhere in the code: |
alexcb
reviewed
Feb 25, 2021
dchw
commented
Feb 25, 2021
| @@ -810,17 +810,37 @@ func newEarthlyApp(ctx context.Context, console conslogging.ConsoleLogger) *eart | |||
| Usage: "Edits your Earthly configuration file", | |||
| Hidden: true, // Experimental. | |||
| Action: app.actionConfig, | |||
| Description: `This command takes a path, and a value and sets it in your configuration file. | |||
| UsageText: `This command takes a path, and a value and sets it in your configuration file. | |||
There was a problem hiding this comment.
Not a standard usage, but there isn't an Examples section. This kept the flow while being slightly wrong? Willing to reverse or hard-code in the examples section if needed. Also I could make the UsageText include the current english description,, and the Description include the examples.
Sample, as it is now:
NAME:
earthly config - Edits your Earthly configuration file
USAGE:
This command takes a path, and a value and sets it in your configuration file.
As the configuration file is YAML, the key must be a valid key within the file. You can specify sub-keys by using "." to separate levels.
If the sub-key you wish to use has a "." in it, you can quote that subsection, like this: git."github.com".
Values must be valid YAML, and also be deserializable into the key you wish to assign them to.
This means you can set higher level objects using a compact style, or single values with simple values.
Only one key/value can be set per invocation.
To get help with a specific key, do "config [key] --help". Or, visit https://docs.earthly.dev/earthly-config for more details.
DESCRIPTION:
Set your cache size:
config global.cache_size_mb 1234
Set additional buildkit args, using a YAML array:
config global.buildkit_additional_args ['userns', '--host']
Set a key containing a period:
config git."example.com".password hunter2
Configure a server called example.com which stored git repos under /var/git/repos/name-of-repo.git and allowed access over ssh using port 2222 with the git username, you can configure earthly to recognize it as example.com/name-of-repo by configuring it with:
config git "{example: {pattern: 'example.com/([^/]+)', substitute: 'ssh://git@example.com:2222/var/git/repos/\$1.git', auth: ssh}}"
OPTIONS:
--dry-run Print the changed config file to the consile instead of writing it out (default: false)
--help, -h show help (default: false)
There was a problem hiding this comment.
I made your sentence a bulleted list:
Set up a whole custom git repository for a server called example.com, using a single-line YAML literal:
* which stores git repos under /var/git/repos/name-of-repo.git
* allows access over ssh
* using port 2222
* sets the username to git
* is recognized to earthly as example.com/name-of-repo
config git "{example: {pattern: 'example.com/([^/]+)', substitute: 'ssh://git@example.com:2222/var/git/repos/\$1.git', auth: ssh}}"
alexcb
approved these changes
Feb 25, 2021
1 task
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.
Adds help text for main command, and for keys (at the expense of being able to set a value to
--help.Adds validation to ensure you can set the key to that value.