Skip to content

Commit 546111a

Browse files
committed
Finalize workspace -> devworkspace renaming
1 parent 2c5cc19 commit 546111a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

56 files changed

+1779
-1761
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ From these Go sources, several files are generated:
1414
- A Kubernetes Custom Resource Definition(CRD) with an embedded OpenApi schema,
1515
- json schemas (in the [schemas](schemas) folder) generated from the above CRD, to specify the syntax of:
1616
- the DevWorkspace CRD itself;
17-
- the DevWorkspaceTemplate CRD (a workspace content, without runtime information);
17+
- the DevWorkspaceTemplate CRD (a devworkspace content, without runtime information);
1818
- the Devfile 2.0.0 format, which is generated from the `DevWorkspace` API.
1919

2020
Generated files are created by a build script (see section [How to build](#how-to-build)).
@@ -45,7 +45,7 @@ In order to test existing or new Devfile 2.0 or DevWorkspace sample files in a s
4545

4646
[![Contribute](https://www.eclipse.org/che/contribute.svg)](https://che.openshift.io/f/?url=https://github.com/devfile/api)
4747

48-
As soon as the workspace is opened, you should be able to:
48+
As soon as the devworkspace is opened, you should be able to:
4949
- open the `yaml` files in the following folders:
5050
- `samples/`
5151
- `devfile-support/samples`

crds/workspace.devfile.io_devworkspaces.v1beta1.yaml

Lines changed: 197 additions & 191 deletions
Large diffs are not rendered by default.

crds/workspace.devfile.io_devworkspaces.yaml

Lines changed: 197 additions & 191 deletions
Large diffs are not rendered by default.

crds/workspace.devfile.io_devworkspacetemplates.v1beta1.yaml

Lines changed: 187 additions & 184 deletions
Large diffs are not rendered by default.

crds/workspace.devfile.io_devworkspacetemplates.yaml

Lines changed: 187 additions & 184 deletions
Large diffs are not rendered by default.

generator/main.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ func main() {
110110

111111
cmd := &cobra.Command{
112112
Use: "generator",
113-
Short: "Generates various types of files from the `workspaces` K8S API source code.",
113+
Short: "Generates various types of files from the `workspace` K8S API source code.",
114114
Long: "Generates additional GO source files (for devfile overriding, union support, deep-copy), K8S CRD YAML files and Json Schemas from the from the `workspaces` K8S API source code.",
115115
Example: `
116116
# Generate Plugin Overrides based on the workspaces/v1alpha2 K8S API

pkg/apis/workspaces/v1alpha1/WorkspacePodContribution.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import (
44
corev1 "k8s.io/api/core/v1"
55
)
66

7-
type WorkspacePodContributions struct {
7+
type DevWorkspacePodContributions struct {
88
// +optional
99
// +patchMergeKey=name
1010
// +patchStrategy=merge,retainKeys
@@ -15,15 +15,15 @@ type WorkspacePodContributions struct {
1515
// +patchMergeKey=name
1616
// +patchStrategy=merge
1717
Containers []corev1.Container `json:"containers" patchStrategy:"merge" patchMergeKey:"name" protobuf:"bytes,2,rep,name=containers"`
18-
// ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by the workspace Pod.
18+
// ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by the devworkspace Pod.
1919
// If specified, these secrets will be passed to individual puller implementations for them to use. For example,
2020
// in the case of docker, only DockerConfig type secrets are honored.
2121
// More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod
2222
// +optional
2323
// +patchMergeKey=name
2424
// +patchStrategy=merge
2525
ImagePullSecrets []corev1.LocalObjectReference `json:"imagePullSecrets,omitempty" patchStrategy:"merge" patchMergeKey:"name" protobuf:"bytes,15,rep,name=imagePullSecrets"`
26-
// List of workspace-wide environment variables to set in all containers of the workspace POD.
26+
// List of devworkspace-wide environment variables to set in all containers of the devworkspace POD.
2727
// +optional
2828
// +patchMergeKey=name
2929
// +patchStrategy=merge

pkg/apis/workspaces/v1alpha1/commands.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ type LabeledCommand struct {
6262
// +k8s:openapi-gen=true
6363
// +union
6464
type Command struct {
65-
// Type of workspace command
65+
// Type of devworkspace command
6666
// +unionDiscriminator
6767
// +optional
6868
CommandType CommandType `json:"commandType,omitempty"`
@@ -72,15 +72,15 @@ type Command struct {
7272
Exec *ExecCommand `json:"exec,omitempty"`
7373

7474
// Command that consists in applying a given component definition,
75-
// typically bound to a workspace event.
75+
// typically bound to a devworkspace event.
7676
//
7777
// For example, when an `apply` command is bound to a `preStart` event,
7878
// and references a `container` component, it will start the container as a
79-
// K8S initContainer in the workspace POD, unless the component has its
79+
// K8S initContainer in the devworkspace POD, unless the component has its
8080
// `dedicatedPod` field set to `true`.
8181
//
8282
// When no `apply` command exist for a given component,
83-
// it is assumed the component will be applied at workspace start
83+
// it is assumed the component will be applied at devworkspace start
8484
// by default.
8585
// +optional
8686
Apply *ApplyCommand `json:"apply,omitempty"`

pkg/apis/workspaces/v1alpha1/components.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ const (
1616
CustomComponentType ComponentType = "Custom"
1717
)
1818

19-
// Workspace component: Anything that will bring additional features / tooling / behaviour / context
20-
// to the workspace, in order to make working in it easier.
19+
// DevWorkspace component: Anything that will bring additional features / tooling / behaviour / context
20+
// to the devworkspace, in order to make working in it easier.
2121
type BaseComponent struct {
2222
}
2323

@@ -30,7 +30,7 @@ type Component struct {
3030
// +optional
3131
ComponentType ComponentType `json:"componentType,omitempty"`
3232

33-
// Allows adding and configuring workspace-related containers
33+
// Allows adding and configuring devworkspace-related containers
3434
// +optional
3535
Container *ContainerComponent `json:"container,omitempty"`
3636

@@ -48,14 +48,14 @@ type Component struct {
4848
// +optional
4949
Plugin *PluginComponent `json:"plugin,omitempty"`
5050

51-
// Allows importing into the workspace the Kubernetes resources
51+
// Allows importing into the devworkspace the Kubernetes resources
5252
// defined in a given manifest. For example this allows reusing the Kubernetes
5353
// definitions used to deploy some runtime components in production.
5454
//
5555
// +optional
5656
Kubernetes *KubernetesComponent `json:"kubernetes,omitempty"`
5757

58-
// Allows importing into the workspace the OpenShift resources
58+
// Allows importing into the devworkspace the OpenShift resources
5959
// defined in a given manifest. For example this allows reusing the OpenShift
6060
// definitions used to deploy some runtime components in production.
6161
//

pkg/apis/workspaces/v1alpha1/containerComponent.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
package v1alpha1
22

3-
// Component that allows the developer to add a configured container into his workspace
3+
// Component that allows the developer to add a configured container into his devworkspace
44
type ContainerComponent struct {
55
BaseComponent `json:",inline"`
66
Container `json:",inline"`

0 commit comments

Comments
 (0)