[!ABSTRACT] This table illustrates the compatibility of Zenodo metadata fields with different resources in a GitHub repository.
The leftmost column in the table lists the Zenodo metadata fields that are supported by the Zendodo-GitHub-Integration. The other columns represent the different resources that are queried by the Zenodo agent, when a release of the repository is published. That means each cell corresponds to the Zenodo metadata field in the leftmost column in its row. The cells are color-coded: blue means the metadata field corresponding to the cell is fully supported by the resource corresponding to the cell, light yellow means its partially supported (mostly due to cardinality), and gray means its not supported.
The resources follow an overwrite hierarchy from right to left, meaning metadata information in resources that belong to columns further right take precedence over those further left.
| Zenodo Metadata Field [Cardinality] |
GitHub Repository Data | GitHub Release Data | LICENSE | CITATION.cff | .zenodo.json |
|---|---|---|---|---|---|
| Digital Object Identifier [1] | Created automatically | x | x | x | |
| Resource type [1] | Software | x | x | upload_type | |
| Title [1] | Combination of GitHub user name, repository name and release title/tag | x | title | title | |
| Publication date [1] | x | Current date | x | x | publication_date |
| Creators (Person) [n] | [1] | x | authors [n] | creators [n] | |
| ├─ Family name [1] | Read from GitHub profile (Field: Name) [1] | x | authors:familiy-names [1] | creators:name [1] | |
| ├─ Given names [n] | x | x | authors:given-names [n] | creators:name [n] | |
| ├─ Identifiers [n] | x | x | authors:orcid [1] | creators:orcid/gnd [0..2] | |
| ├─ Affiliations [n] | Read from GitHub profile (Field: Organization) [1] | x | authors:affiliation [1] | creators:affiliation/affiliations [n] | |
| └─ Role [n] | x | x | x | x | |
| Creators (Organization) [n] | x | x | x | x | |
| Description [1] | Description from the GitHub About fields | Release description | x | abstract | description |
| Additional Description (Notes) [n] | x | x | message [1] | additional_descriptions [n] | |
| Licenses [n] | CC-BY-4.0 | [1] | license [1] | license [1] | |
| Keywords [n] | x | x | keywords [n] | keywords [n] | |
| Version [1] | Uses the tag of the release with the string “Version ” prefixed | x | x | version | |
| Related Works [n] | creates reference to the release [1] | x | x | related_identifiers [n] | |
| ├─ Relation [1] | Is supplement to | x | x | related_identifiers:relation | |
| ├─ Identifier [1] | x | URL of the release | x | x | related_identifiers:identifier |
| ├─Scheme [1] | URL | x | x | related_identifiers:scheme | |
| └─ Resource type [1] | Software | x | x | related_identifiers:resource_type | |
| Software: Repository URL [1] | URL of the GitHub repository | x | x | x | repository_url |
[!WARNING] If a GitHub repository has both a Zenodo metadata file and a citation metadata file, the Zenodo agent will ignore the citation metadata file completely.
[!NOTE] The
.zenodo.jsonfile supports more Zenodo metadata fields than are listed in this table. All fields that are only supported by the.zenodo.jsonfile and not by any other resource are omitted for clarity.