Skip to content

feat(cli): support ephemeral parameters #8415

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 14 commits into from
Jul 13, 2023
Merged

feat(cli): support ephemeral parameters #8415

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
e8424b2
Skip ephemeral parameters while creating/updating the workspace
mtojek Jul 11, 2023
8980fce
golden updates
mtojek Jul 11, 2023
4e58e17
build option is yellow
mtojek Jul 11, 2023
3baef18
make gen
mtojek Jul 11, 2023
0a7578c
Unit tests for build options
mtojek Jul 11, 2023
fdea6b2
Start with options
mtojek Jul 11, 2023
009a534
unit tests for start
mtojek Jul 11, 2023
2bdcf27
Restart workspace
mtojek Jul 11, 2023
dbd29db
unit tests for restart
mtojek Jul 11, 2023
9e5a074
Use workspaceBuildFlags
mtojek Jul 13, 2023
1d28bb4
templateVersionParameter.Mutable
mtojek Jul 13, 2023
1591615
return nil
mtojek Jul 13, 2023
6fd3da5
Verify if build option is set
mtojek Jul 13, 2023
fb6d5a1
docs
mtojek Jul 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
golden updates
  • Loading branch information
@mtojek
mtojek committed Jul 11, 2023
commit 8980fcefed8febeaae3b47e9b8857625739c219b
8 changes: 8 additions & 0 deletions cli/create.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ func (r *RootCmd) create() *clibase.Cmd {
startAt string
stopAfter time.Duration
workspaceName string
buildOptions bool
)
client := new(codersdk.Client)
cmd := &clibase.Cmd{
Expand Down Expand Up @@ -123,6 +124,7 @@ func (r *RootCmd) create() *clibase.Cmd {
Template: template,
RichParameterFile: richParameterFile,
NewWorkspaceName: workspaceName,
BuildOptions: buildOptions,
})
if err != nil {
return xerrors.Errorf("prepare build: %w", err)
Expand Down Expand Up @@ -189,6 +191,11 @@ func (r *RootCmd) create() *clibase.Cmd {
Description: "Specify a duration after which the workspace should shut down (e.g. 8h).",
Value: clibase.DurationOf(&stopAfter),
},
clibase.Option{
Flag: "build-options",
Description: "Prompt for one-time build options defined with ephemeral parameters.",
Value: clibase.BoolOf(&buildOptions),
},
cliui.SkipPromptOption(),
)

Expand All @@ -202,6 +209,7 @@ type prepWorkspaceBuildArgs struct {
NewWorkspaceName string

UpdateWorkspace bool
BuildOptions bool
WorkspaceID uuid.UUID
}

Expand Down
3 changes: 3 additions & 0 deletions cli/testdata/coder_create_--help.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ Usage: coder create [flags] [name]
Create a workspace

Options
--build-options bool
Prompt for one-time build options defined with ephemeral parameters.

--rich-parameter-file string, $CODER_RICH_PARAMETER_FILE
Specify a file path with values for rich parameters defined in the
template.
Expand Down
3 changes: 3 additions & 0 deletions cli/testdata/coder_update_--help.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ Use --always-prompt to change the parameter values of the workspace.
Always prompt all parameters. Does not pull parameter values from
existing workspace.

--build-options bool
Prompt for one-time build options defined with ephemeral parameters.

--rich-parameter-file string, $CODER_RICH_PARAMETER_FILE
Specify a file path with values for rich parameters defined in the
template.
Expand Down
11 changes: 9 additions & 2 deletions cli/update.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ func (r *RootCmd) update() *clibase.Cmd {
var (
richParameterFile string
alwaysPrompt bool
buildOptions bool
)

client := new(codersdk.Client)
Expand Down Expand Up @@ -53,6 +54,8 @@ func (r *RootCmd) update() *clibase.Cmd {

UpdateWorkspace: true,
WorkspaceID: workspace.LatestBuild.ID,

BuildOptions: buildOptions,
})
if err != nil {
return nil
Expand Down Expand Up @@ -86,15 +89,19 @@ func (r *RootCmd) update() *clibase.Cmd {
{
Flag: "always-prompt",
Description: "Always prompt all parameters. Does not pull parameter values from existing workspace.",

Value: clibase.BoolOf(&alwaysPrompt),
Value: clibase.BoolOf(&alwaysPrompt),
},
{
Flag: "rich-parameter-file",
Description: "Specify a file path with values for rich parameters defined in the template.",
Env: "CODER_RICH_PARAMETER_FILE",
Value: clibase.StringOf(&richParameterFile),
},
{
Flag: "build-options",
Description: "Prompt for one-time build options defined with ephemeral parameters.",
Value: clibase.BoolOf(&buildOptions),
},
}
return cmd
}