From 774eea20cf41e0ea48ee2556361c142132f10573 Mon Sep 17 00:00:00 2001 From: Paul Schultz Date: Thu, 27 Oct 2022 12:10:00 -0500 Subject: [PATCH 1/9] wip update to 2.2.1-alpha Signed-off-by: Paul Schultz --- .editorconfig | 9 ++ .gitattributes | 98 ++++++++++++++++++- .gitignore | 2 + .../v1alpha2/component_container.go | 5 +- pkg/apis/workspaces/v1alpha2/doc.go | 2 +- 5 files changed, 110 insertions(+), 6 deletions(-) create mode 100644 .editorconfig diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 000000000..c6c8b3621 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,9 @@ +root = true + +[*] +indent_style = space +indent_size = 2 +end_of_line = lf +charset = utf-8 +trim_trailing_whitespace = true +insert_final_newline = true diff --git a/.gitattributes b/.gitattributes index 8451111f7..fb95da39d 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1,3 +1,99 @@ **/zz_generated.*.go linguist-generated=true vendor/** linguist-vendored -generator/vendor/** linguist-vendored \ No newline at end of file +generator/vendor/** linguist-vendored + +# source code +*.php eol=lf +*.css eol=lf +*.sass eol=lf +*.scss eol=lf +*.less eol=lf +*.styl eol=lf +*.js eol=lf +*.ts eol=lf +*.jsx eol=lf +*.tsx eol=lf +*.coffee eol=lf +*.json eol=lf +*.htm eol=lf +*.html eol=lf +*.xml eol=lf +*.svg eol=lf +*.txt eol=lf +*.ini eol=lf +*.inc eol=lf +*.pl eol=lf +*.rb eol=lf +*.py eol=lf +*.scm eol=lf +*.sql eol=lf +*.sh eol=lf +*.bat eol=lf +*.go eol=lf + +# templates +*.ejs eol=lf +*.hbt eol=lf +*.jade eol=lf +*.haml eol=lf +*.hbs eol=lf +*.dot eol=lf +*.tmpl eol=lf +*.phtml eol=lf + +# server config +.htaccess eol=lf + +# git config +.gitattributes eol=lf +.gitignore eol=lf +.gitconfig eol=lf + +# code analysis config +.jshintrc eol=lf +.jscsrc eol=lf +.jshintignore eol=lf +.csslintrc eol=lf + +# misc config +*.yaml eol=lf +*.yml eol=lf +.editorconfig eol=lf + +# build config +*.npmignore eol=lf +*.bowerrc eol=lf + +# Heroku +Procfile eol=lf +.slugignore eol=lf + +# Documentation +*.md eol=lf +LICENSE eol=lf +AUTHORS eol=lf + +# +## These files are binary and should be left untouched +# + +# (binary is a macro for -eol=lf -diff) +*.png binary +*.jpg binary +*.jpeg binary +*.gif binary +*.ico binary +*.mov binary +*.mp4 binary +*.mp3 binary +*.flv binary +*.fla binary +*.swf binary +*.gz binary +*.zip binary +*.7z binary +*.ttf binary +*.eot binary +*.woff binary +*.pyc binary +*.pdf binary diff --git a/.gitignore b/.gitignore index 1a2323197..035a64304 100644 --- a/.gitignore +++ b/.gitignore @@ -87,3 +87,5 @@ generator/build/generator .DS_Store build/typescript-model/workdir + +docker-build-log diff --git a/pkg/apis/workspaces/v1alpha2/component_container.go b/pkg/apis/workspaces/v1alpha2/component_container.go index c913ca268..fdd0848c2 100644 --- a/pkg/apis/workspaces/v1alpha2/component_container.go +++ b/pkg/apis/workspaces/v1alpha2/component_container.go @@ -94,10 +94,7 @@ func (in *Container) GetMountSources() bool { if in.MountSources != nil { return *in.MountSources } else { - if in.GetDedicatedPod() { - return false - } - return true + return !in.GetDedicatedPod() } } diff --git a/pkg/apis/workspaces/v1alpha2/doc.go b/pkg/apis/workspaces/v1alpha2/doc.go index c16dcf897..53f8d0a4c 100644 --- a/pkg/apis/workspaces/v1alpha2/doc.go +++ b/pkg/apis/workspaces/v1alpha2/doc.go @@ -2,5 +2,5 @@ // +k8s:deepcopy-gen=package,register // +k8s:openapi-gen=true // +groupName=workspace.devfile.io -// +devfile:jsonschema:version=2.2.0-alpha +// +devfile:jsonschema:version=2.2.1-alpha package v1alpha2 From b25e29c9ec37b1744b4e1b1b3dbdfffc20cc4409 Mon Sep 17 00:00:00 2001 From: Paul Schultz Date: Thu, 27 Oct 2022 12:56:44 -0500 Subject: [PATCH 2/9] updated readme and issue templates Signed-off-by: Paul Schultz --- .github/ISSUE_TEMPLATE/bug_report.md | 58 +++++++++++++++---- .github/ISSUE_TEMPLATE/documentation.md | 14 ++++- .github/ISSUE_TEMPLATE/feature_request.md | 16 ++++- .github/ISSUE_TEMPLATE/registry_update.md | 6 +- .github/ISSUE_TEMPLATE/task.md | 17 +++--- .github/ISSUE_TEMPLATE/user_story.md | 13 +++-- CODE_OF_CONDUCT.md | 12 +--- CONTRIBUTING.md | 12 ++-- GOVERNANCE.md | 33 ++++++----- README.md | 20 ++++--- RELEASE.md | 37 ++++++------ .../latest/dev-workspace-template-spec.json | 2 +- schemas/latest/dev-workspace-template.json | 2 +- schemas/latest/dev-workspace.json | 2 +- schemas/latest/devfile.json | 2 +- schemas/latest/ide-targeted/Readme.md | 6 +- .../dev-workspace-template-spec.json | 2 +- .../ide-targeted/dev-workspace-template.json | 2 +- .../latest/ide-targeted/dev-workspace.json | 2 +- schemas/latest/ide-targeted/devfile.json | 2 +- .../latest/ide-targeted/parent-overrides.json | 2 +- .../latest/ide-targeted/plugin-overrides.json | 2 +- schemas/latest/jsonSchemaVersion.txt | 2 +- schemas/latest/parent-overrides.json | 2 +- schemas/latest/plugin-overrides.json | 2 +- 25 files changed, 163 insertions(+), 107 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 64f81112c..87d5bc291 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -7,13 +7,15 @@ assignees: '' --- +## Which area this feature is related to? + /kind bug ### Which area this bug is related to? + + +**Operating System and version:** + +**Node.js version:** + +**Yarn version:** + +**Project.json:** + +### Web browser + + + +**Operating System and version:** + +**Browser name and version:** ## Bug Summary + **Describe the bug:** - **To Reproduce:** + - ## Expected behavior + -## Any logs, error output, screenshots etc? Provide the devfile that sees this bug, if applicable. +## Any logs, error output, screenshots etc? Provide the devfile that sees this bug, if applicable + - ## Additional context + -**Any workaround?** + +### Any workaround? + -**Suggestion on how to fix the bug** +### Suggestion on how to fix the bug + - - diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md index 2cca9a429..dc1948748 100644 --- a/.github/ISSUE_TEMPLATE/documentation.md +++ b/.github/ISSUE_TEMPLATE/documentation.md @@ -3,27 +3,35 @@ name: "📖 Documentation" about: Suggest an update for devfile documentation title: '' labels: '' -assignees: jc-berger +assignees: '' --- -/area documentation +## Which area this feature is related to? +/area documentation -**Which area this documentation change is related to?** +## Which area is this documentation change is related to? +> /area ci > /area api > /area library > /area registry > /area devworkspace +> /area integration-tests +> /area test-automation +> /area releng +> /area landing-page ## Issue details + + **What mistake did you find / what is missing in the documentation?** diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index b02bc71be..cfb6243fb 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -11,7 +11,7 @@ assignees: '' Welcome! - We kindly ask you to: - 1. Fill out the issue template below + 1. Fill out the issue template below 2. Use the Devfile Community Slack Channel: https://kubernetes.slack.com/archives/C02SX9E5B55 if you have a question rather than a bug or feature request. If you haven’t joined the Kubernetes workspace before, follow https://slack.k8s.io/. @@ -19,38 +19,48 @@ Thanks for understanding and for contributing to the project! --> -**Which area this feature is related to?** +## Which area this feature is related to? +> /area ci > /area api > /area library > /area registry > /area devworkspace - +> /area integration-tests +> /area test-automation +> /area releng +> /area documentation +> /area landing-page ## Which functionality do you think we should add? + + **Why is this needed? Is your feature request related to a problem?** **Detailed description:** ## Describe the solution you'd like + ## Describe alternatives you've considered + ## Additional context + diff --git a/.github/ISSUE_TEMPLATE/registry_update.md b/.github/ISSUE_TEMPLATE/registry_update.md index 122c2e233..47cea35b3 100644 --- a/.github/ISSUE_TEMPLATE/registry_update.md +++ b/.github/ISSUE_TEMPLATE/registry_update.md @@ -3,10 +3,12 @@ name: ⚠️ Emergency registry update about: Request for an emergency registry update title: '' labels: '' -assignees: johnmcollier, GeekArthur +assignees: johnmcollier --- +## Which area this feature is related to? + /area registry -**Which area/kind this issue is related to?** +## Which area/kind this issue is related to? -> Please uncomment and provide the target Odo version if this task is for QE integration test. -> Leave if blank if it's a future QE issue. -> Delete this comment if it's not related QE integration test. - -> Target Odo version: +## Target Odo version + +> Target Odo version: diff --git a/.github/ISSUE_TEMPLATE/user_story.md b/.github/ISSUE_TEMPLATE/user_story.md index 11aeba6a3..705f452e3 100644 --- a/.github/ISSUE_TEMPLATE/user_story.md +++ b/.github/ISSUE_TEMPLATE/user_story.md @@ -4,32 +4,35 @@ about: User story for new enhancement title: '' labels: '' assignees: '' - --- /kind user-story -**Which area this user story is related to?** +## Which area this user story is related to? +> /area ci > /area api > /area library > /area registry > /area devworkspace - +> /area integration-tests +> /area test-automation +> /area releng +> /area landing-page ## User Story + As a ... I want to ..., so that ... ## Acceptance Criteria + - [ ] .... - [ ] .... - - diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 7c8814662..cc348fb7c 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -59,7 +59,7 @@ representative at an online or offline event. ## Enforcement Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported to the community leaders responsible for enforcement at our [Devfile Community Slack Channel](https://kubernetes.slack.com/archives/C02SX9E5B55 ). +reported to the community leaders responsible for enforcement at our [Devfile Community Slack Channel](https://kubernetes.slack.com/archives/C02SX9E5B55 ). All complaints will be reviewed and investigated promptly and fairly. All community leaders are obligated to respect the privacy and security of the @@ -113,15 +113,9 @@ the community. ## Attribution -This Code of Conduct is adapted from the [Contributor Covenant][homepage], -version 2.0, available at -https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. +This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/version/2/0/code_of_conduct.html), version 2.0. Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity). -[homepage]: https://www.contributor-covenant.org - -For answers to common questions about this code of conduct, see the FAQ at -https://www.contributor-covenant.org/faq. Translations are available at -https://www.contributor-covenant.org/translations. +For answers to common questions about this code of conduct, see the [FAQ](https://www.contributor-covenant.org/faq). [Translations](https://www.contributor-covenant.org/translations) are available. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f42e2d70e..02ee6799e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,21 +19,21 @@ Before contributing to this repository for the first time, please review our pro To build the CRD and the various schemas, you don't need to install any pre-requisite apart from `docker`. In the root directory, just run the following command: -``` -./docker-run.sh ./build.sh +```console +bash ./docker-run.sh ./build.sh ``` ### Testing Find more information about tests in the [testing document](test/README.md). -``` +```console # schemaTest approach cd test/v200/schemaTest go test -v ``` -``` +```console # apiTest approach cd test/v200/apiTest go test -v @@ -43,8 +43,8 @@ go test -v All commits must be signed off with the footer: -``` -Signed-off-by: First Lastname +```git +Signed-off-by: Firstname Lastname ``` Once you set your user.name and user.email in your git config, you can sign your commit automatically with git commit -s. When you think the code is ready for review, create a pull request and link the issue associated with it. diff --git a/GOVERNANCE.md b/GOVERNANCE.md index aa775e6af..73282227d 100644 --- a/GOVERNANCE.md +++ b/GOVERNANCE.md @@ -2,16 +2,17 @@ This document defines governance policies for the the projects under the Devfile organization. -- [Maintainers](#maintainers) -- [Becoming a Maintainer](#becoming-a-maintainer) -- [Meetings](#meetings) -- [CNCF Resources](#cncf-resources) -- [Code of Conduct Enforcement](#code-of-conduct) -- [Voting](#voting) +- [Project Governance](#project-governance) + - [Maintainers](#maintainers) + - [Becoming a Maintainer](#becoming-a-maintainer) + - [Meetings](#meetings) + - [CNCF Resources](#cncf-resources) + - [Code of Conduct](#code-of-conduct) + - [Voting](#voting) ## Maintainers -Devfile Maintainers have write access to the [Devile GitHub organization repositories](https://github.com/devfile). +Devfile Maintainers have write access to the [Devfile GitHub organization repositories](https://github.com/devfile). They can merge their own patches or patches from others. The current maintainers can be found in [MAINTAINERS](./MAINTAINERS). Maintainers collectively manage the project's resources and contributors. @@ -30,15 +31,15 @@ the project succeed. To become a Maintainer you need to demonstrate the following: - * commitment to the project: - * participate in discussions, contributions, code and documentation reviews +- commitment to the project: + - participate in discussions, contributions, code and documentation reviews for 3 months or more, - * perform reviews for 5 non-trivial pull requests, - * contribute 5 non-trivial pull requests and have them merged, - * ability to write quality code and/or documentation, - * ability to collaborate with the team, - * understanding of how the team works (policies, processes for testing and code review, etc), - * understanding of the project's code base and coding and documentation style. + - perform reviews for 5 non-trivial pull requests, + - contribute 5 non-trivial pull requests and have them merged, +- ability to write quality code and/or documentation, +- ability to collaborate with the team, +- understanding of how the team works (policies, processes for testing and code review, etc), +- understanding of the project's code base and coding and documentation style. A new Maintainer must be proposed by an existing maintainer by submitting a new post to the [Devfile API discussion board](https://github.com/devfile/api/discussions). A simple majority vote of existing Maintainers @@ -81,7 +82,7 @@ with CNCF staff in resolving the report. While most business in Devfile is conducted by "lazy consensus", periodically the Maintainers may need to vote on specific actions or changes. A vote can be taken on [Devfile API discussion board](https://github.com/devfile/api/discussions) or -[the private Maintainer mailing list](https://lists.cncf.io/g/cncf-devfile-maintainers) for security or conduct matters. +[the private Maintainer mailing list](https://lists.cncf.io/g/cncf-devfile-maintainers) for security or conduct matters. Votes may also be taken on [Devfile API discussion board](https://github.com/devfile/api/discussions). Any Maintainer may demand a vote be taken. diff --git a/README.md b/README.md index ed0e2772a..51765a6e3 100644 --- a/README.md +++ b/README.md @@ -19,16 +19,17 @@ From these Go sources, several files are generated: Generated files are created by a build script (see section [How to build](#how-to-build)). -### Devfile 2.0.0 file format +## 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](devfile-support/README.md) +For more information about this, please look into the [Devfile support README]([devfile-support/README.md](https://github.com/devfile/registry-support/blob/main/README.md)) -The generated documentation of the Devfile 2.0 format, based on its json schema, is available here: https://devfile.github.io +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 NPM package at https://www.npmjs.com/package/@devfile/api +Typescript model is build on each commit of main branch and available as NPM package at ## Release + Release details and process are found in [Devfile Release](RELEASE.md) ## How to build @@ -36,16 +37,17 @@ Release details and process are found in [Devfile Release](RELEASE.md) In order to build the CRD and the various schemas, you don't need to install any pre-requisite apart from `docker`. In the root directory, just run the following command: -``` -./docker-run.sh ./build.sh +```console +bash ./docker-run.sh ./build.sh ``` ### Typescript model -Typescript model is generated based on JSON Schema with help of https://github.com/kubernetes-client/gen. +Typescript model is generated based on JSON Schema with help of . To generate them locally run: -```bash -./build/typescript-model/generate.sh + +```console +bash ./build/typescript-model/generate.sh ``` ## Specification status diff --git a/RELEASE.md b/RELEASE.md index 2110ae48c..8d97e1271 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -1,46 +1,43 @@ -## Devfile Release +# Devfile Release -### Release Process -The current process can be found here: +## Release Process -[Devfile Versioning and Release Process](docs/proposals/versioning-and-release.md). +The current process can be found here: -### Levels of Support +[Devfile Versioning and Release Process](docs/proposals/versioning-and-release.md). -Devfile releases are considered **_stable_** even though the JSON schema is derived from an **_alpha_** version -of the K8s API which is under development and managed by the `devworkspace` team. +## Levels of Support +Devfile releases are considered **_stable_** even though the JSON schema is derived from an **_alpha_** version +of the K8s API which is under development and managed by the `devworkspace` team. This means the scope of support will only apply to the subset of APIs that are part of the Devfile spec. The following table summarizes the versioning relationship of a Devfile release and it's corresponding components: - | Components/Versions of a Devfile Release | Description| Release Stage | | :--- | :--- |:--- | | [K8s API](docs/proposals/versioning-and-release.md#kubernetes-api) | The `devworkspace` API that Devfiles is based upon. It is independently versioned from the Devfile release.
`e.g. K8s API, v1alpha2 is part of the Devfile 2.1.0 release` | alpha | [JSON Schema](docs/proposals/versioning-and-release.md#devfile-json-schema) | The Devfile JSON structure that is generated from the K8s API. The version is in sync with the Devfiles release.
`e.g. JSON schema v2.1.0 is part of the Devfile 2.1.0 release` |stable | API release version | This is the software release version of the K8s API. Similar to the JSON schema, this version is also in sync with the Devfile release.
`e.g. K8s API v1alpha2 version 2.1.0 is part of the Devfile 2.1.0 release`| stable | -### Decoupling the API Release Version (Future Consideration) +## Decoupling the API Release Version (Future Consideration) -Currently, our JSON Schema and API releases are kept in sync with the Devfile version, but we could run in a situation -where we would need to branch off a separate API release and maintain out of sync versions that can be delivered within -a Devile release or outside of one.
+Currently, our JSON Schema and API releases are kept in sync with the Devfile version, but we could run in a situation +where we would need to branch off a separate API release and maintain out of sync versions that can be delivered within +a Devfile release or outside of one. This scenario can happen when we introduce breaking API changes that would impact our consumers while continuing to maintain backward compatibility with the schema. We discussed the following approach in a team meeting, and it's documented here in case we ever need to take action: -1. The **main** branch will continue to be the branch for active development. If there is a breaking API change, then -we would create a new API release branch and bump up the major version. -2. There's the potential for dual maintenance if we are working towards a major release and find a breaking API change +1. The **main** branch will continue to be the branch for active development. If there is a breaking API change, then +we would create a new API release branch and bump up the major version. +2. There's the potential for dual maintenance if we are working towards a major release and find a breaking API change in the current release. We would then create a new API branch to work on the fix and then deliver the changes back to **main**. 3. Since dev is done on the **main** branch, consumers will run into a known versioning bug: -[Incorrect api version is generated from "go get github.com/devfile/api/v2@main"](https://github.com/devfile/api/issues/599). -which will cause interim, unreleased versions to incorrectly appear as `v2xxx` rather than the latest `vNext` API version. -We will need to document this limitation and make it clear that even though the versioning is incorrect, +[Incorrect api version is generated from "go get github.com/devfile/api/v2@main"](https://github.com/devfile/api/issues/599). +which will cause interim, unreleased versions to incorrectly appear as `v2xxx` rather than the latest `vNext` API version. +We will need to document this limitation and make it clear that even though the versioning is incorrect, they are getting the latest code. - - diff --git a/schemas/latest/dev-workspace-template-spec.json b/schemas/latest/dev-workspace-template-spec.json index 3465d1ed0..697c517df 100644 --- a/schemas/latest/dev-workspace-template-spec.json +++ b/schemas/latest/dev-workspace-template-spec.json @@ -1,7 +1,7 @@ { "description": "Structure of the devworkspace. This is also the specification of a devworkspace template.", "type": "object", - "title": "DevWorkspaceTemplateSpec schema - Version 2.2.0-alpha", + "title": "DevWorkspaceTemplateSpec schema - Version 2.2.1-alpha", "properties": { "attributes": { "description": "Map of implementation-dependant free-form YAML attributes.", diff --git a/schemas/latest/dev-workspace-template.json b/schemas/latest/dev-workspace-template.json index 9ed69f1d4..6e9e52efd 100644 --- a/schemas/latest/dev-workspace-template.json +++ b/schemas/latest/dev-workspace-template.json @@ -1,7 +1,7 @@ { "description": "DevWorkspaceTemplate is the Schema for the devworkspacetemplates API", "type": "object", - "title": "DevWorkspaceTemplate schema - Version 2.2.0-alpha", + "title": "DevWorkspaceTemplate schema - Version 2.2.1-alpha", "properties": { "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", diff --git a/schemas/latest/dev-workspace.json b/schemas/latest/dev-workspace.json index f2c614eac..6bcd10644 100644 --- a/schemas/latest/dev-workspace.json +++ b/schemas/latest/dev-workspace.json @@ -1,7 +1,7 @@ { "description": "DevWorkspace is the Schema for the devworkspaces API", "type": "object", - "title": "DevWorkspace schema - Version 2.2.0-alpha", + "title": "DevWorkspace schema - Version 2.2.1-alpha", "properties": { "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", diff --git a/schemas/latest/devfile.json b/schemas/latest/devfile.json index 627dae1d7..5e2f72e43 100644 --- a/schemas/latest/devfile.json +++ b/schemas/latest/devfile.json @@ -1,7 +1,7 @@ { "description": "Devfile describes the structure of a cloud-native devworkspace and development environment.", "type": "object", - "title": "Devfile schema - Version 2.2.0-alpha", + "title": "Devfile schema - Version 2.2.1-alpha", "required": [ "schemaVersion" ], diff --git a/schemas/latest/ide-targeted/Readme.md b/schemas/latest/ide-targeted/Readme.md index bdcbf8f8f..354a12016 100644 --- a/schemas/latest/ide-targeted/Readme.md +++ b/schemas/latest/ide-targeted/Readme.md @@ -1,4 +1,6 @@ +# ide-targeted + IDE-targeted variants of the schemas provide the following difference compared to the main schemas: - They contain additional non-standard `markdownDescription` attributes that are used by IDEs such a VSCode -to provide markdown-rendered documentation hovers. -- They don't contain `default` attributes, since this triggers unwanted addition of defaulted fields during completion in IDEs. \ No newline at end of file +to provide markdown-rendered documentation hovers. +- They don't contain `default` attributes, since this triggers unwanted addition of defaulted fields during completion in IDEs. diff --git a/schemas/latest/ide-targeted/dev-workspace-template-spec.json b/schemas/latest/ide-targeted/dev-workspace-template-spec.json index 0ed3ddf3b..9746575f2 100644 --- a/schemas/latest/ide-targeted/dev-workspace-template-spec.json +++ b/schemas/latest/ide-targeted/dev-workspace-template-spec.json @@ -1,7 +1,7 @@ { "description": "Structure of the devworkspace. This is also the specification of a devworkspace template.\n\nIDE-targeted variants of the schemas provide the following difference compared to the main schemas:\n- They contain additional non-standard `markdownDescription` attributes that are used by IDEs such a VSCode\nto provide markdown-rendered documentation hovers. \n- They don't contain `default` attributes, since this triggers unwanted addition of defaulted fields during completion in IDEs.", "type": "object", - "title": "DevWorkspaceTemplateSpec schema - Version 2.2.0-alpha - IDE-targeted variant", + "title": "DevWorkspaceTemplateSpec schema - Version 2.2.1-alpha - IDE-targeted variant", "properties": { "attributes": { "description": "Map of implementation-dependant free-form YAML attributes.", diff --git a/schemas/latest/ide-targeted/dev-workspace-template.json b/schemas/latest/ide-targeted/dev-workspace-template.json index 5608abf41..302d88232 100644 --- a/schemas/latest/ide-targeted/dev-workspace-template.json +++ b/schemas/latest/ide-targeted/dev-workspace-template.json @@ -1,7 +1,7 @@ { "description": "DevWorkspaceTemplate is the Schema for the devworkspacetemplates API\n\nIDE-targeted variants of the schemas provide the following difference compared to the main schemas:\n- They contain additional non-standard `markdownDescription` attributes that are used by IDEs such a VSCode\nto provide markdown-rendered documentation hovers. \n- They don't contain `default` attributes, since this triggers unwanted addition of defaulted fields during completion in IDEs.", "type": "object", - "title": "DevWorkspaceTemplate schema - Version 2.2.0-alpha - IDE-targeted variant", + "title": "DevWorkspaceTemplate schema - Version 2.2.1-alpha - IDE-targeted variant", "properties": { "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", diff --git a/schemas/latest/ide-targeted/dev-workspace.json b/schemas/latest/ide-targeted/dev-workspace.json index 1956600f7..c26281b71 100644 --- a/schemas/latest/ide-targeted/dev-workspace.json +++ b/schemas/latest/ide-targeted/dev-workspace.json @@ -1,7 +1,7 @@ { "description": "DevWorkspace is the Schema for the devworkspaces API\n\nIDE-targeted variants of the schemas provide the following difference compared to the main schemas:\n- They contain additional non-standard `markdownDescription` attributes that are used by IDEs such a VSCode\nto provide markdown-rendered documentation hovers. \n- They don't contain `default` attributes, since this triggers unwanted addition of defaulted fields during completion in IDEs.", "type": "object", - "title": "DevWorkspace schema - Version 2.2.0-alpha - IDE-targeted variant", + "title": "DevWorkspace schema - Version 2.2.1-alpha - IDE-targeted variant", "properties": { "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", diff --git a/schemas/latest/ide-targeted/devfile.json b/schemas/latest/ide-targeted/devfile.json index fd4333621..2305bdf90 100644 --- a/schemas/latest/ide-targeted/devfile.json +++ b/schemas/latest/ide-targeted/devfile.json @@ -1,7 +1,7 @@ { "description": "Devfile describes the structure of a cloud-native devworkspace and development environment.\n\nIDE-targeted variants of the schemas provide the following difference compared to the main schemas:\n- They contain additional non-standard `markdownDescription` attributes that are used by IDEs such a VSCode\nto provide markdown-rendered documentation hovers. \n- They don't contain `default` attributes, since this triggers unwanted addition of defaulted fields during completion in IDEs.", "type": "object", - "title": "Devfile schema - Version 2.2.0-alpha - IDE-targeted variant", + "title": "Devfile schema - Version 2.2.1-alpha - IDE-targeted variant", "required": [ "schemaVersion" ], diff --git a/schemas/latest/ide-targeted/parent-overrides.json b/schemas/latest/ide-targeted/parent-overrides.json index aab4754e6..078adff38 100644 --- a/schemas/latest/ide-targeted/parent-overrides.json +++ b/schemas/latest/ide-targeted/parent-overrides.json @@ -1,7 +1,7 @@ { "description": "\n\nIDE-targeted variants of the schemas provide the following difference compared to the main schemas:\n- They contain additional non-standard `markdownDescription` attributes that are used by IDEs such a VSCode\nto provide markdown-rendered documentation hovers. \n- They don't contain `default` attributes, since this triggers unwanted addition of defaulted fields during completion in IDEs.", "type": "object", - "title": "ParentOverrides schema - Version 2.2.0-alpha - IDE-targeted variant", + "title": "ParentOverrides schema - Version 2.2.1-alpha - IDE-targeted variant", "properties": { "attributes": { "description": "Overrides of attributes encapsulated in a parent devfile. Overriding is done according to K8S strategic merge patch standard rules.", diff --git a/schemas/latest/ide-targeted/plugin-overrides.json b/schemas/latest/ide-targeted/plugin-overrides.json index 48147afed..6700a1560 100644 --- a/schemas/latest/ide-targeted/plugin-overrides.json +++ b/schemas/latest/ide-targeted/plugin-overrides.json @@ -1,7 +1,7 @@ { "description": "\n\nIDE-targeted variants of the schemas provide the following difference compared to the main schemas:\n- They contain additional non-standard `markdownDescription` attributes that are used by IDEs such a VSCode\nto provide markdown-rendered documentation hovers. \n- They don't contain `default` attributes, since this triggers unwanted addition of defaulted fields during completion in IDEs.", "type": "object", - "title": "PluginOverrides schema - Version 2.2.0-alpha - IDE-targeted variant", + "title": "PluginOverrides schema - Version 2.2.1-alpha - IDE-targeted variant", "properties": { "commands": { "description": "Overrides of commands encapsulated in a parent devfile or a plugin. Overriding is done according to K8S strategic merge patch standard rules.", diff --git a/schemas/latest/jsonSchemaVersion.txt b/schemas/latest/jsonSchemaVersion.txt index 935b04258..1d0111f93 100644 --- a/schemas/latest/jsonSchemaVersion.txt +++ b/schemas/latest/jsonSchemaVersion.txt @@ -1 +1 @@ -2.2.0-alpha \ No newline at end of file +2.2.1-alpha \ No newline at end of file diff --git a/schemas/latest/parent-overrides.json b/schemas/latest/parent-overrides.json index 7b77a4de0..f9763f955 100644 --- a/schemas/latest/parent-overrides.json +++ b/schemas/latest/parent-overrides.json @@ -1,6 +1,6 @@ { "type": "object", - "title": "ParentOverrides schema - Version 2.2.0-alpha", + "title": "ParentOverrides schema - Version 2.2.1-alpha", "properties": { "attributes": { "description": "Overrides of attributes encapsulated in a parent devfile. Overriding is done according to K8S strategic merge patch standard rules.", diff --git a/schemas/latest/plugin-overrides.json b/schemas/latest/plugin-overrides.json index df4222092..c905f36d7 100644 --- a/schemas/latest/plugin-overrides.json +++ b/schemas/latest/plugin-overrides.json @@ -1,6 +1,6 @@ { "type": "object", - "title": "PluginOverrides schema - Version 2.2.0-alpha", + "title": "PluginOverrides schema - Version 2.2.1-alpha", "properties": { "commands": { "description": "Overrides of commands encapsulated in a parent devfile or a plugin. Overriding is done according to K8S strategic merge patch standard rules.", From 8dae7ba9bfa5bd31e49ed437054d89bf00ce8089 Mon Sep 17 00:00:00 2001 From: Paul Schultz Date: Thu, 27 Oct 2022 12:59:24 -0500 Subject: [PATCH 3/9] updated pull request template Signed-off-by: Paul Schultz --- .github/PULL_REQUEST_TEMPLATE.md | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 045c9db7f..3a86c821d 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,29 +1,31 @@ -### What does this PR do?: +# What does this PR do? + -### Which issue(s) this PR fixes: +## Which issue(s) does this PR fix + -### PR acceptance criteria: +## PR acceptance criteria + Testing and documentation do not need to be complete in order for this PR to be approved. We just need to ensure tracking issues are opened. > - Open new test/doc issues under the [devfile/api](https://github.com/devfile/api/issues) repo > - Check each criteria if: -> - There is a separate tracking issue. Add the issue link under the criteria +> - There is a separate tracking issue. Add the issue link under the criteria > **or** -> - test/doc updates are made as part of this PR -> - If unchecked, explain why it's not needed - +> - test/doc updates are made as part of this PR +> - If unchecked, explain why it's not needed - [ ] Unit/Functional tests -- [ ] [QE Integration test](https://github.com/devfile/integration-tests) +- [ ] [QE Integration test](https://github.com/devfile/integration-tests) -- [ ] Documentation +- [ ] Documentation @@ -31,5 +33,4 @@ Testing and documentation do not need to be complete in order for this PR to be - -### How to test changes / Special notes to the reviewer: +### How to test changes / Special notes to the reviewer From 7c33d39c50596742456f9f1f871b2a564c459614 Mon Sep 17 00:00:00 2001 From: Paul Schultz Date: Thu, 27 Oct 2022 13:05:49 -0500 Subject: [PATCH 4/9] added eol to ci workflow Signed-off-by: Paul Schultz --- .github/workflows/ci.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index 7210dd461..4b7459f4e 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -80,10 +80,10 @@ jobs: then echo "gosec scanner failed to run " exit 1 - fi + fi - name: Upload SARIF file uses: github/codeql-action/upload-sarif@v2 with: # Path to SARIF file relative to the root of the repository - sarif_file: gosec.sarif \ No newline at end of file + sarif_file: gosec.sarif From bc779cd0844f18bbf17905b5e8eda9a3c9157f0e Mon Sep 17 00:00:00 2001 From: Paul Schultz Date: Fri, 28 Oct 2022 11:08:10 -0500 Subject: [PATCH 5/9] renamed readme Signed-off-by: Paul Schultz --- schemas/latest/ide-targeted/{Readme.md => README.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename schemas/latest/ide-targeted/{Readme.md => README.md} (100%) diff --git a/schemas/latest/ide-targeted/Readme.md b/schemas/latest/ide-targeted/README.md similarity index 100% rename from schemas/latest/ide-targeted/Readme.md rename to schemas/latest/ide-targeted/README.md From f2ef023aa96c627fd622c113fe57c679287f8a4b Mon Sep 17 00:00:00 2001 From: Paul Schultz Date: Fri, 28 Oct 2022 11:12:30 -0500 Subject: [PATCH 6/9] removed md as lf Signed-off-by: Paul Schultz --- .gitattributes | 1 - 1 file changed, 1 deletion(-) diff --git a/.gitattributes b/.gitattributes index fb95da39d..5499bf057 100644 --- a/.gitattributes +++ b/.gitattributes @@ -69,7 +69,6 @@ Procfile eol=lf .slugignore eol=lf # Documentation -*.md eol=lf LICENSE eol=lf AUTHORS eol=lf From 3cf2cc3d5c9c70fc9ef693219e935ef190ff3106 Mon Sep 17 00:00:00 2001 From: Paul Schultz Date: Fri, 28 Oct 2022 11:22:57 -0500 Subject: [PATCH 7/9] rebuilt Signed-off-by: Paul Schultz --- .gitattributes | 1 + schemas/latest/ide-targeted/README.md | 6 ++---- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/.gitattributes b/.gitattributes index 5499bf057..fb95da39d 100644 --- a/.gitattributes +++ b/.gitattributes @@ -69,6 +69,7 @@ Procfile eol=lf .slugignore eol=lf # Documentation +*.md eol=lf LICENSE eol=lf AUTHORS eol=lf diff --git a/schemas/latest/ide-targeted/README.md b/schemas/latest/ide-targeted/README.md index 354a12016..bdcbf8f8f 100644 --- a/schemas/latest/ide-targeted/README.md +++ b/schemas/latest/ide-targeted/README.md @@ -1,6 +1,4 @@ -# ide-targeted - IDE-targeted variants of the schemas provide the following difference compared to the main schemas: - They contain additional non-standard `markdownDescription` attributes that are used by IDEs such a VSCode -to provide markdown-rendered documentation hovers. -- They don't contain `default` attributes, since this triggers unwanted addition of defaulted fields during completion in IDEs. +to provide markdown-rendered documentation hovers. +- They don't contain `default` attributes, since this triggers unwanted addition of defaulted fields during completion in IDEs. \ No newline at end of file From 086889e5ddf040b53633bbac724a4efc1bca713d Mon Sep 17 00:00:00 2001 From: Paul Schultz Date: Fri, 28 Oct 2022 11:29:07 -0500 Subject: [PATCH 8/9] renamed file readme file name output Signed-off-by: Paul Schultz --- generator/schemas/gen.go | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/generator/schemas/gen.go b/generator/schemas/gen.go index f30fdcff3..6ece78ef1 100644 --- a/generator/schemas/gen.go +++ b/generator/schemas/gen.go @@ -319,7 +319,7 @@ This is not the case in the "%s' API group: ideTargetedSchemasExplanation := `IDE-targeted variants of the schemas provide the following difference compared to the main schemas: - They contain additional non-standard ` + "`markdownDescription`" + ` attributes that are used by IDEs such a VSCode -to provide markdown-rendered documentation hovers. +to provide markdown-rendered documentation hovers. - They don't contain ` + "`default`" + ` attributes, since this triggers unwanted addition of defaulted fields during completion in IDEs.` (¤tJSONSchema).Title = (¤tJSONSchema).Title + " - IDE-targeted variant" @@ -349,7 +349,7 @@ to provide markdown-rendered documentation hovers. root.AddError(err) return nil } - err = writeFile(ctx, folderForIdeTargetedSchemas, "Readme.md", []byte(ideTargetedSchemasExplanation)) + err = writeFile(ctx, folderForIdeTargetedSchemas, "README.md", []byte(ideTargetedSchemasExplanation)) if err != nil { root.AddError(err) return nil From 85f3e1e5a102d07aa922ef6bcc789543f4c73b3f Mon Sep 17 00:00:00 2001 From: Paul Schultz Date: Fri, 28 Oct 2022 14:09:30 -0500 Subject: [PATCH 9/9] changed for comments Signed-off-by: Paul Schultz --- .gitattributes | 2 -- .github/PULL_REQUEST_TEMPLATE.md | 6 +++--- README.md | 6 +++--- schemas/latest/ide-targeted/README.md | 2 +- .../latest/ide-targeted/dev-workspace-template-spec.json | 4 ++-- schemas/latest/ide-targeted/dev-workspace-template.json | 4 ++-- schemas/latest/ide-targeted/dev-workspace.json | 4 ++-- schemas/latest/ide-targeted/devfile.json | 4 ++-- schemas/latest/ide-targeted/parent-overrides.json | 4 ++-- schemas/latest/ide-targeted/plugin-overrides.json | 4 ++-- 10 files changed, 19 insertions(+), 21 deletions(-) diff --git a/.gitattributes b/.gitattributes index fb95da39d..b2f5e5732 100644 --- a/.gitattributes +++ b/.gitattributes @@ -14,7 +14,6 @@ generator/vendor/** linguist-vendored *.jsx eol=lf *.tsx eol=lf *.coffee eol=lf -*.json eol=lf *.htm eol=lf *.html eol=lf *.xml eol=lf @@ -69,7 +68,6 @@ Procfile eol=lf .slugignore eol=lf # Documentation -*.md eol=lf LICENSE eol=lf AUTHORS eol=lf diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 3a86c821d..2ca1065c8 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,12 +1,12 @@ -# What does this PR do? +## What does this PR do? -## Which issue(s) does this PR fix +### Which issue(s) does this PR fix -## PR acceptance criteria +### PR acceptance criteria Testing and documentation do not need to be complete in order for this PR to be approved. We just need to ensure tracking issues are opened. diff --git a/README.md b/README.md index 51765a6e3..9a650578c 100644 --- a/README.md +++ b/README.md @@ -22,11 +22,11 @@ Generated files are created by a build script (see section [How to build](#how-t ## 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]([devfile-support/README.md](https://github.com/devfile/registry-support/blob/main/README.md)) +For more information about this, please look into the [Devfile support README](https://github.com/devfile/registry-support/blob/main/README.md) -The generated documentation of the Devfile 2.0 format, based on its json schema, is available here: +The generated documentation of the Devfile 2.0 format, based on its json schema, is available [here](https://devfile.github.io). -Typescript model is build on each commit of main branch and available as NPM package at +Typescript model is build on each commit of main branch and available as an [NPM package](https://www.npmjs.com/package/@devfile/api). ## Release diff --git a/schemas/latest/ide-targeted/README.md b/schemas/latest/ide-targeted/README.md index bdcbf8f8f..56ee6f143 100644 --- a/schemas/latest/ide-targeted/README.md +++ b/schemas/latest/ide-targeted/README.md @@ -1,4 +1,4 @@ IDE-targeted variants of the schemas provide the following difference compared to the main schemas: - They contain additional non-standard `markdownDescription` attributes that are used by IDEs such a VSCode -to provide markdown-rendered documentation hovers. +to provide markdown-rendered documentation hovers. - They don't contain `default` attributes, since this triggers unwanted addition of defaulted fields during completion in IDEs. \ No newline at end of file diff --git a/schemas/latest/ide-targeted/dev-workspace-template-spec.json b/schemas/latest/ide-targeted/dev-workspace-template-spec.json index 9746575f2..e543d7a9d 100644 --- a/schemas/latest/ide-targeted/dev-workspace-template-spec.json +++ b/schemas/latest/ide-targeted/dev-workspace-template-spec.json @@ -1,5 +1,5 @@ { - "description": "Structure of the devworkspace. This is also the specification of a devworkspace template.\n\nIDE-targeted variants of the schemas provide the following difference compared to the main schemas:\n- They contain additional non-standard `markdownDescription` attributes that are used by IDEs such a VSCode\nto provide markdown-rendered documentation hovers. \n- They don't contain `default` attributes, since this triggers unwanted addition of defaulted fields during completion in IDEs.", + "description": "Structure of the devworkspace. This is also the specification of a devworkspace template.\n\nIDE-targeted variants of the schemas provide the following difference compared to the main schemas:\n- They contain additional non-standard `markdownDescription` attributes that are used by IDEs such a VSCode\nto provide markdown-rendered documentation hovers.\n- They don't contain `default` attributes, since this triggers unwanted addition of defaulted fields during completion in IDEs.", "type": "object", "title": "DevWorkspaceTemplateSpec schema - Version 2.2.1-alpha - IDE-targeted variant", "properties": { @@ -4118,5 +4118,5 @@ } }, "additionalProperties": false, - "markdownDescription": "Structure of the devworkspace. This is also the specification of a devworkspace template.\n\nIDE-targeted variants of the schemas provide the following difference compared to the main schemas:\n- They contain additional non-standard `markdownDescription` attributes that are used by IDEs such a VSCode\nto provide markdown-rendered documentation hovers. \n- They don't contain `default` attributes, since this triggers unwanted addition of defaulted fields during completion in IDEs." + "markdownDescription": "Structure of the devworkspace. This is also the specification of a devworkspace template.\n\nIDE-targeted variants of the schemas provide the following difference compared to the main schemas:\n- They contain additional non-standard `markdownDescription` attributes that are used by IDEs such a VSCode\nto provide markdown-rendered documentation hovers.\n- They don't contain `default` attributes, since this triggers unwanted addition of defaulted fields during completion in IDEs." } \ No newline at end of file diff --git a/schemas/latest/ide-targeted/dev-workspace-template.json b/schemas/latest/ide-targeted/dev-workspace-template.json index 302d88232..dc2c1b2a0 100644 --- a/schemas/latest/ide-targeted/dev-workspace-template.json +++ b/schemas/latest/ide-targeted/dev-workspace-template.json @@ -1,5 +1,5 @@ { - "description": "DevWorkspaceTemplate is the Schema for the devworkspacetemplates API\n\nIDE-targeted variants of the schemas provide the following difference compared to the main schemas:\n- They contain additional non-standard `markdownDescription` attributes that are used by IDEs such a VSCode\nto provide markdown-rendered documentation hovers. \n- They don't contain `default` attributes, since this triggers unwanted addition of defaulted fields during completion in IDEs.", + "description": "DevWorkspaceTemplate is the Schema for the devworkspacetemplates API\n\nIDE-targeted variants of the schemas provide the following difference compared to the main schemas:\n- They contain additional non-standard `markdownDescription` attributes that are used by IDEs such a VSCode\nto provide markdown-rendered documentation hovers.\n- They don't contain `default` attributes, since this triggers unwanted addition of defaulted fields during completion in IDEs.", "type": "object", "title": "DevWorkspaceTemplate schema - Version 2.2.1-alpha - IDE-targeted variant", "properties": { @@ -4321,5 +4321,5 @@ } }, "additionalProperties": false, - "markdownDescription": "DevWorkspaceTemplate is the Schema for the devworkspacetemplates API\n\nIDE-targeted variants of the schemas provide the following difference compared to the main schemas:\n- They contain additional non-standard `markdownDescription` attributes that are used by IDEs such a VSCode\nto provide markdown-rendered documentation hovers. \n- They don't contain `default` attributes, since this triggers unwanted addition of defaulted fields during completion in IDEs." + "markdownDescription": "DevWorkspaceTemplate is the Schema for the devworkspacetemplates API\n\nIDE-targeted variants of the schemas provide the following difference compared to the main schemas:\n- They contain additional non-standard `markdownDescription` attributes that are used by IDEs such a VSCode\nto provide markdown-rendered documentation hovers.\n- They don't contain `default` attributes, since this triggers unwanted addition of defaulted fields during completion in IDEs." } \ No newline at end of file diff --git a/schemas/latest/ide-targeted/dev-workspace.json b/schemas/latest/ide-targeted/dev-workspace.json index c26281b71..2af16f7eb 100644 --- a/schemas/latest/ide-targeted/dev-workspace.json +++ b/schemas/latest/ide-targeted/dev-workspace.json @@ -1,5 +1,5 @@ { - "description": "DevWorkspace is the Schema for the devworkspaces API\n\nIDE-targeted variants of the schemas provide the following difference compared to the main schemas:\n- They contain additional non-standard `markdownDescription` attributes that are used by IDEs such a VSCode\nto provide markdown-rendered documentation hovers. \n- They don't contain `default` attributes, since this triggers unwanted addition of defaulted fields during completion in IDEs.", + "description": "DevWorkspace is the Schema for the devworkspaces API\n\nIDE-targeted variants of the schemas provide the following difference compared to the main schemas:\n- They contain additional non-standard `markdownDescription` attributes that are used by IDEs such a VSCode\nto provide markdown-rendered documentation hovers.\n- They don't contain `default` attributes, since this triggers unwanted addition of defaulted fields during completion in IDEs.", "type": "object", "title": "DevWorkspace schema - Version 2.2.1-alpha - IDE-targeted variant", "properties": { @@ -5316,5 +5316,5 @@ } }, "additionalProperties": false, - "markdownDescription": "DevWorkspace is the Schema for the devworkspaces API\n\nIDE-targeted variants of the schemas provide the following difference compared to the main schemas:\n- They contain additional non-standard `markdownDescription` attributes that are used by IDEs such a VSCode\nto provide markdown-rendered documentation hovers. \n- They don't contain `default` attributes, since this triggers unwanted addition of defaulted fields during completion in IDEs." + "markdownDescription": "DevWorkspace is the Schema for the devworkspaces API\n\nIDE-targeted variants of the schemas provide the following difference compared to the main schemas:\n- They contain additional non-standard `markdownDescription` attributes that are used by IDEs such a VSCode\nto provide markdown-rendered documentation hovers.\n- They don't contain `default` attributes, since this triggers unwanted addition of defaulted fields during completion in IDEs." } \ No newline at end of file diff --git a/schemas/latest/ide-targeted/devfile.json b/schemas/latest/ide-targeted/devfile.json index 2305bdf90..9158d7dbb 100644 --- a/schemas/latest/ide-targeted/devfile.json +++ b/schemas/latest/ide-targeted/devfile.json @@ -1,5 +1,5 @@ { - "description": "Devfile describes the structure of a cloud-native devworkspace and development environment.\n\nIDE-targeted variants of the schemas provide the following difference compared to the main schemas:\n- They contain additional non-standard `markdownDescription` attributes that are used by IDEs such a VSCode\nto provide markdown-rendered documentation hovers. \n- They don't contain `default` attributes, since this triggers unwanted addition of defaulted fields during completion in IDEs.", + "description": "Devfile describes the structure of a cloud-native devworkspace and development environment.\n\nIDE-targeted variants of the schemas provide the following difference compared to the main schemas:\n- They contain additional non-standard `markdownDescription` attributes that are used by IDEs such a VSCode\nto provide markdown-rendered documentation hovers.\n- They don't contain `default` attributes, since this triggers unwanted addition of defaulted fields during completion in IDEs.", "type": "object", "title": "Devfile schema - Version 2.2.1-alpha - IDE-targeted variant", "required": [ @@ -2300,5 +2300,5 @@ } }, "additionalProperties": false, - "markdownDescription": "Devfile describes the structure of a cloud-native devworkspace and development environment.\n\nIDE-targeted variants of the schemas provide the following difference compared to the main schemas:\n- They contain additional non-standard `markdownDescription` attributes that are used by IDEs such a VSCode\nto provide markdown-rendered documentation hovers. \n- They don't contain `default` attributes, since this triggers unwanted addition of defaulted fields during completion in IDEs." + "markdownDescription": "Devfile describes the structure of a cloud-native devworkspace and development environment.\n\nIDE-targeted variants of the schemas provide the following difference compared to the main schemas:\n- They contain additional non-standard `markdownDescription` attributes that are used by IDEs such a VSCode\nto provide markdown-rendered documentation hovers.\n- They don't contain `default` attributes, since this triggers unwanted addition of defaulted fields during completion in IDEs." } \ No newline at end of file diff --git a/schemas/latest/ide-targeted/parent-overrides.json b/schemas/latest/ide-targeted/parent-overrides.json index 078adff38..df9d32900 100644 --- a/schemas/latest/ide-targeted/parent-overrides.json +++ b/schemas/latest/ide-targeted/parent-overrides.json @@ -1,5 +1,5 @@ { - "description": "\n\nIDE-targeted variants of the schemas provide the following difference compared to the main schemas:\n- They contain additional non-standard `markdownDescription` attributes that are used by IDEs such a VSCode\nto provide markdown-rendered documentation hovers. \n- They don't contain `default` attributes, since this triggers unwanted addition of defaulted fields during completion in IDEs.", + "description": "\n\nIDE-targeted variants of the schemas provide the following difference compared to the main schemas:\n- They contain additional non-standard `markdownDescription` attributes that are used by IDEs such a VSCode\nto provide markdown-rendered documentation hovers.\n- They don't contain `default` attributes, since this triggers unwanted addition of defaulted fields during completion in IDEs.", "type": "object", "title": "ParentOverrides schema - Version 2.2.1-alpha - IDE-targeted variant", "properties": { @@ -1923,5 +1923,5 @@ } }, "additionalProperties": false, - "markdownDescription": "\n\nIDE-targeted variants of the schemas provide the following difference compared to the main schemas:\n- They contain additional non-standard `markdownDescription` attributes that are used by IDEs such a VSCode\nto provide markdown-rendered documentation hovers. \n- They don't contain `default` attributes, since this triggers unwanted addition of defaulted fields during completion in IDEs." + "markdownDescription": "\n\nIDE-targeted variants of the schemas provide the following difference compared to the main schemas:\n- They contain additional non-standard `markdownDescription` attributes that are used by IDEs such a VSCode\nto provide markdown-rendered documentation hovers.\n- They don't contain `default` attributes, since this triggers unwanted addition of defaulted fields during completion in IDEs." } \ No newline at end of file diff --git a/schemas/latest/ide-targeted/plugin-overrides.json b/schemas/latest/ide-targeted/plugin-overrides.json index 6700a1560..5d942acd0 100644 --- a/schemas/latest/ide-targeted/plugin-overrides.json +++ b/schemas/latest/ide-targeted/plugin-overrides.json @@ -1,5 +1,5 @@ { - "description": "\n\nIDE-targeted variants of the schemas provide the following difference compared to the main schemas:\n- They contain additional non-standard `markdownDescription` attributes that are used by IDEs such a VSCode\nto provide markdown-rendered documentation hovers. \n- They don't contain `default` attributes, since this triggers unwanted addition of defaulted fields during completion in IDEs.", + "description": "\n\nIDE-targeted variants of the schemas provide the following difference compared to the main schemas:\n- They contain additional non-standard `markdownDescription` attributes that are used by IDEs such a VSCode\nto provide markdown-rendered documentation hovers.\n- They don't contain `default` attributes, since this triggers unwanted addition of defaulted fields during completion in IDEs.", "type": "object", "title": "PluginOverrides schema - Version 2.2.1-alpha - IDE-targeted variant", "properties": { @@ -831,5 +831,5 @@ } }, "additionalProperties": false, - "markdownDescription": "\n\nIDE-targeted variants of the schemas provide the following difference compared to the main schemas:\n- They contain additional non-standard `markdownDescription` attributes that are used by IDEs such a VSCode\nto provide markdown-rendered documentation hovers. \n- They don't contain `default` attributes, since this triggers unwanted addition of defaulted fields during completion in IDEs." + "markdownDescription": "\n\nIDE-targeted variants of the schemas provide the following difference compared to the main schemas:\n- They contain additional non-standard `markdownDescription` attributes that are used by IDEs such a VSCode\nto provide markdown-rendered documentation hovers.\n- They don't contain `default` attributes, since this triggers unwanted addition of defaulted fields during completion in IDEs." } \ No newline at end of file