SchemaStore / SchemaStore/schemastore

Rattler-build hogging the `recipe` basename for YAML files

Open
#4,401 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

fileMatch Conflict
Dominant language
JavaScript
Stars
3.8k
Forks
2.3k
Avg merge
20h 23m
Merged PRs (30d)
124

Description

Area with issue?

JSON Schema (actually YAML)

✔️ Expected Behavior

Only actual rattler-build YAML files get validated as such.

❌ Actual Behavior

All recipe.yaml or recipe.yml files are validated with the rattler-build schema, causing meaningless validation errors for all YAML files that are named in this way but aren't rattler-build files – likely a large majority of such files.

I have no clue what more specific naming rule would be suitable for rattler-build, but it seems wrong to assume that all YAML files with basename recipe are rattler-build files.

As a workaround I created my own Schema store here, and configured that URL e.g. for VS Code in the Yaml > Schema Store > Url setting.

YAML or JSON file that does not work.

No response

IDE or code editor.

Any/All

Are you making a PR for this?

Happy to open a PR for this or whatever else works, but actual rattler users should probably decide what specific naming convention to use.

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 with the rattler-build schema entry in src/api/json/catalog.json, linked in the issue, and inspect how its YAML filename rule matches recipe.yaml and recipe.yml. Determine a more specific convention with actual rattler-build users; done means unrelated YAML files with those basenames no longer receive rattler-build validation while genuine files still do.

Written by the indexing model from the issue text.

Assessment

Tech stack
yaml
Domain
tooling
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.