opensource/coder
3
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2026-09-24 15:04:27 +08:00
Code Issues Packages Projects Releases Wiki Activity

chore(cli): rename build options to ephemeral parameters in cli (#15030)

Browse Source 
This PR aims to rename `build-option` to `ephemeral-parameters` based on
#10488 conversation.

`build-option` has been renamed `ephemeral-parameter` and can be used to
define a value for an ephemeral parameter in the template.

`build-options` has been renamed `prompt-ephemeral-parameters` and can
be used to prompt the user to put values for the ephemeral parameters in
the template.

---------

Co-authored-by: Mathias Fredriksson <mafredri@gmail.com>
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com>
Co-authored-by: defelmnq <yvincent@coder.com>
This commit is contained in:
Vincent Vielle
2024-10-16 23:54:12 +02:00
committed by GitHub
co-authored by Mathias Fredriksson EdwardAngert defelmnq
parent 512cbf1682
commit 02f6203dc7
16 changed files with 270 additions and 58 deletions
Download Patch File Download Diff File Expand all files Collapse all files
cli/testdata/coder_restart_--help.golden
Vendored
+11
View File
@@ -12,9 +12,15 @@ OPTIONS:
--build-option string-array, $CODER_BUILD_OPTION
Build option value in the format "name=value".
DEPRECATED: Use --ephemeral-parameter instead.
--build-options bool
Prompt for one-time build options defined with ephemeral parameters.
DEPRECATED: Use --prompt-ephemeral-parameters instead.
--ephemeral-parameter string-array, $CODER_EPHEMERAL_PARAMETER
Set the value of ephemeral parameters defined in the template. The
format is "name=value".
--parameter string-array, $CODER_RICH_PARAMETER
Rich parameter value in the format "name=value".
@@ -22,6 +28,11 @@ OPTIONS:
--parameter-default string-array, $CODER_RICH_PARAMETER_DEFAULT
Rich parameter default values in the format "name=value".
--prompt-ephemeral-parameters bool, $CODER_PROMPT_EPHEMERAL_PARAMETERS
Prompt to set values of ephemeral parameters defined in the template.
If a value has been set via --ephemeral-parameter, it will not be
prompted for.
--rich-parameter-file string, $CODER_RICH_PARAMETER_FILE
Specify a file path with values for rich parameters defined in the
template. The file should be in YAML format, containing key-value
cli/testdata/coder_start_--help.golden
Vendored
+11
View File
@@ -12,9 +12,15 @@ OPTIONS:
--build-option string-array, $CODER_BUILD_OPTION
Build option value in the format "name=value".
DEPRECATED: Use --ephemeral-parameter instead.
--build-options bool
Prompt for one-time build options defined with ephemeral parameters.
DEPRECATED: Use --prompt-ephemeral-parameters instead.
--ephemeral-parameter string-array, $CODER_EPHEMERAL_PARAMETER
Set the value of ephemeral parameters defined in the template. The
format is "name=value".
--parameter string-array, $CODER_RICH_PARAMETER
Rich parameter value in the format "name=value".
@@ -22,6 +28,11 @@ OPTIONS:
--parameter-default string-array, $CODER_RICH_PARAMETER_DEFAULT
Rich parameter default values in the format "name=value".
--prompt-ephemeral-parameters bool, $CODER_PROMPT_EPHEMERAL_PARAMETERS
Prompt to set values of ephemeral parameters defined in the template.
If a value has been set via --ephemeral-parameter, it will not be
prompted for.
--rich-parameter-file string, $CODER_RICH_PARAMETER_FILE
Specify a file path with values for rich parameters defined in the
template. The file should be in YAML format, containing key-value
cli/testdata/coder_update_--help.golden
Vendored
+11
View File
@@ -14,9 +14,15 @@ OPTIONS:
--build-option string-array, $CODER_BUILD_OPTION
Build option value in the format "name=value".
DEPRECATED: Use --ephemeral-parameter instead.
--build-options bool
Prompt for one-time build options defined with ephemeral parameters.
DEPRECATED: Use --prompt-ephemeral-parameters instead.
--ephemeral-parameter string-array, $CODER_EPHEMERAL_PARAMETER
Set the value of ephemeral parameters defined in the template. The
format is "name=value".
--parameter string-array, $CODER_RICH_PARAMETER
Rich parameter value in the format "name=value".
@@ -24,6 +30,11 @@ OPTIONS:
--parameter-default string-array, $CODER_RICH_PARAMETER_DEFAULT
Rich parameter default values in the format "name=value".
--prompt-ephemeral-parameters bool, $CODER_PROMPT_EPHEMERAL_PARAMETERS
Prompt to set values of ephemeral parameters defined in the template.
If a value has been set via --ephemeral-parameter, it will not be
prompted for.
--rich-parameter-file string, $CODER_RICH_PARAMETER_FILE
Specify a file path with values for rich parameters defined in the
template. The file should be in YAML format, containing key-value