Skip to content

feat: add icon and description to preset #18977

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.

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 6 additions & 0 deletions coderd/apidoc/docs.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions coderd/apidoc/swagger.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 3 additions & 1 deletion coderd/database/dump.sql

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
ALTER TABLE template_version_presets
DROP COLUMN IF EXISTS description,
DROP COLUMN IF EXISTS icon;
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
ALTER TABLE template_version_presets
ADD COLUMN IF NOT EXISTS description text NOT NULL DEFAULT '',
ADD COLUMN IF NOT EXISTS icon text NOT NULL DEFAULT '';
2 changes: 2 additions & 0 deletions coderd/database/models.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

30 changes: 24 additions & 6 deletions coderd/database/queries.sql.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 6 additions & 2 deletions coderd/database/queries/presets.sql
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,9 @@ INSERT INTO template_version_presets (
desired_instances,
invalidate_after_secs,
scheduling_timezone,
is_default
is_default,
description,
icon
)
VALUES (
@id,
Expand All @@ -17,7 +19,9 @@ VALUES (
@desired_instances,
@invalidate_after_secs,
@scheduling_timezone,
@is_default
@is_default,
@description,
@icon
) RETURNING *;

-- name: InsertPresetParameters :many
Expand Down
8 changes: 5 additions & 3 deletions coderd/presets.go
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,11 @@ func (api *API) templateVersionPresets(rw http.ResponseWriter, r *http.Request)
var res []codersdk.Preset
for _, preset := range presets {
sdkPreset := codersdk.Preset{
ID: preset.ID,
Name: preset.Name,
Default: preset.IsDefault,
ID: preset.ID,
Name: preset.Name,
Default: preset.IsDefault,
Description: preset.Description,
Icon: preset.Icon,
}
for _, presetParam := range presetParams {
if presetParam.TemplateVersionPresetID != preset.ID {
Expand Down
3 changes: 3 additions & 0 deletions coderd/provisionerdserver/provisionerdserver.go
Original file line number Diff line number Diff line change
Expand Up @@ -2264,6 +2264,7 @@ func InsertWorkspacePresetAndParameters(ctx context.Context, db database.Store,
prebuildSchedules = protoPreset.Prebuild.Scheduling.Schedule
}
}

dbPreset, err := tx.InsertPreset(ctx, database.InsertPresetParams{
ID: uuid.New(),
TemplateVersionID: templateVersionID,
Expand All @@ -2273,6 +2274,8 @@ func InsertWorkspacePresetAndParameters(ctx context.Context, db database.Store,
InvalidateAfterSecs: ttl,
SchedulingTimezone: schedulingTimezone,
IsDefault: protoPreset.GetDefault(),
Description: protoPreset.Description,
Icon: protoPreset.Icon,
})
if err != nil {
return xerrors.Errorf("insert preset: %w", err)
Expand Down
10 changes: 6 additions & 4 deletions codersdk/presets.go
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,12 @@ import (
)

type Preset struct {
ID uuid.UUID
Name string
Parameters []PresetParameter
Default bool
ID uuid.UUID
Name string
Parameters []PresetParameter
Default bool
Description string
Icon string
}

type PresetParameter struct {
Expand Down
16 changes: 10 additions & 6 deletions docs/reference/api/schemas.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

22 changes: 13 additions & 9 deletions docs/reference/api/templates.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ replace github.com/aquasecurity/trivy => github.com/coder/trivy v0.0.0-202505271
replace github.com/spf13/afero => github.com/aslilac/afero v0.0.0-20250403163713-f06e86036696

// TODO: replace once we cut release.
replace github.com/coder/terraform-provider-coder/v2 => github.com/coder/terraform-provider-coder/v2 v2.7.1-0.20250623193313-e890833351e2
replace github.com/coder/terraform-provider-coder/v2 => /home/coder/terraform-provider-coder/

require (
cdr.dev/slog v1.6.2-0.20250703074222-9df5e0a6c145
Expand Down
2 changes: 0 additions & 2 deletions go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -930,8 +930,6 @@ github.com/coder/tailscale v1.1.1-0.20250611020837-f14d20d23d8c h1:d/qBIi3Ez7Kko
github.com/coder/tailscale v1.1.1-0.20250611020837-f14d20d23d8c/go.mod h1:l7ml5uu7lFh5hY28lGYM4b/oFSmuPHYX6uk4RAu23Lc=
github.com/coder/terraform-config-inspect v0.0.0-20250107175719-6d06d90c630e h1:JNLPDi2P73laR1oAclY6jWzAbucf70ASAvf5mh2cME0=
github.com/coder/terraform-config-inspect v0.0.0-20250107175719-6d06d90c630e/go.mod h1:Gz/z9Hbn+4KSp8A2FBtNszfLSdT2Tn/uAKGuVqqWmDI=
github.com/coder/terraform-provider-coder/v2 v2.7.1-0.20250623193313-e890833351e2 h1:vtGzECz5CyzuxMODexWdIRxhYLqyTcHafuJpH60PYhM=
github.com/coder/terraform-provider-coder/v2 v2.7.1-0.20250623193313-e890833351e2/go.mod h1:WrdLSbihuzH1RZhwrU+qmkqEhUbdZT/sjHHdarm5b5g=
github.com/coder/trivy v0.0.0-20250527170238-9416a59d7019 h1:MHkv/W7l9eRAN9gOG0qZ1TLRGWIIfNi92273vPAQ8Fs=
github.com/coder/trivy v0.0.0-20250527170238-9416a59d7019/go.mod h1:eqk+w9RLBmbd/cB5XfPZFuVn77cf/A6fB7qmEVeSmXk=
github.com/coder/websocket v1.8.13 h1:f3QZdXy7uGVz+4uCJy2nTZyM0yTBj8yANEHhqlXZ9FE=
Expand Down
6 changes: 4 additions & 2 deletions provisioner/terraform/resources.go
Original file line number Diff line number Diff line change
Expand Up @@ -958,8 +958,10 @@ func ConvertState(ctx context.Context, modules []*tfjson.StateModule, rawGraph s
}
}
protoPreset := &proto.Preset{
Name: preset.Name,
Parameters: presetParameters,
Name: preset.Name,
Icon: preset.Icon,
Description: preset.Description,
Parameters: presetParameters,
Prebuild: &proto.Prebuild{
Instances: prebuildInstances,
ExpirationPolicy: expirationPolicy,
Expand Down
Loading
Loading