Skip to content

Commit 9be9acd

Browse files
kylecarbskylecarbs
committed
chore: Rename Projects to Templates
Customer feedback indicated projects was a confusing name. After querying the team internally, it seemed unanimous that it is indeed a confusing name. Here's for a lil less confusion @ashmeer7 🥂
1 parent 1e9e5f7 commit 9be9acd

File tree

85 files changed

+2506
-2505
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

85 files changed

+2506
-2505
lines changed

‎cli/clitest/clitest.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,9 @@ func SetupConfig(t *testing.T, client *codersdk.Client, root config.Root) {
3636
require.NoError(t, err)
3737
}
3838

39-
// CreateProjectVersionSource writes the echo provisioner responses into a
39+
// CreateTemplateVersionSource writes the echo provisioner responses into a
4040
// new temporary testing directory.
41-
func CreateProjectVersionSource(t *testing.T, responses *echo.Responses) string {
41+
func CreateTemplateVersionSource(t *testing.T, responses *echo.Responses) string {
4242
directory := t.TempDir()
4343
data, err := echo.Tar(responses)
4444
require.NoError(t, err)

‎cli/clitest/clitest_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ func TestMain(m *testing.M) {
1717

1818
func TestCli(t *testing.T) {
1919
t.Parallel()
20-
clitest.CreateProjectVersionSource(t, nil)
20+
clitest.CreateTemplateVersionSource(t, nil)
2121
client := coderdtest.New(t, nil)
2222
cmd, config := clitest.New(t)
2323
clitest.SetupConfig(t, client, config)

‎cli/cliui/parameter.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import (
1010
"github.com/coder/coder/codersdk"
1111
)
1212

13-
func ParameterSchema(cmd *cobra.Command, parameterSchema codersdk.ProjectVersionParameterSchema) (string, error) {
13+
func ParameterSchema(cmd *cobra.Command, parameterSchema codersdk.TemplateVersionParameterSchema) (string, error) {
1414
_, _ = fmt.Fprintln(cmd.OutOrStdout(), Styles.Bold.Render("var."+parameterSchema.Name))
1515
if parameterSchema.Description != "" {
1616
_, _ = fmt.Fprintln(cmd.OutOrStdout(), " "+strings.TrimSpace(strings.Join(strings.Split(parameterSchema.Description, "\n"), "\n "))+"\n")

‎cli/configssh_test.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@ func TestConfigSSH(t *testing.T) {
1919
client := coderdtest.New(t, nil)
2020
user := coderdtest.CreateFirstUser(t, client)
2121
coderdtest.NewProvisionerDaemon(t, client)
22-
version := coderdtest.CreateProjectVersion(t, client, user.OrganizationID, nil)
23-
coderdtest.AwaitProjectVersionJob(t, client, version.ID)
24-
project := coderdtest.CreateProject(t, client, user.OrganizationID, version.ID)
25-
workspace := coderdtest.CreateWorkspace(t, client, codersdk.Me, project.ID)
22+
version := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, nil)
23+
coderdtest.AwaitTemplateVersionJob(t, client, version.ID)
24+
template := coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID)
25+
workspace := coderdtest.CreateWorkspace(t, client, codersdk.Me, template.ID)
2626
coderdtest.AwaitWorkspaceBuildJob(t, client, workspace.LatestBuild.ID)
2727
tempFile, err := os.CreateTemp(t.TempDir(), "")
2828
require.NoError(t, err)

‎cli/login.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ func login() *cobra.Command {
150150
cliui.Styles.Paragraph.Render(fmt.Sprintf("Welcome to Coder, %s! You're authenticated.", cliui.Styles.Keyword.Render(username)))+"\n")
151151

152152
_, _ = fmt.Fprintf(cmd.OutOrStdout(),
153-
cliui.Styles.Paragraph.Render("Get started by creating a project: "+cliui.Styles.Code.Render("coder projects create"))+"\n")
153+
cliui.Styles.Paragraph.Render("Get started by creating a template: "+cliui.Styles.Code.Render("coder templates create"))+"\n")
154154
return nil
155155
}
156156

‎cli/parameters.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -39,12 +39,12 @@ func parseScopeAndID(ctx context.Context, client *codersdk.Client, organization
3939
}
4040
scopeID = org.ID
4141
}
42-
case codersdk.ParameterProject:
43-
project, err := client.ProjectByName(ctx, organization.ID, name)
42+
case codersdk.ParameterTemplate:
43+
template, err := client.TemplateByName(ctx, organization.ID, name)
4444
if err != nil {
4545
return scope, uuid.Nil, err
4646
}
47-
scopeID = project.ID
47+
scopeID = template.ID
4848
case codersdk.ParameterUser:
4949
uid, _ := uuid.Parse(name)
5050
user, err := client.User(ctx, uid)
@@ -67,8 +67,8 @@ func parseParameterScope(scope string) (codersdk.ParameterScope, error) {
6767
switch scope {
6868
case string(codersdk.ParameterOrganization):
6969
return codersdk.ParameterOrganization, nil
70-
case string(codersdk.ParameterProject):
71-
return codersdk.ParameterProject, nil
70+
case string(codersdk.ParameterTemplate):
71+
return codersdk.ParameterTemplate, nil
7272
case string(codersdk.ParameterUser):
7373
return codersdk.ParameterUser, nil
7474
case string(codersdk.ParameterWorkspace):

‎cli/projectcreate.go

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,15 @@ import (
2020
"github.com/coder/coder/provisionersdk"
2121
)
2222

23-
func projectCreate() *cobra.Command {
23+
func templateCreate() *cobra.Command {
2424
var (
2525
yes bool
2626
directory string
2727
provisioner string
2828
)
2929
cmd := &cobra.Command{
3030
Use: "create [name]",
31-
Short: "Create a project from the current directory",
31+
Short: "Create a template from the current directory",
3232
RunE: func(cmd *cobra.Command, args []string) error {
3333
client, err := createClient(cmd)
3434
if err != nil {
@@ -39,15 +39,15 @@ func projectCreate() *cobra.Command {
3939
return err
4040
}
4141

42-
var projectName string
42+
var templateName string
4343
if len(args) == 0 {
44-
projectName = filepath.Base(directory)
44+
templateName = filepath.Base(directory)
4545
} else {
46-
projectName = args[0]
46+
templateName = args[0]
4747
}
48-
_, err = client.ProjectByName(cmd.Context(), organization.ID, projectName)
48+
_, err = client.TemplateByName(cmd.Context(), organization.ID, templateName)
4949
if err == nil {
50-
return xerrors.Errorf("A project already exists named %q!", projectName)
50+
return xerrors.Errorf("A template already exists named %q!", templateName)
5151
}
5252

5353
spin := spinner.New(spinner.CharSets[5], 100*time.Millisecond)
@@ -69,14 +69,14 @@ func projectCreate() *cobra.Command {
6969
spin = spinner.New(spinner.CharSets[5], 100*time.Millisecond)
7070
spin.Writer = cmd.OutOrStdout()
7171
spin.Suffix = cliui.Styles.Keyword.Render("Something")
72-
job, parameters, err := createValidProjectVersion(cmd, client, organization, database.ProvisionerType(provisioner), resp.Hash)
72+
job, parameters, err := createValidTemplateVersion(cmd, client, organization, database.ProvisionerType(provisioner), resp.Hash)
7373
if err != nil {
7474
return err
7575
}
7676

7777
if !yes {
7878
_, err = cliui.Prompt(cmd, cliui.PromptOptions{
79-
Text: "Create project?",
79+
Text: "Create template?",
8080
IsConfirm: true,
8181
Default: "yes",
8282
})
@@ -88,16 +88,16 @@ func projectCreate() *cobra.Command {
8888
}
8989
}
9090

91-
_, err = client.CreateProject(cmd.Context(), organization.ID, codersdk.CreateProjectRequest{
92-
Name: projectName,
91+
_, err = client.CreateTemplate(cmd.Context(), organization.ID, codersdk.CreateTemplateRequest{
92+
Name: templateName,
9393
VersionID: job.ID,
9494
ParameterValues: parameters,
9595
})
9696
if err != nil {
9797
return err
9898
}
9999

100-
_, _ = fmt.Fprintf(cmd.OutOrStdout(), "The %s project has been created!\n", projectName)
100+
_, _ = fmt.Fprintf(cmd.OutOrStdout(), "The %s template has been created!\n", templateName)
101101
return nil
102102
},
103103
}
@@ -113,9 +113,9 @@ func projectCreate() *cobra.Command {
113113
return cmd
114114
}
115115

116-
func createValidProjectVersion(cmd *cobra.Command, client *codersdk.Client, organization codersdk.Organization, provisioner database.ProvisionerType, hash string, parameters ...codersdk.CreateParameterRequest) (*codersdk.ProjectVersion, []codersdk.CreateParameterRequest, error) {
116+
func createValidTemplateVersion(cmd *cobra.Command, client *codersdk.Client, organization codersdk.Organization, provisioner database.ProvisionerType, hash string, parameters ...codersdk.CreateParameterRequest) (*codersdk.TemplateVersion, []codersdk.CreateParameterRequest, error) {
117117
before := time.Now()
118-
version, err := client.CreateProjectVersion(cmd.Context(), organization.ID, codersdk.CreateProjectVersionRequest{
118+
version, err := client.CreateTemplateVersion(cmd.Context(), organization.ID, codersdk.CreateTemplateVersionRequest{
119119
StorageMethod: database.ProvisionerStorageMethodFile,
120120
StorageSource: hash,
121121
Provisioner: provisioner,
@@ -127,51 +127,51 @@ func createValidProjectVersion(cmd *cobra.Command, client *codersdk.Client, orga
127127

128128
err = cliui.ProvisionerJob(cmd.Context(), cmd.OutOrStdout(), cliui.ProvisionerJobOptions{
129129
Fetch: func() (codersdk.ProvisionerJob, error) {
130-
version, err := client.ProjectVersion(cmd.Context(), version.ID)
130+
version, err := client.TemplateVersion(cmd.Context(), version.ID)
131131
return version.Job, err
132132
},
133133
Cancel: func() error {
134-
return client.CancelProjectVersion(cmd.Context(), version.ID)
134+
return client.CancelTemplateVersion(cmd.Context(), version.ID)
135135
},
136136
Logs: func() (<-chan codersdk.ProvisionerJobLog, error) {
137-
return client.ProjectVersionLogsAfter(cmd.Context(), version.ID, before)
137+
return client.TemplateVersionLogsAfter(cmd.Context(), version.ID, before)
138138
},
139139
})
140140
if err != nil {
141141
if !provisionerd.IsMissingParameterError(err.Error()) {
142142
return nil, nil, err
143143
}
144144
}
145-
version, err = client.ProjectVersion(cmd.Context(), version.ID)
145+
version, err = client.TemplateVersion(cmd.Context(), version.ID)
146146
if err != nil {
147147
return nil, nil, err
148148
}
149-
parameterSchemas, err := client.ProjectVersionSchema(cmd.Context(), version.ID)
149+
parameterSchemas, err := client.TemplateVersionSchema(cmd.Context(), version.ID)
150150
if err != nil {
151151
return nil, nil, err
152152
}
153-
parameterValues, err := client.ProjectVersionParameters(cmd.Context(), version.ID)
153+
parameterValues, err := client.TemplateVersionParameters(cmd.Context(), version.ID)
154154
if err != nil {
155155
return nil, nil, err
156156
}
157157

158158
if provisionerd.IsMissingParameterError(version.Job.Error) {
159-
valuesBySchemaID := map[string]codersdk.ProjectVersionParameter{}
159+
valuesBySchemaID := map[string]codersdk.TemplateVersionParameter{}
160160
for _, parameterValue := range parameterValues {
161161
valuesBySchemaID[parameterValue.SchemaID.String()] = parameterValue
162162
}
163163
sort.Slice(parameterSchemas, func(i, j int) bool {
164164
return parameterSchemas[i].Name < parameterSchemas[j].Name
165165
})
166-
missingSchemas := make([]codersdk.ProjectVersionParameterSchema, 0)
166+
missingSchemas := make([]codersdk.TemplateVersionParameterSchema, 0)
167167
for _, parameterSchema := range parameterSchemas {
168168
_, ok := valuesBySchemaID[parameterSchema.ID.String()]
169169
if ok {
170170
continue
171171
}
172172
missingSchemas = append(missingSchemas, parameterSchema)
173173
}
174-
_, _ = fmt.Fprintln(cmd.OutOrStdout(), cliui.Styles.Paragraph.Render("This project has required variables! They are scoped to the project, and not viewable after being set.")+"\r\n")
174+
_, _ = fmt.Fprintln(cmd.OutOrStdout(), cliui.Styles.Paragraph.Render("This template has required variables! They are scoped to the template, and not viewable after being set.")+"\r\n")
175175
for _, parameterSchema := range missingSchemas {
176176
value, err := cliui.ParameterSchema(cmd, parameterSchema)
177177
if err != nil {
@@ -185,18 +185,18 @@ func createValidProjectVersion(cmd *cobra.Command, client *codersdk.Client, orga
185185
})
186186
_, _ = fmt.Fprintln(cmd.OutOrStdout())
187187
}
188-
return createValidProjectVersion(cmd, client, organization, provisioner, hash, parameters...)
188+
return createValidTemplateVersion(cmd, client, organization, provisioner, hash, parameters...)
189189
}
190190

191191
if version.Job.Status != codersdk.ProvisionerJobSucceeded {
192192
return nil, nil, xerrors.New(version.Job.Error)
193193
}
194194

195-
_, _ = fmt.Fprintf(cmd.OutOrStdout(), cliui.Styles.Checkmark.String()+" Successfully imported project source!\n")
195+
_, _ = fmt.Fprintf(cmd.OutOrStdout(), cliui.Styles.Checkmark.String()+" Successfully imported template source!\n")
196196

197-
resources, err := client.ProjectVersionResources(cmd.Context(), version.ID)
197+
resources, err := client.TemplateVersionResources(cmd.Context(), version.ID)
198198
if err != nil {
199199
return nil, nil, err
200200
}
201-
return &version, parameters, displayProjectVersionInfo(cmd, resources)
201+
return &version, parameters, displayTemplateVersionInfo(cmd, resources)
202202
}

‎cli/projectcreate_test.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,17 @@ import (
1212
"github.com/coder/coder/pty/ptytest"
1313
)
1414

15-
func TestProjectCreate(t *testing.T) {
15+
func TestTemplateCreate(t *testing.T) {
1616
t.Parallel()
1717
t.Run("Create", func(t *testing.T) {
1818
t.Parallel()
1919
client := coderdtest.New(t, nil)
2020
coderdtest.CreateFirstUser(t, client)
21-
source := clitest.CreateProjectVersionSource(t, &echo.Responses{
21+
source := clitest.CreateTemplateVersionSource(t, &echo.Responses{
2222
Parse: echo.ParseComplete,
2323
Provision: echo.ProvisionComplete,
2424
})
25-
cmd, root := clitest.New(t, "projects", "create", "my-project", "--directory", source, "--provisioner", string(database.ProvisionerTypeEcho))
25+
cmd, root := clitest.New(t, "templates", "create", "my-template", "--directory", source, "--provisioner", string(database.ProvisionerTypeEcho))
2626
clitest.SetupConfig(t, client, root)
2727
_ = coderdtest.NewProvisionerDaemon(t, client)
2828
doneChan := make(chan struct{})
@@ -35,7 +35,7 @@ func TestProjectCreate(t *testing.T) {
3535
require.NoError(t, err)
3636
}()
3737
matches := []string{
38-
"Create project?", "yes",
38+
"Create template?", "yes",
3939
}
4040
for i := 0; i < len(matches); i += 2 {
4141
match := matches[i]

‎cli/projectedit.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ package cli
22

33
import "github.com/spf13/cobra"
44

5-
func projectEdit() *cobra.Command {
5+
func templateEdit() *cobra.Command {
66
return &cobra.Command{
77
Use: "edit",
88
RunE: func(cmd *cobra.Command, args []string) error {

‎cli/projectinit.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@ import (
1212
"github.com/coder/coder/provisionersdk"
1313
)
1414

15-
func projectInit() *cobra.Command {
15+
func templateInit() *cobra.Command {
1616
return &cobra.Command{
1717
Use: "init [directory]",
18-
Short: "Get started with a templated project.",
18+
Short: "Get started with a templated template.",
1919
RunE: func(cmd *cobra.Command, args []string) error {
2020
exampleList, err := examples.List()
2121
if err != nil {
@@ -28,7 +28,7 @@ func projectInit() *cobra.Command {
2828
exampleByName[example.Name] = example
2929
}
3030

31-
_, _ = fmt.Fprintln(cmd.OutOrStdout(), cliui.Styles.Wrap.Render("Projects contain Infrastructure as Code that works with Coder to provision development workspaces. Get started by selecting an example:\n"))
31+
_, _ = fmt.Fprintln(cmd.OutOrStdout(), cliui.Styles.Wrap.Render("Templates contain Infrastructure as Code that works with Coder to provision development workspaces. Get started by selecting an example:\n"))
3232
option, err := cliui.Select(cmd, cliui.SelectOptions{
3333
Options: exampleNames,
3434
})
@@ -66,7 +66,7 @@ func projectInit() *cobra.Command {
6666
return err
6767
}
6868
_, _ = fmt.Fprintln(cmd.OutOrStdout(), cliui.Styles.Prompt.String()+"Inside that directory, get started by running:")
69-
_, _ = fmt.Fprintln(cmd.OutOrStdout(), cliui.Styles.Paragraph.Render(cliui.Styles.Code.Render("coder projects create"))+"\n")
69+
_, _ = fmt.Fprintln(cmd.OutOrStdout(), cliui.Styles.Paragraph.Render(cliui.Styles.Code.Render("coder templates create"))+"\n")
7070
return nil
7171
},
7272
}

0 commit comments

Comments
 (0)