Kube-native API for cloud development workspaces specification
Kube-native API for cloud development workspaces specification
Sources for this API are defined in Go code, starting from the devworkspace_types.go source file
From these Go sources, several files are generated:
DevWorkspace
API.Generated files are created by a build script (see section How to build).
Devfile 2.0.0 file format
A Subset of this DevWorkspace
API defines a structure (workspace template content), which is also at the core of the Devfile 2.0 format specification.
For more information about this, please look into the Devfile support README
The generated documentation of the Devfile 2.0 format, based on its json schema, is available here.
Typescript model is build on each commit of main branch and available as an NPM package.
Release
Release details and process are found in Devfile Release
How to build
For information about building this project visit CONTRIBUTING.md.
Specification status
This work is still in an early stage of specification, and the related API and schemas are still a draft proposal.
Quickly open and test ?
In order to test existing or new Devfile 2.0 or DevWorkspace sample files in a self-service Che workspace (hosted on che.openshift.io), just click on the button below:
As soon as the devworkspace is opened, you should be able to:
yaml
files in the following folders:
samples/
devfile-support/samples
yaml
language support (completion and documentation) based on the current Json schemas.Please see our contributing.md.
License
Apache License 2.0, see LICENSE for details.
Adding License Headers
license_header
contains the license header to be contained under all source files. For Go sources, this can be included by running bash add_licenses.sh
.
Ensure github.com/google/addlicense
is installed by running go install github.com/google/addlicense@latest
.
Twice a month we will interview people behind open source businesses. We will talk about how they are building a business on top of open source projects.
We'll never share your email with anyone else.