semaphoreci / docs

Semaphore 2.0 documentation.
https://docs.semaphoreci.com
17 stars 83 forks source link

Request: Publish a json schema for use with semaphore YAML files #1230

Open bbugh opened 2 years ago

bbugh commented 2 years ago

schemastore.org is tracking JSON schemas. RedHat's yaml-language-server supports JSON schema parsing for YAML files pulled from schemastore.org. Many systems are using it now: GitHub's actions and workflows, graphql-code-generator's codegen.yml, CircleCI's config.yml, etc.

It's nice to have a linter in the CLI, but it would be very helpful for self-documenting files and validation if the semaphore.yml schema was published to schemastore.org, which tools (including yaml-language-server) could use to validate. There's lots of different ways to generate them.

schemaphore

pieterocp commented 4 months ago

Yeah, this is a big qol upgrade since you can get much faster feedback loops over having to push repeatedly when fiddling with config. It should only take about a week or so to get a decent working version together.

Given there is a 41:1 ROI using semaphore, you can claim even more with speedier feedback.

pieterocp commented 4 months ago

Until this is done, I've had to slap a docblock at the top (like below) so it doesn't think it's a appveyor file and suggests bad changes.

# yaml-language-server: $schema=https://json.schemastore.org/yamllint.json