dieghernan / cff-validator

Validate your CITATION.cff file with GitHub Actions

dieghernan

Connect with me:

       

Languages and Tools:

Projects

R packages

Package	Release	GitHub	Downloads	Issues
tidyterra
giscoR
mapSpain
cffr
tidyBdE
climaemet
CatastRo
igoR
nominatimlite
arcgeocoder
rasterpic
resmush
CatastRoNav
pkgdev
gitdevr
rogtemplate
rostemplate

Other projects

See more...

Organizations

cff-validator's Issues

Improve validation feedback?

Hi again,

This is something that all validation using generic JSON Schema validation packages have to deal with: the validation results may not be found very helpful in some cases, especially for users not experienced in schema validation. Improving the output is a lot of work and needs implementation of extra logic, but would help the user. Also, perhaps this could also be done in the upstream dependency itself. So this is more of a suggestion for discussion than a feature request.

E.g.,

• in this run, the error message is 1 data has additional properties (there is an extra key extra in the test file). It'd be great if in this case, the name of the addtl. property was provided.
• In this run, the error message is more helpful: 1 data["date-released"] referenced schema does not match. I think this is good enough. ✔️
• In this run, the error is 1 data.authors is required. Good enough ✔️

Additionally, I'm not sure that the field and message output are helpful/well-aligned with the output from the validation package:

------

                  field                          message
1 data["date-released"] referenced schema does not match

Cache dependencies

Hi @dieghernan, thanks for a great project!

I've found that using the example setup you provide in README.md, the dependencies for your script are downloaded and installed afresh every time the action is run, which increases runtime for users.

I'm not sure if there is perhaps a reason for doing this, and I haven't had a very close look at action.yml (and I'm not an experienced R user at all), but perhaps the dependencies could be cached as well? Or if they are, the example could be amended to enable caching?

Thanks!

validation fails in v2.2

The file https://github.com/eclipse/sumo/blob/bc4df2629e385b463bd7a0b58883c23cb3cd73e4/CITATION.cff validated just fine with v2. The new version triggers several errors: https://github.com/DLR-TS/sumo/actions/runs/3599552359/jobs/6063291364
This is probably related to the fact that we do not checkout to root but to a separate dir but I did not find a way to tell this fact to the validator.
Is it now required to have the cff file in the root and can we only validate inside a git repo?

SSL peer certificate or SSH remote key was not OK

We have been using dieghernan/cff-validator@main for a while now.

However since 19 Jul 2023 we get:
Error in download.file("https://raw.githubusercontent.com/citation-file-format/citation-file-format/main/schema.json", :
cannot open URL 'https://raw.githubusercontent.com/citation-file-format/citation-file-format/main/schema.json'
In addition: Warning message:
In download.file("https://raw.githubusercontent.com/citation-file-format/citation-file-format/main/schema.json", :
URL 'https://raw.githubusercontent.com/citation-file-format/citation-file-format/main/schema.json': status was 'SSL peer certificate or SSH remote key was not OK'

This also in github action that previously passed and where rerun.