Skip to content

Commit 633dfbd

Browse files
mtojekKira-Pilot
mtojek
and
Kira-Pilot
authored
feat: rich parameters: introduce display_name (#6919)
* model * DB * fix: DisplayName * proto * Proto * Update go dep * fixme * fix format * config * fmt * fix * Fix * fix * chore(UI): redirecting from workspace page if 404 (#6880) * model * CLI: Display parameter * fix * update dep * fix * fix * fix * UI changes * fmt --------- Co-authored-by: Kira Pilot <kira@coder.com>
1 parent d9d44c1 commit 633dfbd

25 files changed

+370
-297
lines changed

‎cli/cliui/parameter.go

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,12 @@ func ParameterSchema(inv *clibase.Invocation, parameterSchema codersdk.Parameter
6262
}
6363

6464
func RichParameter(inv *clibase.Invocation, templateVersionParameter codersdk.TemplateVersionParameter) (string, error) {
65-
_, _ = fmt.Fprintln(inv.Stdout, Styles.Bold.Render(templateVersionParameter.Name))
65+
label := templateVersionParameter.Name
66+
if templateVersionParameter.DisplayName != "" {
67+
label = templateVersionParameter.DisplayName
68+
}
69+
70+
_, _ = fmt.Fprintln(inv.Stdout, Styles.Bold.Render(label))
6671
if templateVersionParameter.DescriptionPlaintext != "" {
6772
_, _ = fmt.Fprintln(inv.Stdout, " "+strings.TrimSpace(strings.Join(strings.Split(templateVersionParameter.DescriptionPlaintext, "\n"), "\n "))+"\n")
6873
}

‎cli/create_test.go

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -366,6 +366,7 @@ func TestCreateWithRichParameters(t *testing.T) {
366366
firstParameterValue = "1"
367367

368368
secondParameterName = "second_parameter"
369+
secondParameterDisplayName = "Second Parameter"
369370
secondParameterDescription = "This is second parameter"
370371
secondParameterValue = "2"
371372

@@ -382,7 +383,7 @@ func TestCreateWithRichParameters(t *testing.T) {
382383
Complete: &proto.Provision_Complete{
383384
Parameters: []*proto.RichParameter{
384385
{Name: firstParameterName, Description: firstParameterDescription, Mutable: true},
385-
{Name: secondParameterName, Description: secondParameterDescription, Mutable: true},
386+
{Name: secondParameterName, DisplayName: secondParameterDisplayName, Description: secondParameterDescription, Mutable: true},
386387
{Name: immutableParameterName, Description: immutableParameterDescription, Mutable: false},
387388
},
388389
},
@@ -418,6 +419,7 @@ func TestCreateWithRichParameters(t *testing.T) {
418419

419420
matches := []string{
420421
firstParameterDescription, firstParameterValue,
422+
secondParameterDisplayName, "",
421423
secondParameterDescription, secondParameterValue,
422424
immutableParameterDescription, immutableParameterValue,
423425
"Confirm create?", "yes",
@@ -426,7 +428,10 @@ func TestCreateWithRichParameters(t *testing.T) {
426428
match := matches[i]
427429
value := matches[i+1]
428430
pty.ExpectMatch(match)
429-
pty.WriteLine(value)
431+
432+
if value != "" {
433+
pty.WriteLine(value)
434+
}
430435
}
431436
<-doneChan
432437
})

‎coderd/apidoc/docs.go

Lines changed: 3 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎coderd/apidoc/swagger.json

Lines changed: 3 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎coderd/database/dbfake/databasefake.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2944,6 +2944,7 @@ func (q *fakeQuerier) InsertTemplateVersionParameter(_ context.Context, arg data
29442944
param := database.TemplateVersionParameter{
29452945
TemplateVersionID: arg.TemplateVersionID,
29462946
Name: arg.Name,
2947+
DisplayName: arg.DisplayName,
29472948
Description: arg.Description,
29482949
Type: arg.Type,
29492950
Mutable: arg.Mutable,

‎coderd/database/dump.sql

Lines changed: 3 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎coderd/database/migrations/000112_rich_parameter_display_name.down.sql

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
ALTER TABLE template_version_parameters DROP COLUMN display_name;

‎coderd/database/migrations/000112_rich_parameter_display_name.up.sql

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
ALTER TABLE template_version_parameters ADD COLUMN display_name text NOT NULL DEFAULT '';
2+
3+
COMMENT ON COLUMN template_version_parameters.display_name
4+
IS 'Display name of the rich parameter';

‎coderd/database/models.go

Lines changed: 2 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎coderd/database/queries.sql.go

Lines changed: 10 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)