Fix CFF citation schema and metadata consistency checks - #290
Conversation
There was a problem hiding this comment.
🟢 Approval recommended
No unresolved review comments were identified, and the supplied assessments support approval.
Pull request overview
Updates citation metadata to comply with CFF 1.2.0 and keeps package metadata checks consistent.
Changes:
- Corrected CFF fields, contacts, ORCID URLs, and required message.
- Updated metadata validation for contacts and independent descriptions.
- Documented the fix in the changelog.
File summaries
| File | Description |
|---|---|
scripts/check_metadata.py |
Uses CFF contacts and validates package descriptions independently. |
CITATION.cff |
Corrected schema-invalid citation fields and identifiers. |
CHANGELOG.md |
Documents the citation schema fix. |
Review details
- Files reviewed: 3/3 changed files
- Comments generated: 0
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #290 +/- ##
=======================================
Coverage 94.49% 94.49%
=======================================
Files 49 49
Lines 4163 4163
=======================================
Hits 3934 3934
Misses 229 229 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
medley56
left a comment
There was a problem hiding this comment.
Does exactly what #285 asks and nothing more. I re-verified the schema claims against the CFF 1.2.0 schema.json (message is required; contact is a valid root key; description and maintainers are not; orcid must match https://orcid.org/…), confirmed cffconvert --validate fails on main and passes on this branch, and ran python scripts/check_metadata.py clean on the head checkout. The one substantive observation is pre-existing and left as a suggestion for a follow-up issue.
Coordination note: #284 also adds under ## [Unreleased] in CHANGELOG.md, so whichever of the two merges second will need a trivial rebase.
0 critical · 0 warning · 1 suggestion · 0 nitpick
🤖 AI-assisted comment, reviewed and approved by @medley56 before posting.
Summary
CITATION.cffis rejected by the CFF 1.2.0 schema, preventing citation exports. Add the required citation message, replacemaintainerswithcontact, expand ORCID identifiers to full URLs, and remove the unsupporteddescriptionfield while preserving the existing abstract.Update the metadata consistency check to read
contact. Package descriptions continue to be compared betweenpyproject.tomlandmeta.yaml; the longer citation abstract is intentionally independent.Closes #285.
Validation
cffconvert --validate -i CITATION.cfffailed on the original file and passes after the change.10.5281/zenodo.7735001. This PR does not duplicate the DOI/date changes from Add Zenodo concept DOI and date-released to CITATION.cff #284.python scripts/check_metadata.pypasses. Deliberately mismatching a package description or contact email still raises the expected consistency error.pytest --benchmark-disable -q: 481 passed (Windows, Python 3.12).git diff --checkpass.AI assistance was used to prepare this contribution and run the checks above.