Skip to content

Commit

Permalink
add supportURL and provider in metadata, update some description (#601)
Browse files Browse the repository at this point in the history
* 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]>
  • Loading branch information
yangcao77 authored Sep 7, 2021
1 parent 9227ef2 commit 96ab67b
Show file tree
Hide file tree
Showing 18 changed files with 183 additions and 135 deletions.
28 changes: 16 additions & 12 deletions crds/workspace.devfile.io_devworkspaces.v1beta1.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5504,7 +5504,7 @@ spec:
from when using id in the parent reference. To ensure
the parent devfile gets resolved consistently in different
environments, it is recommended to always specify
the `regsitryURL` when `Id` is used.
the `registryUrl` when `id` is used.
type: string
uri:
description: URI Reference of a parent devfile YAML
Expand Down Expand Up @@ -6903,7 +6903,7 @@ spec:
from when using id in the parent reference. To
ensure the parent devfile gets resolved consistently
in different environments, it is recommended to
always specify the `regsitryURL` when `Id` is
always specify the `registryUrl` when `id` is
used.
type: string
uri:
Expand Down Expand Up @@ -6998,8 +6998,9 @@ spec:
additionalProperties:
type: string
description: The remotes map which should be initialized
in the git project. Must have at least one remote
configured
in the git project. Projects must have at least
one remote configured while StarterProjects can
only have at most one remote configured.
type: object
type: object
name:
Expand Down Expand Up @@ -7029,8 +7030,8 @@ spec:
description: Registry URL to pull the parent devfile from
when using id in the parent reference. To ensure the parent
devfile gets resolved consistently in different environments,
it is recommended to always specify the `regsitryURL` when
`Id` is used.
it is recommended to always specify the `registryUrl` when
`id` is used.
type: string
starterProjects:
description: Overrides of starterProjects encapsulated in
Expand Down Expand Up @@ -7075,8 +7076,9 @@ spec:
additionalProperties:
type: string
description: The remotes map which should be initialized
in the git project. Must have at least one remote
configured
in the git project. Projects must have at least
one remote configured while StarterProjects can
only have at most one remote configured.
type: object
type: object
name:
Expand Down Expand Up @@ -7180,8 +7182,9 @@ spec:
additionalProperties:
type: string
description: The remotes map which should be initialized
in the git project. Must have at least one remote
configured
in the git project. Projects must have at least one
remote configured while StarterProjects can only have
at most one remote configured.
type: object
required:
- remotes
Expand Down Expand Up @@ -7266,8 +7269,9 @@ spec:
additionalProperties:
type: string
description: The remotes map which should be initialized
in the git project. Must have at least one remote
configured
in the git project. Projects must have at least one
remote configured while StarterProjects can only have
at most one remote configured.
type: object
required:
- remotes
Expand Down
28 changes: 16 additions & 12 deletions crds/workspace.devfile.io_devworkspaces.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5509,7 +5509,7 @@ spec:
from when using id in the parent reference. To ensure
the parent devfile gets resolved consistently in different
environments, it is recommended to always specify
the `regsitryURL` when `Id` is used.
the `registryUrl` when `id` is used.
type: string
uri:
description: URI Reference of a parent devfile YAML
Expand Down Expand Up @@ -6908,7 +6908,7 @@ spec:
from when using id in the parent reference. To
ensure the parent devfile gets resolved consistently
in different environments, it is recommended to
always specify the `regsitryURL` when `Id` is
always specify the `registryUrl` when `id` is
used.
type: string
uri:
Expand Down Expand Up @@ -7003,8 +7003,9 @@ spec:
additionalProperties:
type: string
description: The remotes map which should be initialized
in the git project. Must have at least one remote
configured
in the git project. Projects must have at least
one remote configured while StarterProjects can
only have at most one remote configured.
type: object
type: object
name:
Expand Down Expand Up @@ -7034,8 +7035,8 @@ spec:
description: Registry URL to pull the parent devfile from
when using id in the parent reference. To ensure the parent
devfile gets resolved consistently in different environments,
it is recommended to always specify the `regsitryURL` when
`Id` is used.
it is recommended to always specify the `registryUrl` when
`id` is used.
type: string
starterProjects:
description: Overrides of starterProjects encapsulated in
Expand Down Expand Up @@ -7080,8 +7081,9 @@ spec:
additionalProperties:
type: string
description: The remotes map which should be initialized
in the git project. Must have at least one remote
configured
in the git project. Projects must have at least
one remote configured while StarterProjects can
only have at most one remote configured.
type: object
type: object
name:
Expand Down Expand Up @@ -7185,8 +7187,9 @@ spec:
additionalProperties:
type: string
description: The remotes map which should be initialized
in the git project. Must have at least one remote
configured
in the git project. Projects must have at least one
remote configured while StarterProjects can only have
at most one remote configured.
type: object
required:
- remotes
Expand Down Expand Up @@ -7271,8 +7274,9 @@ spec:
additionalProperties:
type: string
description: The remotes map which should be initialized
in the git project. Must have at least one remote
configured
in the git project. Projects must have at least one
remote configured while StarterProjects can only have
at most one remote configured.
type: object
required:
- remotes
Expand Down
26 changes: 16 additions & 10 deletions crds/workspace.devfile.io_devworkspacetemplates.v1beta1.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5227,8 +5227,8 @@ spec:
description: Registry URL to pull the parent devfile from
when using id in the parent reference. To ensure the parent
devfile gets resolved consistently in different environments,
it is recommended to always specify the `regsitryURL`
when `Id` is used.
it is recommended to always specify the `registryUrl`
when `id` is used.
type: string
uri:
description: URI Reference of a parent devfile YAML file.
Expand Down Expand Up @@ -6573,7 +6573,7 @@ spec:
from when using id in the parent reference. To ensure
the parent devfile gets resolved consistently in different
environments, it is recommended to always specify
the `regsitryURL` when `Id` is used.
the `registryUrl` when `id` is used.
type: string
uri:
description: URI Reference of a parent devfile YAML
Expand Down Expand Up @@ -6665,8 +6665,9 @@ spec:
additionalProperties:
type: string
description: The remotes map which should be initialized
in the git project. Must have at least one remote
configured
in the git project. Projects must have at least one
remote configured while StarterProjects can only have
at most one remote configured.
type: object
type: object
name:
Expand Down Expand Up @@ -6696,7 +6697,7 @@ spec:
description: Registry URL to pull the parent devfile from when
using id in the parent reference. To ensure the parent devfile
gets resolved consistently in different environments, it is
recommended to always specify the `regsitryURL` when `Id` is
recommended to always specify the `registryUrl` when `id` is
used.
type: string
starterProjects:
Expand Down Expand Up @@ -6741,8 +6742,9 @@ spec:
additionalProperties:
type: string
description: The remotes map which should be initialized
in the git project. Must have at least one remote
configured
in the git project. Projects must have at least one
remote configured while StarterProjects can only have
at most one remote configured.
type: object
type: object
name:
Expand Down Expand Up @@ -6843,7 +6845,9 @@ spec:
additionalProperties:
type: string
description: The remotes map which should be initialized
in the git project. Must have at least one remote configured
in the git project. Projects must have at least one remote
configured while StarterProjects can only have at most
one remote configured.
type: object
required:
- remotes
Expand Down Expand Up @@ -6926,7 +6930,9 @@ spec:
additionalProperties:
type: string
description: The remotes map which should be initialized
in the git project. Must have at least one remote configured
in the git project. Projects must have at least one remote
configured while StarterProjects can only have at most
one remote configured.
type: object
required:
- remotes
Expand Down
26 changes: 16 additions & 10 deletions crds/workspace.devfile.io_devworkspacetemplates.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5232,8 +5232,8 @@ spec:
description: Registry URL to pull the parent devfile from
when using id in the parent reference. To ensure the parent
devfile gets resolved consistently in different environments,
it is recommended to always specify the `regsitryURL`
when `Id` is used.
it is recommended to always specify the `registryUrl`
when `id` is used.
type: string
uri:
description: URI Reference of a parent devfile YAML file.
Expand Down Expand Up @@ -6578,7 +6578,7 @@ spec:
from when using id in the parent reference. To ensure
the parent devfile gets resolved consistently in different
environments, it is recommended to always specify
the `regsitryURL` when `Id` is used.
the `registryUrl` when `id` is used.
type: string
uri:
description: URI Reference of a parent devfile YAML
Expand Down Expand Up @@ -6670,8 +6670,9 @@ spec:
additionalProperties:
type: string
description: The remotes map which should be initialized
in the git project. Must have at least one remote
configured
in the git project. Projects must have at least one
remote configured while StarterProjects can only have
at most one remote configured.
type: object
type: object
name:
Expand Down Expand Up @@ -6701,7 +6702,7 @@ spec:
description: Registry URL to pull the parent devfile from when
using id in the parent reference. To ensure the parent devfile
gets resolved consistently in different environments, it is
recommended to always specify the `regsitryURL` when `Id` is
recommended to always specify the `registryUrl` when `id` is
used.
type: string
starterProjects:
Expand Down Expand Up @@ -6746,8 +6747,9 @@ spec:
additionalProperties:
type: string
description: The remotes map which should be initialized
in the git project. Must have at least one remote
configured
in the git project. Projects must have at least one
remote configured while StarterProjects can only have
at most one remote configured.
type: object
type: object
name:
Expand Down Expand Up @@ -6848,7 +6850,9 @@ spec:
additionalProperties:
type: string
description: The remotes map which should be initialized
in the git project. Must have at least one remote configured
in the git project. Projects must have at least one remote
configured while StarterProjects can only have at most
one remote configured.
type: object
required:
- remotes
Expand Down Expand Up @@ -6931,7 +6935,9 @@ spec:
additionalProperties:
type: string
description: The remotes map which should be initialized
in the git project. Must have at least one remote configured
in the git project. Projects must have at least one remote
configured while StarterProjects can only have at most
one remote configured.
type: object
required:
- remotes
Expand Down
2 changes: 1 addition & 1 deletion pkg/apis/workspaces/v1alpha2/import_reference.go
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ type ImportReference struct {

// Registry URL to pull the parent devfile from when using id in the parent reference.
// To ensure the parent devfile gets resolved consistently in different environments,
// it is recommended to always specify the `regsitryURL` when `Id` is used.
// it is recommended to always specify the `registryUrl` when `id` is used.
// +optional
RegistryUrl string `json:"registryUrl,omitempty"`
}
3 changes: 2 additions & 1 deletion pkg/apis/workspaces/v1alpha2/projects.go
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,8 @@ type GitLikeProjectSource struct {
// +optional
CheckoutFrom *CheckoutFrom `json:"checkoutFrom,omitempty"`

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

Expand Down
5 changes: 3 additions & 2 deletions pkg/apis/workspaces/v1alpha2/zz_generated.parent_overrides.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 96ab67b

Please sign in to comment.