Skip to content

Commit 832b661

Browse files
feloyfeloy
authored
Clarify hotReloadCapable field (#1091)
* Clarify hotReloadCapable field Signed-off-by: Philippe Martin <[email protected]> * Auto-generated Signed-off-by: Philippe Martin <[email protected]> * Specify isDefault Signed-off-by: Philippe Martin <[email protected]> * Clarify description Signed-off-by: Philippe Martin <[email protected]> --------- Signed-off-by: Philippe Martin <[email protected]>
1 parent 1df96d2 commit 832b661

20 files changed

+443
-230
lines changed

‎crds/workspace.devfile.io_devworkspaces.v1beta1.yaml

Lines changed: 98 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -303,11 +303,16 @@ spec:
303303
- kind
304304
type: object
305305
hotReloadCapable:
306-
description: "Whether the command is capable to reload
307-
itself when source code changes. If set to `true`
308-
the command won't be restarted and it is expected
309-
to handle file changes on its own. \n Default value
310-
is `false`"
306+
description: "Specify whether the command is restarted
307+
or not when the source code changes. If set to `true`
308+
the command won't be restarted. A *hotReloadCapable*
309+
`run` or `debug` command is expected to handle file
310+
changes on its own and won't be restarted. A *hotReloadCapable*
311+
`build` command is expected to be executed only once
312+
and won't be executed again. This field is taken into
313+
account only for commands `build`, `run` and `debug`
314+
with `isDefault` set to `true`. \n Default value is
315+
`false`"
311316
type: boolean
312317
id:
313318
description: Mandatory identifier that allows referencing
@@ -1108,11 +1113,18 @@ spec:
11081113
- kind
11091114
type: object
11101115
hotReloadCapable:
1111-
description: "Whether the command is capable
1112-
to reload itself when source code changes.
1113-
If set to `true` the command won't be restarted
1114-
and it is expected to handle file changes
1115-
on its own. \n Default value is `false`"
1116+
description: "Specify whether the command
1117+
is restarted or not when the source code
1118+
changes. If set to `true` the command won't
1119+
be restarted. A *hotReloadCapable* `run`
1120+
or `debug` command is expected to handle
1121+
file changes on its own and won't be restarted.
1122+
A *hotReloadCapable* `build` command is
1123+
expected to be executed only once and won't
1124+
be executed again. This field is taken into
1125+
account only for commands `build`, `run`
1126+
and `debug` with `isDefault` set to `true`.
1127+
\n Default value is `false`"
11161128
type: boolean
11171129
id:
11181130
description: Mandatory identifier that allows
@@ -2028,11 +2040,16 @@ spec:
20282040
- kind
20292041
type: object
20302042
hotReloadCapable:
2031-
description: "Whether the command is capable to
2032-
reload itself when source code changes. If set
2033-
to `true` the command won't be restarted and it
2034-
is expected to handle file changes on its own.
2035-
\n Default value is `false`"
2043+
description: "Specify whether the command is restarted
2044+
or not when the source code changes. If set to
2045+
`true` the command won't be restarted. A *hotReloadCapable*
2046+
`run` or `debug` command is expected to handle
2047+
file changes on its own and won't be restarted.
2048+
A *hotReloadCapable* `build` command is expected
2049+
to be executed only once and won't be executed
2050+
again. This field is taken into account only for
2051+
commands `build`, `run` and `debug` with `isDefault`
2052+
set to `true`. \n Default value is `false`"
20362053
type: boolean
20372054
id:
20382055
description: Mandatory identifier that allows referencing
@@ -2855,11 +2872,18 @@ spec:
28552872
- kind
28562873
type: object
28572874
hotReloadCapable:
2858-
description: "Whether the command is capable
2859-
to reload itself when source code changes.
2860-
If set to `true` the command won't be
2861-
restarted and it is expected to handle
2862-
file changes on its own. \n Default
2875+
description: "Specify whether the command
2876+
is restarted or not when the source
2877+
code changes. If set to `true` the command
2878+
won't be restarted. A *hotReloadCapable*
2879+
`run` or `debug` command is expected
2880+
to handle file changes on its own and
2881+
won't be restarted. A *hotReloadCapable*
2882+
`build` command is expected to be executed
2883+
only once and won't be executed again.
2884+
This field is taken into account only
2885+
for commands `build`, `run` and `debug`
2886+
with `isDefault` set to `true`. \n Default
28632887
value is `false`"
28642888
type: boolean
28652889
id:
@@ -4303,11 +4327,16 @@ spec:
43034327
type: string
43044328
type: object
43054329
hotReloadCapable:
4306-
description: "Whether the command is capable to reload
4307-
itself when source code changes. If set to `true`
4308-
the command won't be restarted and it is expected
4309-
to handle file changes on its own. \n Default value
4310-
is `false`"
4330+
description: "Specify whether the command is restarted
4331+
or not when the source code changes. If set to `true`
4332+
the command won't be restarted. A *hotReloadCapable*
4333+
`run` or `debug` command is expected to handle file
4334+
changes on its own and won't be restarted. A *hotReloadCapable*
4335+
`build` command is expected to be executed only
4336+
once and won't be executed again. This field is
4337+
taken into account only for commands `build`, `run`
4338+
and `debug` with `isDefault` set to `true`. \n Default
4339+
value is `false`"
43114340
type: boolean
43124341
label:
43134342
description: Optional label that provides a label
@@ -5200,11 +5229,16 @@ spec:
52005229
- kind
52015230
type: object
52025231
hotReloadCapable:
5203-
description: "Whether the command is capable to reload
5204-
itself when source code changes. If set to `true`
5205-
the command won't be restarted and it is expected
5206-
to handle file changes on its own. \n Default value
5207-
is `false`"
5232+
description: "Specify whether the command is restarted
5233+
or not when the source code changes. If set to `true`
5234+
the command won't be restarted. A *hotReloadCapable*
5235+
`run` or `debug` command is expected to handle file
5236+
changes on its own and won't be restarted. A *hotReloadCapable*
5237+
`build` command is expected to be executed only once
5238+
and won't be executed again. This field is taken into
5239+
account only for commands `build`, `run` and `debug`
5240+
with `isDefault` set to `true`. \n Default value is
5241+
`false`"
52085242
type: boolean
52095243
label:
52105244
description: Optional label that provides a label for
@@ -6016,11 +6050,18 @@ spec:
60166050
type: string
60176051
type: object
60186052
hotReloadCapable:
6019-
description: "Whether the command is capable
6020-
to reload itself when source code changes.
6021-
If set to `true` the command won't be restarted
6022-
and it is expected to handle file changes
6023-
on its own. \n Default value is `false`"
6053+
description: "Specify whether the command
6054+
is restarted or not when the source code
6055+
changes. If set to `true` the command won't
6056+
be restarted. A *hotReloadCapable* `run`
6057+
or `debug` command is expected to handle
6058+
file changes on its own and won't be restarted.
6059+
A *hotReloadCapable* `build` command is
6060+
expected to be executed only once and won't
6061+
be executed again. This field is taken into
6062+
account only for commands `build`, `run`
6063+
and `debug` with `isDefault` set to `true`.
6064+
\n Default value is `false`"
60246065
type: boolean
60256066
label:
60266067
description: Optional label that provides
@@ -6967,11 +7008,16 @@ spec:
69677008
type: string
69687009
type: object
69697010
hotReloadCapable:
6970-
description: "Whether the command is capable to
6971-
reload itself when source code changes. If set
6972-
to `true` the command won't be restarted and it
6973-
is expected to handle file changes on its own.
6974-
\n Default value is `false`"
7011+
description: "Specify whether the command is restarted
7012+
or not when the source code changes. If set to
7013+
`true` the command won't be restarted. A *hotReloadCapable*
7014+
`run` or `debug` command is expected to handle
7015+
file changes on its own and won't be restarted.
7016+
A *hotReloadCapable* `build` command is expected
7017+
to be executed only once and won't be executed
7018+
again. This field is taken into account only for
7019+
commands `build`, `run` and `debug` with `isDefault`
7020+
set to `true`. \n Default value is `false`"
69757021
type: boolean
69767022
label:
69777023
description: Optional label that provides a label
@@ -7769,11 +7815,18 @@ spec:
77697815
type: string
77707816
type: object
77717817
hotReloadCapable:
7772-
description: "Whether the command is capable
7773-
to reload itself when source code changes.
7774-
If set to `true` the command won't be
7775-
restarted and it is expected to handle
7776-
file changes on its own. \n Default
7818+
description: "Specify whether the command
7819+
is restarted or not when the source
7820+
code changes. If set to `true` the command
7821+
won't be restarted. A *hotReloadCapable*
7822+
`run` or `debug` command is expected
7823+
to handle file changes on its own and
7824+
won't be restarted. A *hotReloadCapable*
7825+
`build` command is expected to be executed
7826+
only once and won't be executed again.
7827+
This field is taken into account only
7828+
for commands `build`, `run` and `debug`
7829+
with `isDefault` set to `true`. \n Default
77777830
value is `false`"
77787831
type: boolean
77797832
label:

0 commit comments

Comments
 (0)