Skip to content

Commit 96ab67b

Browse files
authored
add supportURL and provider in metadata, update some description (#601)
* add supportURL and provider in metadata, update some description Signed-off-by: Stephanie <[email protected]> * revert the change upon v1 devfiles Signed-off-by: Stephanie <[email protected]> * address review comment Signed-off-by: Stephanie <[email protected]>
1 parent 9227ef2 commit 96ab67b

18 files changed

+183
-135
lines changed

crds/workspace.devfile.io_devworkspaces.v1beta1.yaml

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5504,7 +5504,7 @@ spec:
55045504
from when using id in the parent reference. To ensure
55055505
the parent devfile gets resolved consistently in different
55065506
environments, it is recommended to always specify
5507-
the `regsitryURL` when `Id` is used.
5507+
the `registryUrl` when `id` is used.
55085508
type: string
55095509
uri:
55105510
description: URI Reference of a parent devfile YAML
@@ -6903,7 +6903,7 @@ spec:
69036903
from when using id in the parent reference. To
69046904
ensure the parent devfile gets resolved consistently
69056905
in different environments, it is recommended to
6906-
always specify the `regsitryURL` when `Id` is
6906+
always specify the `registryUrl` when `id` is
69076907
used.
69086908
type: string
69096909
uri:
@@ -6998,8 +6998,9 @@ spec:
69986998
additionalProperties:
69996999
type: string
70007000
description: The remotes map which should be initialized
7001-
in the git project. Must have at least one remote
7002-
configured
7001+
in the git project. Projects must have at least
7002+
one remote configured while StarterProjects can
7003+
only have at most one remote configured.
70037004
type: object
70047005
type: object
70057006
name:
@@ -7029,8 +7030,8 @@ spec:
70297030
description: Registry URL to pull the parent devfile from
70307031
when using id in the parent reference. To ensure the parent
70317032
devfile gets resolved consistently in different environments,
7032-
it is recommended to always specify the `regsitryURL` when
7033-
`Id` is used.
7033+
it is recommended to always specify the `registryUrl` when
7034+
`id` is used.
70347035
type: string
70357036
starterProjects:
70367037
description: Overrides of starterProjects encapsulated in
@@ -7075,8 +7076,9 @@ spec:
70757076
additionalProperties:
70767077
type: string
70777078
description: The remotes map which should be initialized
7078-
in the git project. Must have at least one remote
7079-
configured
7079+
in the git project. Projects must have at least
7080+
one remote configured while StarterProjects can
7081+
only have at most one remote configured.
70807082
type: object
70817083
type: object
70827084
name:
@@ -7180,8 +7182,9 @@ spec:
71807182
additionalProperties:
71817183
type: string
71827184
description: The remotes map which should be initialized
7183-
in the git project. Must have at least one remote
7184-
configured
7185+
in the git project. Projects must have at least one
7186+
remote configured while StarterProjects can only have
7187+
at most one remote configured.
71857188
type: object
71867189
required:
71877190
- remotes
@@ -7266,8 +7269,9 @@ spec:
72667269
additionalProperties:
72677270
type: string
72687271
description: The remotes map which should be initialized
7269-
in the git project. Must have at least one remote
7270-
configured
7272+
in the git project. Projects must have at least one
7273+
remote configured while StarterProjects can only have
7274+
at most one remote configured.
72717275
type: object
72727276
required:
72737277
- remotes

crds/workspace.devfile.io_devworkspaces.yaml

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5509,7 +5509,7 @@ spec:
55095509
from when using id in the parent reference. To ensure
55105510
the parent devfile gets resolved consistently in different
55115511
environments, it is recommended to always specify
5512-
the `regsitryURL` when `Id` is used.
5512+
the `registryUrl` when `id` is used.
55135513
type: string
55145514
uri:
55155515
description: URI Reference of a parent devfile YAML
@@ -6908,7 +6908,7 @@ spec:
69086908
from when using id in the parent reference. To
69096909
ensure the parent devfile gets resolved consistently
69106910
in different environments, it is recommended to
6911-
always specify the `regsitryURL` when `Id` is
6911+
always specify the `registryUrl` when `id` is
69126912
used.
69136913
type: string
69146914
uri:
@@ -7003,8 +7003,9 @@ spec:
70037003
additionalProperties:
70047004
type: string
70057005
description: The remotes map which should be initialized
7006-
in the git project. Must have at least one remote
7007-
configured
7006+
in the git project. Projects must have at least
7007+
one remote configured while StarterProjects can
7008+
only have at most one remote configured.
70087009
type: object
70097010
type: object
70107011
name:
@@ -7034,8 +7035,8 @@ spec:
70347035
description: Registry URL to pull the parent devfile from
70357036
when using id in the parent reference. To ensure the parent
70367037
devfile gets resolved consistently in different environments,
7037-
it is recommended to always specify the `regsitryURL` when
7038-
`Id` is used.
7038+
it is recommended to always specify the `registryUrl` when
7039+
`id` is used.
70397040
type: string
70407041
starterProjects:
70417042
description: Overrides of starterProjects encapsulated in
@@ -7080,8 +7081,9 @@ spec:
70807081
additionalProperties:
70817082
type: string
70827083
description: The remotes map which should be initialized
7083-
in the git project. Must have at least one remote
7084-
configured
7084+
in the git project. Projects must have at least
7085+
one remote configured while StarterProjects can
7086+
only have at most one remote configured.
70857087
type: object
70867088
type: object
70877089
name:
@@ -7185,8 +7187,9 @@ spec:
71857187
additionalProperties:
71867188
type: string
71877189
description: The remotes map which should be initialized
7188-
in the git project. Must have at least one remote
7189-
configured
7190+
in the git project. Projects must have at least one
7191+
remote configured while StarterProjects can only have
7192+
at most one remote configured.
71907193
type: object
71917194
required:
71927195
- remotes
@@ -7271,8 +7274,9 @@ spec:
72717274
additionalProperties:
72727275
type: string
72737276
description: The remotes map which should be initialized
7274-
in the git project. Must have at least one remote
7275-
configured
7277+
in the git project. Projects must have at least one
7278+
remote configured while StarterProjects can only have
7279+
at most one remote configured.
72767280
type: object
72777281
required:
72787282
- remotes

crds/workspace.devfile.io_devworkspacetemplates.v1beta1.yaml

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5227,8 +5227,8 @@ spec:
52275227
description: Registry URL to pull the parent devfile from
52285228
when using id in the parent reference. To ensure the parent
52295229
devfile gets resolved consistently in different environments,
5230-
it is recommended to always specify the `regsitryURL`
5231-
when `Id` is used.
5230+
it is recommended to always specify the `registryUrl`
5231+
when `id` is used.
52325232
type: string
52335233
uri:
52345234
description: URI Reference of a parent devfile YAML file.
@@ -6573,7 +6573,7 @@ spec:
65736573
from when using id in the parent reference. To ensure
65746574
the parent devfile gets resolved consistently in different
65756575
environments, it is recommended to always specify
6576-
the `regsitryURL` when `Id` is used.
6576+
the `registryUrl` when `id` is used.
65776577
type: string
65786578
uri:
65796579
description: URI Reference of a parent devfile YAML
@@ -6665,8 +6665,9 @@ spec:
66656665
additionalProperties:
66666666
type: string
66676667
description: The remotes map which should be initialized
6668-
in the git project. Must have at least one remote
6669-
configured
6668+
in the git project. Projects must have at least one
6669+
remote configured while StarterProjects can only have
6670+
at most one remote configured.
66706671
type: object
66716672
type: object
66726673
name:
@@ -6696,7 +6697,7 @@ spec:
66966697
description: Registry URL to pull the parent devfile from when
66976698
using id in the parent reference. To ensure the parent devfile
66986699
gets resolved consistently in different environments, it is
6699-
recommended to always specify the `regsitryURL` when `Id` is
6700+
recommended to always specify the `registryUrl` when `id` is
67006701
used.
67016702
type: string
67026703
starterProjects:
@@ -6741,8 +6742,9 @@ spec:
67416742
additionalProperties:
67426743
type: string
67436744
description: The remotes map which should be initialized
6744-
in the git project. Must have at least one remote
6745-
configured
6745+
in the git project. Projects must have at least one
6746+
remote configured while StarterProjects can only have
6747+
at most one remote configured.
67466748
type: object
67476749
type: object
67486750
name:
@@ -6843,7 +6845,9 @@ spec:
68436845
additionalProperties:
68446846
type: string
68456847
description: The remotes map which should be initialized
6846-
in the git project. Must have at least one remote configured
6848+
in the git project. Projects must have at least one remote
6849+
configured while StarterProjects can only have at most
6850+
one remote configured.
68476851
type: object
68486852
required:
68496853
- remotes
@@ -6926,7 +6930,9 @@ spec:
69266930
additionalProperties:
69276931
type: string
69286932
description: The remotes map which should be initialized
6929-
in the git project. Must have at least one remote configured
6933+
in the git project. Projects must have at least one remote
6934+
configured while StarterProjects can only have at most
6935+
one remote configured.
69306936
type: object
69316937
required:
69326938
- remotes

crds/workspace.devfile.io_devworkspacetemplates.yaml

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5232,8 +5232,8 @@ spec:
52325232
description: Registry URL to pull the parent devfile from
52335233
when using id in the parent reference. To ensure the parent
52345234
devfile gets resolved consistently in different environments,
5235-
it is recommended to always specify the `regsitryURL`
5236-
when `Id` is used.
5235+
it is recommended to always specify the `registryUrl`
5236+
when `id` is used.
52375237
type: string
52385238
uri:
52395239
description: URI Reference of a parent devfile YAML file.
@@ -6578,7 +6578,7 @@ spec:
65786578
from when using id in the parent reference. To ensure
65796579
the parent devfile gets resolved consistently in different
65806580
environments, it is recommended to always specify
6581-
the `regsitryURL` when `Id` is used.
6581+
the `registryUrl` when `id` is used.
65826582
type: string
65836583
uri:
65846584
description: URI Reference of a parent devfile YAML
@@ -6670,8 +6670,9 @@ spec:
66706670
additionalProperties:
66716671
type: string
66726672
description: The remotes map which should be initialized
6673-
in the git project. Must have at least one remote
6674-
configured
6673+
in the git project. Projects must have at least one
6674+
remote configured while StarterProjects can only have
6675+
at most one remote configured.
66756676
type: object
66766677
type: object
66776678
name:
@@ -6701,7 +6702,7 @@ spec:
67016702
description: Registry URL to pull the parent devfile from when
67026703
using id in the parent reference. To ensure the parent devfile
67036704
gets resolved consistently in different environments, it is
6704-
recommended to always specify the `regsitryURL` when `Id` is
6705+
recommended to always specify the `registryUrl` when `id` is
67056706
used.
67066707
type: string
67076708
starterProjects:
@@ -6746,8 +6747,9 @@ spec:
67466747
additionalProperties:
67476748
type: string
67486749
description: The remotes map which should be initialized
6749-
in the git project. Must have at least one remote
6750-
configured
6750+
in the git project. Projects must have at least one
6751+
remote configured while StarterProjects can only have
6752+
at most one remote configured.
67516753
type: object
67526754
type: object
67536755
name:
@@ -6848,7 +6850,9 @@ spec:
68486850
additionalProperties:
68496851
type: string
68506852
description: The remotes map which should be initialized
6851-
in the git project. Must have at least one remote configured
6853+
in the git project. Projects must have at least one remote
6854+
configured while StarterProjects can only have at most
6855+
one remote configured.
68526856
type: object
68536857
required:
68546858
- remotes
@@ -6931,7 +6935,9 @@ spec:
69316935
additionalProperties:
69326936
type: string
69336937
description: The remotes map which should be initialized
6934-
in the git project. Must have at least one remote configured
6938+
in the git project. Projects must have at least one remote
6939+
configured while StarterProjects can only have at most
6940+
one remote configured.
69356941
type: object
69366942
required:
69376943
- remotes

pkg/apis/workspaces/v1alpha2/import_reference.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ type ImportReference struct {
4747

4848
// Registry URL to pull the parent devfile from when using id in the parent reference.
4949
// To ensure the parent devfile gets resolved consistently in different environments,
50-
// it is recommended to always specify the `regsitryURL` when `Id` is used.
50+
// it is recommended to always specify the `registryUrl` when `id` is used.
5151
// +optional
5252
RegistryUrl string `json:"registryUrl,omitempty"`
5353
}

pkg/apis/workspaces/v1alpha2/projects.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,8 @@ type GitLikeProjectSource struct {
109109
// +optional
110110
CheckoutFrom *CheckoutFrom `json:"checkoutFrom,omitempty"`
111111

112-
// The remotes map which should be initialized in the git project. Must have at least one remote configured
112+
// The remotes map which should be initialized in the git project.
113+
// Projects must have at least one remote configured while StarterProjects can only have at most one remote configured.
113114
Remotes map[string]string `json:"remotes"`
114115
}
115116

pkg/apis/workspaces/v1alpha2/zz_generated.parent_overrides.go

Lines changed: 3 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)