Skip to content

🐛 Wrong metadata files not being caught #4141

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lucasrodes opened this issue Mar 18, 2025 · 1 comment
Open

🐛 Wrong metadata files not being caught #4141

lucasrodes opened this issue Mar 18, 2025 · 1 comment

Comments

@lucasrodes
Copy link
Member

lucasrodes commented Mar 18, 2025

Ike reported some metadata YAML files that shouldn't be valid, yet they went unnoticed:

We should:

  • Fix these
  • Try to have our CI/CD detect these
@Marigold
Copy link
Collaborator

Both of these errors are correctly labeled with warnings by the YAML linter in VSCode (so the JSON Schema is working as intended).

The thing is, we don't strictly enforce YAML validity because many files still use deprecated fields like description and source, which would trigger a flood of errors. We have a few options:

  1. Add description and source to the JSON Schema and perform strict validation

    • The downside is that these fields wouldn’t raise warnings in VSCode and would appear in autocomplete suggestions.
  2. Migrate all description and source fields to the new metadata format

    • (How many datasets still need to be updated?)

Note: JSON Schema does have a "deprecated": true property, but it doesn’t seem to have any effect in VSCode.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants