Skip to content
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

New builtin schema type: CITATION.cff? #502

Open
henryiii opened this issue Nov 16, 2024 · 0 comments
Open

New builtin schema type: CITATION.cff? #502

henryiii opened this issue Nov 16, 2024 · 0 comments

Comments

@henryiii
Copy link

henryiii commented Nov 16, 2024

Would it make sense to add CITATION.cff to the built-in schemas? It would be nice to have a flag and a pre-commit check for it, currently it requires:

uvx check-jsonschema --schemafile https://raw.githubusercontent.com/citation-file-format/citation-file-format/main/schema.json --no-cache --default-filetype yaml CITATION.cff

and

      - id: check-jsonschema
        name: Validate CITATION.cff
        files: ^CITATION.cff$
        types_or: [file]
        args:
          - --schemafile=https://raw.githubusercontent.com/citation-file-format/citation-file-format/main/schema.json
          - --default-filetype=yaml
          - --no-cache

(This also doesn't work for pre-commit.ci, it can't pull this file, being built-in should fix that)

Ref for CITATION.cff: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files and links from there. Most notably, https://github.com/citation-file-format/citation-file-format/blob/main/schema-guide.md#definitionsreferencedate-published. The link above is from SchemaStore.

PS: I'm not sure why --no-cache is required, it gets a completely incorrect file if not passed. Maybe it's caching on the name schema.json?

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

No branches or pull requests

1 participant