Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Tekton CRD Schema to JSON Schema Store for YAML extension used in VS Code #4688

Closed
Lucifergene opened this issue Mar 17, 2022 · 6 comments
Labels
help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/feature Categorizes issue or PR as related to a new feature. lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. priority/backlog Higher priority than priority/awaiting-more-evidence.

Comments

@Lucifergene
Copy link

Feature request

When using the YAML extension by Red Hat in VSCode during the writing YAML files, the files are showing errors when the kind is set to Task, Pipeline, etc, which are specific to Tekton. This extension fetches all the schemas from JSON Schema Store Website and matches our input with them. On this website, most of the schemas of the current CNCF tools are present, apart from Tekton.
Since the Tekton schema is not present in the database, it is not fetched by the extension, and therefore throws an error, when such keywords are mentioned.
This makes writing Tekton files difficult when working with VS Code and having the YAML extension installed. The workaround is to disable the extension to continue writing Tekton YAML files.

Therefore it would be great if the Tekton JSON schema is made available on the JSON Schema Store Website so that the YAML extension can save it in the database and can provide IntelliSense while writing Tekton files.

Use case

Creating the JSON schema for all the CRDs of Tekton Pipelines and uploading it to the JSON Schema Store Website](https://www.schemastore.org/json/), will help developers work on Tekton files without disabling the YAML extension by Red Hat](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml).
This will aid users with IntelliSense and other code completion features that the YAML Extension provides.

@Lucifergene Lucifergene added the kind/feature Categorizes issue or PR as related to a new feature. label Mar 17, 2022
@dibyom dibyom added help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. priority/backlog Higher priority than priority/awaiting-more-evidence. labels Mar 21, 2022
@abayer
Copy link
Contributor

abayer commented Mar 24, 2022

This feels related to #1461, but it's not exactly the same thing - I don't think structural OpenAPI schemas can actually be used as "true" JSON schemas. That said, I think generating a "true" JSON schema probably wouldn't hit the weird edge case problems we've had with auto-generating structural OpenAPI schemas, so this should be easier to pull off.

@abayer
Copy link
Contributor

abayer commented Mar 25, 2022

Ah, another hassle - file type mapping. schemastore maps specific filenames/patterns to specific schemas - since we don't have any consistent requirement for Tekton-related CRD filenames, there isn't really a way to say "oh, you're writing a Tekton Pipeline, here's the schema for that".

@tekton-robot
Copy link
Collaborator

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale with a justification.
Stale issues rot after an additional 30d of inactivity and eventually close.
If this issue is safe to close now please do so with /close with a justification.
If this issue should be exempted, mark the issue as frozen with /lifecycle frozen with a justification.

/lifecycle stale

Send feedback to tektoncd/plumbing.

@tekton-robot tekton-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jun 23, 2022
@kamok
Copy link

kamok commented Feb 6, 2024

This was done? I don't see Tekton CRD related schemas on the JSON Schema Store Website

My VSCode also doesn't recognize the Tekton CRDs

@ppitonak
Copy link
Contributor

ppitonak commented Mar 14, 2024

v1beta1 manifests are validated correctly when I install Tekton Pipelines extension but v1 fails. Any plans to fix it?

@lslavkov
Copy link

Is there any progress on this issue? Based on the status it seems it is closed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/feature Categorizes issue or PR as related to a new feature. lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. priority/backlog Higher priority than priority/awaiting-more-evidence.
Projects
None yet
Development

No branches or pull requests

7 participants