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

chore(cli): rename build options to ephemeral parameters in cli (#15030)

Browse Source 
This PR aims to rename `build-option` to `ephemeral-parameters` based on
#10488 conversation.

`build-option` has been renamed `ephemeral-parameter` and can be used to
define a value for an ephemeral parameter in the template.

`build-options` has been renamed `prompt-ephemeral-parameters` and can
be used to prompt the user to put values for the ephemeral parameters in
the template.

---------

Co-authored-by: Mathias Fredriksson <mafredri@gmail.com>
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com>
Co-authored-by: defelmnq <yvincent@coder.com>
This commit is contained in:
Vincent Vielle
2024-10-16 23:54:12 +02:00
committed by GitHub
co-authored by Mathias Fredriksson EdwardAngert defelmnq
parent 512cbf1682
commit 02f6203dc7
16 changed files with 270 additions and 58 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/admin/templates/extending-templates/parameters.md
+5 -4
View File
@@ -204,10 +204,11 @@ operational issue, but it is not advised to overuse this opportunity.
## Ephemeral parameters
Ephemeral parameters are introduced to users in the form of "build options." Use
ephemeral parameters to model specific behaviors in a Coder workspace, such as
reverting to a previous image, restoring from a volume snapshot, or building a
project without using cache.
Ephemeral parameters are introduced to users in order to model specific
behaviors in a Coder workspace, such as reverting to a previous image, restoring
from a volume snapshot, or building a project without using cache. These
parameters are only settable when starting, updating, or restarting a workspace
and do not persist after the workspace is stopped.
Since these parameters are ephemeral in nature, subsequent builds proceed in the
standard manner:
docs/reference/cli/restart.md
Generated
+18
View File
@@ -37,6 +37,24 @@ Build option value in the format "name=value".
Prompt for one-time build options defined with ephemeral parameters.
### --ephemeral-parameter
| | |
| ----------- | --------------------------------------- |
| Type | <code>string-array</code> |
| Environment | <code>$CODER_EPHEMERAL_PARAMETER</code> |
Set the value of ephemeral parameters defined in the template. The format is "name=value".
### --prompt-ephemeral-parameters
| | |
| ----------- | ----------------------------------------------- |
| Type | <code>bool</code> |
| Environment | <code>$CODER_PROMPT_EPHEMERAL_PARAMETERS</code> |
Prompt to set values of ephemeral parameters defined in the template. If a value has been set via --ephemeral-parameter, it will not be prompted for.
### --parameter
| | |
docs/reference/cli/start.md
Generated
+18
View File
@@ -37,6 +37,24 @@ Build option value in the format "name=value".
Prompt for one-time build options defined with ephemeral parameters.
### --ephemeral-parameter
| | |
| ----------- | --------------------------------------- |
| Type | <code>string-array</code> |
| Environment | <code>$CODER_EPHEMERAL_PARAMETER</code> |
Set the value of ephemeral parameters defined in the template. The format is "name=value".
### --prompt-ephemeral-parameters
| | |
| ----------- | ----------------------------------------------- |
| Type | <code>bool</code> |
| Environment | <code>$CODER_PROMPT_EPHEMERAL_PARAMETERS</code> |
Prompt to set values of ephemeral parameters defined in the template. If a value has been set via --ephemeral-parameter, it will not be prompted for.
### --parameter
| | |
docs/reference/cli/update.md
Generated
+18
View File
@@ -35,6 +35,24 @@ Build option value in the format "name=value".
Prompt for one-time build options defined with ephemeral parameters.
### --ephemeral-parameter
| | |
| ----------- | --------------------------------------- |
| Type | <code>string-array</code> |
| Environment | <code>$CODER_EPHEMERAL_PARAMETER</code> |
Set the value of ephemeral parameters defined in the template. The format is "name=value".
### --prompt-ephemeral-parameters
| | |
| ----------- | ----------------------------------------------- |
| Type | <code>bool</code> |
| Environment | <code>$CODER_PROMPT_EPHEMERAL_PARAMETERS</code> |
Prompt to set values of ephemeral parameters defined in the template. If a value has been set via --ephemeral-parameter, it will not be prompted for.
### --parameter
| | |
docs/tutorials/example-guide.md
+6 -7
View File
@@ -1,9 +1,9 @@
# Guide Title (Only Visible in Github)
<div>
<a href="https://github.com/<your_github_handle>" style="text-decoration: none; color: inherit;">
<a href="https://github.com/coder" style="text-decoration: none; color: inherit;">
<span style="vertical-align:middle;">Your Name</span>
<img src="https://github.com/ericpaulsen.png" width="24px" height="24px" style="vertical-align:middle; margin: 0px;"/>
<img src="https://github.com/coder.png" width="24px" height="24px" style="vertical-align:middle; margin: 0px;"/>
</a>
</div>
December 13, 2023
@@ -11,15 +11,14 @@ December 13, 2023
---
This is a guide on how to make Coder guides, it is not listed on our
[official guides page](https://coder.com/docs/guides) in the docs. Intended for
those who don't frequently contribute documentation changes to the `coder/coder`
[official tutorials page](../tutorials/index.md) in the docs. Intended for those
who don't frequently contribute documentation changes to the `coder/coder`
repository.
## Content
Defer to our
[Contributing/Documentation](https://coder.com/docs/contributing/documentation)
page for rules on technical writing.
Defer to our [Contributing/Documentation](../contributing/documentation.md) page
for rules on technical writing.
### Adding Photos