redhat-developer / redhat-developer/yaml-language-server

document how to enable schema validation on CI

Open
#106 6 comments 7 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
TypeScript
Stars
1.5k
Forks
352
Avg merge
2d 7h
Merged PRs (30d)
11

Description

vscode-yaml is my favourite vscode plugin and I find it extreamly useful for validating various yaml files and ansible ones in particular.

Still, there is one aspect which is not covered by the tool: how to verify schema on an entire repository from the command line, so we can perform the checks on CI servers.

Before someone argues that this may be outside the scope of the extension please note that both kind of validations should be able to use the same configuration. If I set "roles/**/*.yml" to use Ansible schema, I need to be sure that the same setting is used by vscode and the command line call.

Once we have this sorted we should include a section in the main README that indicates on how to use it with automation.

At this moment I am not aware of any way of doing schema validation on CI so thus is why I opened this ticket.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the main README and the existing schema configuration documentation. Determine whether the current project exposes a command-line path that uses the same settings as vscode-yaml, then document the verified CI usage and shared configuration; if no such path exists, record that limitation rather than describing an unverified workflow.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
ci-cd, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.