redhat-developer / yaml-language-server

Language Server for YAML Files
MIT License
1.06k stars 260 forks source link

Using yaml-language-server as a CICD Pipeline yml schema validation tool #984

Open madslyng opened 1 month ago

madslyng commented 1 month ago

Summary

How do I run custom yml schema validation in a CICD pipeline?

Relevant information

We are building CICD Pipeline for Databricks Asset Bundle (DAB), using a bundle_config_schema.json which describes what is allowed to be specified in our config.yml files. If someone puts something incorrect, we would like the CICD Pipeline to be able to explain what the yaml-language-server found that diverges from the schema it is validating against.

I am having trouble getting the yaml-language-server --stdio to work. Maybe someone is able to help me understand how I would prepare and execute a shell command in this scenario:

Two files:

  1. file_to_validate.yml
  2. schema_to_use_for_validation.json

cat file_to_validate.yml | yaml-language-server --stdio > result

What am I missing to introduce the schema in the above command ?

bollwyvl commented 1 month ago

You may wish to try ylsc