Repository navigation
docs: add .zenodo.json release metadata - #9
Merged
Merged
Conversation
sparkainlp-x
added a commit
that referenced
this pull request
Sep 27, 2026
Adds a `.zenodo.json` so future GitHub-release archives on Zenodo get curated metadata instead of auto-extracted defaults. **What's in it** - `upload_type: software`, title identical to the current Zenodo record and `CITATION.cff` - HTML description drawn only from this README (evidence tags preserved, explicit scope/limits paragraph; only Zenodo-allowed HTML tags) - creators: `Brisson, Jean-François` (Spark AI NLP); `license: MIT` (matches `LICENSE` and `CITATION.cff`); `access_right: open`; `language: eng` - curated keywords and `related_identifiers` (see file) - **No** `version` (Zenodo takes it from the tag) and **no** `communities` (the community does not exist yet; referencing it would break archiving) **Validation** - Parses as JSON; checked against Zenodo's legacy deposit JSON Schema (`zenodo/zenodo` master `legacyrecord.json`). That schema file predates the documented `language` field, so `language` was excluded for the schema check only; it is listed in the deposit-metadata docs (developers.zenodo.org#representation) and the help-page `.zenodo.json` example. - Title / author / license cross-checked against `CITATION.cff` and the published Zenodo record. Note: when `.zenodo.json` exists, Zenodo ignores `CITATION.cff` for archiving, so the two must stay consistent. **Notes** - ORCID is intentionally omitted for now; it will be added later (here and in `CITATION.cff`) once provided. - No release is cut by this PR; the metadata applies from the next tagged release. Existing records can be edited by hand on Zenodo. - Docs/metadata-only change; no code changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a
.zenodo.jsonso future GitHub-release archives on Zenodo get curated metadata instead of auto-extracted defaults.What's in it
upload_type: software, title identical to the current Zenodo record andCITATION.cffBrisson, Jean-François(Spark AI NLP);license: MIT(matchesLICENSEandCITATION.cff);access_right: open;language: engrelated_identifiers(see file)version(Zenodo takes it from the tag) and nocommunities(the community does not exist yet; referencing it would break archiving)Validation
zenodo/zenodomasterlegacyrecord.json). That schema file predates the documentedlanguagefield, solanguagewas excluded for the schema check only; it is listed in the deposit-metadata docs (developers.zenodo.org#representation) and the help-page.zenodo.jsonexample.CITATION.cffand the published Zenodo record. Note: when.zenodo.jsonexists, Zenodo ignoresCITATION.cfffor archiving, so the two must stay consistent.Notes
CITATION.cff) once provided.