diff --git a/.coder.yaml b/.coder.yaml new file mode 100644 index 0000000..abdc589 --- /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: 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 +# 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}}" diff --git a/plugins/backstage-plugin-coder/README.md b/plugins/backstage-plugin-coder/README.md index 657521e..5ccc64a 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. @@ -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 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 34fd72b..cb3d9b5 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`