From 136c71d3a0b7dfca7e7156ae62b588df3186946d Mon Sep 17 00:00:00 2001 From: BioErrorLog <51422347+bioerrorlog@users.noreply.github.com> Date: Thu, 11 Jul 2024 07:47:23 +0900 Subject: [PATCH 1/4] docs: fix broken api reference link (#136) --- plugins/backstage-plugin-coder/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugins/backstage-plugin-coder/README.md b/plugins/backstage-plugin-coder/README.md index 657521e2..ba7c6f02 100644 --- a/plugins/backstage-plugin-coder/README.md +++ b/plugins/backstage-plugin-coder/README.md @@ -142,7 +142,7 @@ spec: region: 'us-pittsburgh' ``` -You can find more information about what properties are available (and how they're applied) in our [`catalog-info.yaml` file documentation](./docs/catalog-info.md). +You can find more information about what properties are available (and how they're applied) in our [`catalog-info.yaml` file documentation](./docs/api-reference/catalog-info.md). ## Roadmap From ee842ec8ed7509dc0e29e6b967828c1e6b48dc17 Mon Sep 17 00:00:00 2001 From: BioErrorLog <51422347+bioerrorlog@users.noreply.github.com> Date: Thu, 11 Jul 2024 07:47:42 +0900 Subject: [PATCH 2/4] docs: fix incorrect descriptions in backstage-plugin-coder (#137) * docs: fix subtitle for catalog-info description * docs: fix incorrect reference --- plugins/backstage-plugin-coder/README.md | 2 +- .../backstage-plugin-coder/docs/api-reference/catalog-info.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/plugins/backstage-plugin-coder/README.md b/plugins/backstage-plugin-coder/README.md index ba7c6f02..5ccc64a5 100644 --- a/plugins/backstage-plugin-coder/README.md +++ b/plugins/backstage-plugin-coder/README.md @@ -117,7 +117,7 @@ the Dev Container. ); ``` -### `app-config.yaml` files +### `catalog-info.yaml` files In addition to the above, you can define additional properties on your specific repo's `catalog-info.yaml` file. diff --git a/plugins/backstage-plugin-coder/docs/api-reference/catalog-info.md b/plugins/backstage-plugin-coder/docs/api-reference/catalog-info.md index 34fd72b3..cb3d9b56 100644 --- a/plugins/backstage-plugin-coder/docs/api-reference/catalog-info.md +++ b/plugins/backstage-plugin-coder/docs/api-reference/catalog-info.md @@ -42,7 +42,7 @@ This defines the name of the Coder template you would like to use when creating **Note:** This value has overlap with the `defaultTemplateName` property defined in [`CoderAppConfig`](types.md#coderappconfig). In the event that both values are present, the YAML file's `templateName` property will always be used instead. -### `templateName` +### `mode` **Type:** Optional union of `manual` or `auto` From c59f3ec8d12c0d3a3dabc5b83fee67bdfe54ece4 Mon Sep 17 00:00:00 2001 From: Michael Smith Date: Thu, 18 Jul 2024 09:41:05 -0400 Subject: [PATCH 3/4] add .coder.yaml file (#138) --- .coder.yaml | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 .coder.yaml diff --git a/.coder.yaml b/.coder.yaml new file mode 100644 index 00000000..e334deda --- /dev/null +++ b/.coder.yaml @@ -0,0 +1,38 @@ +# .coder.yaml +# This is a Coder configuration file. It tells Coder how to create a workspace +# for this repository. You can use variables like {{org}}, {{repo}}, and {{ref}} +# to dynamically generate values. +# +# This configuration works well with Coder's git-clone module. To use it, you +# can add the following to your template: +# +# data "coder_parameter" "git_url" { +# type = "string" +# name = "Git URL" +# description = "The git repository URL to be cloned." +# default = "" +# mutable = true +# } +# +# module "git-clone" { +# source = "registry.coder.com/modules/git-clone/coder" +# version = "1.0.12" +# agent_id = +# url = data.coder_parameter.git_url.value +# } + +# Replace with your Coder deployment URL +host: dev.coder.com + +# Specify the Coder template for this repository +template: dogfood + +# Define a name for the new workspace using variables such as {{org}}, {{repo}}, +# and {{ref}} to dynamically generate values. This name is crucial as it is used +# to identify and potentially reuse an existing workspace within Coder. +name: {{repo}}-{{ref}} + +# Uncomment and use 'parameters' to override template defaults +# parameters: +# - name: "Git URL" +# value: "https://github.com/{{org}}/{{repo}}/tree/{{ref}}" From 9da52e6b2726c65205e6a23a6cd9821865cdad21 Mon Sep 17 00:00:00 2001 From: Michael Smith Date: Thu, 18 Jul 2024 09:46:49 -0400 Subject: [PATCH 4/4] fix: update base template name for .coder.yaml file (#139) --- .coder.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.coder.yaml b/.coder.yaml index e334deda..abdc589b 100644 --- a/.coder.yaml +++ b/.coder.yaml @@ -25,7 +25,7 @@ host: dev.coder.com # Specify the Coder template for this repository -template: dogfood +template: coder # Define a name for the new workspace using variables such as {{org}}, {{repo}}, # and {{ref}} to dynamically generate values. This name is crucial as it is used