Add top-level schema fields

[bollwyvl]

References

• Add more standards-based conventions to schema #29
• [bot-automerge] yaml-language-server v1.24.0 conda-forge/yaml-language-server-feedstock#13

Changes

• add top-level schema fields
  • $id
  • $schema to declare Draft 7
  • title
  • oneOf
    • change the top-level anyOf to the more accurate oneOf
  • $defs/*Recipe/properties/$schema
• update tests

Motivation

Over two years since the initial PR, yaml-language-server has added support for locating schema from inline $schema instead of #yadda-yadda: $schema or # $schema (used by some other tools). This would allow for more precise and machine-readable identification.

Future Work

• Publish the schema somewhere versioned
  • my recommendation would be ReadTheDocs, as versions, and the per-PR preview site are far easier to review vs "you get exactly one" of GitHub pages
• Encourage downstream tools like conda-recipe-manager to populate the $schema: field

[Hofer-Julian]

Thank you

[Hofer-Julian]

If CI is fine, let's merge it. Please ping me if I forget

[bollwyvl]

Of note, rattler-builder won't yet parse this:

Error:   × Failed to parse recipe
  ╰─▶ invalid value for 'recipe': unknown top-level field '$schema'
   ╭─[/home/conda/recipe_root/recipe.yaml:1:1]
 1 │ $schema: https://raw.githubusercontent.com/bollwyvl/recipe-format/992602280c73642fece6daf865c9774e7bb92e62/schema.json
   · ───┬───
   ·    ╰── invalid value for 'recipe': unknown top-level field '$schema'
 2 │ schema_version: 1
   ╰────
  help: valid top-level fields are: package, build, about, requirements, extra, source, tests, schema_version, context

[bollwyvl]

Started prefix-dev/rattler-build#2645

[bollwyvl]

Modulo some further changes, this is probably ready. Not sure the order of operations for linked PRs.

[Hofer-Julian]

Modulo some further changes, this is probably ready. Not sure the order of operations for linked PRs.

I guess we can bring it in?
The schema would be superset of what rattler-build allows, which sounds fine to me