Skip to content

Add CITATION.cff and codemeta.json for Zenodo archival#94

Merged
annefou merged 1 commit into
mainfrom
add-citation-codemeta-zenodo
May 9, 2026
Merged

Add CITATION.cff and codemeta.json for Zenodo archival#94
annefou merged 1 commit into
mainfrom
add-citation-codemeta-zenodo

Conversation

@annefou

@annefou annefou commented May 9, 2026

Copy link
Copy Markdown
Contributor

Summary

Adds machine-readable citation metadata to the repo so the GitHub ↔ Zenodo integration captures rich author + license + keyword data on the next release.

  • CITATION.cff (CFF v1.2.0) — for citation tools (Zotero, Zenodo, Google Scholar)
  • codemeta.json (CodeMeta-2.0) — for software-discovery indexes (Software Heritage, OpenAIRE)

Authors listed (consistent across both files):

  1. Anne Fouilloux — LifeWatch ERIC — ORCID 0000-0002-1784-2920
  2. Vijay Prema — Prophet Town
  3. VitenHub AS — institutional author (CFF type: entity / CodeMeta @type: Organization)

Both files declare version: "1.0.6" to match the latest release tag.

Why now

Zenodo ↔ GitHub integration was just enabled for ScienceLiveHub/science-live-platform. On the next release, Zenodo will read these files to populate the deposit's authors, abstract, license, and keywords. Without them, the deposit gets the GitHub commit-based defaults (just an automated description).

DOI field — deferred

CITATION.cff does not yet have a doi: field, and codemeta.json does not yet have identifier/@id. These will be added in the release commit that mints the first Zenodo concept DOI (likely v1.0.7 or whichever next release happens, bundled with real fixes per the team's preference to avoid metadata-only releases).

Test plan

  • python3 -c "import yaml; yaml.safe_load(open('CITATION.cff'))" parses cleanly
  • python3 -c "import json; json.load(open('codemeta.json'))" parses cleanly
  • Optional: validate via https://citation-file-format.github.io/cff-validator/ and the CodeMeta validator
  • After merge + next release: confirm the Zenodo deposit shows three authors with correct affiliations + ORCID

References

Adds machine-readable citation metadata so the GitHub ↔ Zenodo
integration captures rich author + license + keyword data on the
next release. Authors:

- Anne Fouilloux (LifeWatch ERIC, ORCID 0000-0002-1784-2920)
- Vijay Prema (Prophet Town)
- VitenHub AS (institutional author)

Both files declare version 1.0.6 to match the latest release tag.
The DOI field is intentionally omitted; it will be added in the
release commit that triggers the first Zenodo mint.

References:
- CITATION.cff schema: https://citation-file-format.github.io/
- CodeMeta-2.0 schema: https://codemeta.github.io/
- FAIR4RS principles F1.1, F2, F3, R1.1: rich citable metadata.
@annefou annefou merged commit 03e4a23 into main May 9, 2026
7 checks passed
@annefou annefou deleted the add-citation-codemeta-zenodo branch May 9, 2026 09:58
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

Successfully merging this pull request may close these issues.

1 participant