Skip to content

Commit f21533d

Browse files
committed
docs: regenerate docs
1 parent ff810ee commit f21533d

File tree

8 files changed

+93
-5
lines changed

8 files changed

+93
-5
lines changed

docs/versioned_docs/version-5.18/commands/devspace_sync.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,11 @@ devspace sync --container-path=/my-path
4444
--no-watch Synchronizes local and remote and then stops
4545
--pick Select a pod (default true)
4646
--pod string Pod to sync to
47+
--polling bool If polling should be used to detect file changes in the container
4748
--upload-only If set DevSpace will only upload files
4849
--verbose Shows every file that is synced
50+
--wait Wait for the pod(s) to start if they are not running
51+
4952
```
5053

5154

@@ -69,4 +72,3 @@ devspace sync --container-path=/my-path
6972
--var strings Variables to override during execution (e.g. --var=MYVAR=MYVALUE)
7073
--vars-secret string The secret to restore/save the variables from/to, if --restore-vars or --save-vars is enabled (default "devspace-vars")
7174
```
72-

docs/versioned_docs/version-5.18/configuration/dependencies/git-repository.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ dependencies:
3636
ports: true
3737
dev:
3838
terminal:
39-
imageName: api-server.server-image
39+
imageSelector: ${runtime.dependencies.api-server.images.server-image}
4040
```
4141
4242
:::info Authentication

docs/versioned_docs/version-5.18/configuration/variables/runtime-variables.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ dev:
7373
# Will open a terminal to the pod with the
7474
# image from dep1
7575
terminal:
76-
imageName: ${runtime.dependencies.dep1.images.image1}
76+
imageSelector: ${runtime.dependencies.dep1.images.image1}
7777
```
7878
7979
</TabItem>
@@ -124,5 +124,5 @@ dev:
124124
# Will open a terminal to the pod with the
125125
# image from dep1
126126
terminal:
127-
imageName: ${runtime.dependencies.dep1.images.image1}
127+
imageSelector: ${runtime.dependencies.dep1.images.image1}
128128
```

docs/versioned_docs/version-5.18/configuration/variables/source-command.mdx

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,4 +88,26 @@ vars:
8888

8989
### `default`
9090

91-
If the command returns nothing, this is the value that will be used for this variable.
91+
If the command returns nothing, this is the value that will be used for this variable.
92+
93+
### `alwaysResolve`
94+
95+
If enabled, the variable will be loaded even though it is not used within the config. This might be useful for variables that should be resolved after a config expression is applied. E.g.:
96+
97+
`devspace.yaml`:
98+
```
99+
vars:
100+
- name: my-var
101+
value: my-value
102+
alwaysResolve: true
103+
hooks:
104+
- name: my-hook
105+
command: $(cat command.txt)
106+
events: ["after:deploy"]
107+
```
108+
109+
`command.txt`:
110+
```
111+
echo Hello ${my-var}!
112+
```
113+

docs/versioned_docs/version-5.18/configuration/variables/source-env.mdx

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,3 +34,24 @@ If `source` is `env` and the environment variable is **not** defined, DevSpace w
3434
### `default`
3535

3636
<FragmentVarsDefault/>
37+
38+
### `alwaysResolve`
39+
40+
If enabled, the variable will be loaded even though it is not used within the config. This might be useful for variables that should be resolved after a config expression is applied. E.g.:
41+
42+
`devspace.yaml`:
43+
```
44+
vars:
45+
- name: my-var
46+
value: my-value
47+
alwaysResolve: true
48+
hooks:
49+
- name: my-hook
50+
command: $(cat command.txt)
51+
events: ["after:deploy"]
52+
```
53+
54+
`command.txt`:
55+
```
56+
echo Hello ${my-var}!
57+
```

docs/versioned_docs/version-5.18/configuration/variables/source-input.mdx

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -177,3 +177,24 @@ If the provided value does **<u>not</u>** match the regex in `validationPattern`
177177

178178
### `validationMessage`
179179
The `validationMessage` option expects a string stating an error message that is shown to the user when providing a value for the variable that does not match the regex provided in [`validationPattern`](#validationpattern).
180+
181+
### `alwaysResolve`
182+
183+
If enabled, the variable will be loaded even though it is not used within the config. This might be useful for variables that should be resolved after a config expression is applied. E.g.:
184+
185+
`devspace.yaml`:
186+
```
187+
vars:
188+
- name: my-var
189+
value: my-value
190+
alwaysResolve: true
191+
hooks:
192+
- name: my-hook
193+
command: $(cat command.txt)
194+
events: ["after:deploy"]
195+
```
196+
197+
`command.txt`:
198+
```
199+
echo Hello ${my-var}!
200+
```

docs/versioned_docs/version-5.18/configuration/variables/source-none.mdx

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,3 +41,24 @@ The `value` option expects a string, integer or boolean defining the value for t
4141

4242
- The used variable is defined before the variable that wants to use it
4343
- The used variable is a predefined variable
44+
45+
### `alwaysResolve`
46+
47+
If enabled, the variable will be loaded even though it is not used within the config. This might be useful for variables that should be resolved after a config expression is applied. E.g.:
48+
49+
`devspace.yaml`:
50+
```
51+
vars:
52+
- name: my-var
53+
value: my-value
54+
alwaysResolve: true
55+
hooks:
56+
- name: my-hook
57+
command: $(cat command.txt)
58+
events: ["after:deploy"]
59+
```
60+
61+
`command.txt`:
62+
```
63+
echo Hello ${my-var}!
64+
```

docs/versioned_docs/version-5.18/fragments/config-vars.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
vars: # struct[] | Array of config variables
33
- name: CONFIG_VAR # string | Name of the config variable
44
value: my-value # any | The fixed value of the config variable
5+
alwaysResolve: false # bool | If enabled, the variable will be loaded even though it is not used in config
56
question: "What is CONFIG_VAR?" # string | Question to ask the user if no value is found for variable
67
options: [] # string[] | Options for picker (selector) to show to user (to choose a value for variable)
78
noCache: false # bool | Disable caching and prompt for value on every run.

0 commit comments

Comments
 (0)