opensource/coder
3
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2026-09-24 15:04:27 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: incompatibility in parameter options for workspace builds (#9297)

Browse Source
This commit is contained in:
Marcin Tojek
2023-08-24 11:05:31 +02:00
committed by GitHub
parent 113894c045
commit 52ea23355a
1 changed files with 15 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/templates/parameters.md
Vendored
+15
View File
@@ -103,6 +103,21 @@ data "coder_parameter" "docker_host" {
}
```
### Incompatibility in Parameter Options for Workspace Builds
When creating Coder templates, authors have the flexibility to modify parameter
options associated with rich parameters. Such modifications can involve adding,
substituting, or removing a parameter option. It's important to note that making
these changes can lead to discrepancies in parameter values utilized by ongoing
workspace builds.
Consequently, workspace users will be prompted to select the new value from a
pop-up window or by using the command-line interface. While this additional
interactive step might seem like an interruption, it serves a crucial purpose.
It prevents workspace users from becoming trapped with outdated template
versions, ensuring they can smoothly update their workspace without any
hindrances.
## Required and optional parameters
A parameter is considered to be _required_ if it doesn't have the `default`