Skip to content

Commit

Permalink
Describe previous test results in README and test re-adding 'upload_t…
Browse files Browse the repository at this point in the history
…ype' (because otherwise the default is 'software')
  • Loading branch information
shodgkins committed Sep 8, 2022
1 parent f50c0b9 commit d93ec0d
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 10 deletions.
6 changes: 3 additions & 3 deletions .zenodo.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"title": "This is the 'title' - Test Zenodo upload",
"publication_date": "2022-08-26",
"title": "This is the 'title': Test Zenodo upload",
"upload_type": "dataset",
"description": "This is the 'description'",
"creators": [
{
Expand All @@ -16,6 +16,6 @@
"access_right": "open",
"keywords": ["test", "EMERGE"],
"notes": "This is the 'notes'",
"version": "0.0.5",
"version": "0.0.6",
"communities": [{"identifier": "emerge-bii"}]
}
30 changes: 23 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,33 @@
# test-zenodo
testing zenodo releases
Testing Zenodo releases.

This GitHub repository is linked to the test Zenodo record at: https://doi.org/10.5281/zenodo.6081432
This GitHub repository is linked to the test Zenodo record at: https://doi.org/10.5281/zenodo.6081432, which is updated based on the contents of Releases to this GitHub repository. The person updating the GitHub and creating Releases need not be the person who originally created the GitHub repository or linked it to Zenodo, as long as they have permission to push to the GitHUb repository. This ability to collaboratively update the Zenodo record is a key feature of these GitHub-based updates, and to our knowledge, is not possible using other methods of uploading data to Zenodo.

Metadata is stored in .zenodo.json file.
Metadata is stored in the .zenodo.json file, which is formatted based on documentation at https://developers.zenodo.org/, and was refined after testing various properties (see below).

The following properties were attempted to be added, but resulted in a failure to update the record on Zenodo (note: not sure if this is actually a valid DOI for the EMERGE grant, which may account for the failure):
## Results of testing various properties in .zenodo.json

To update metadata for the Zenodo record, update the corresponding properties in the .zenodo.json file, and then create a Release on GitHub. Based on previous tests, nothing will be updated on Zenodo until a GitHub Release is created, but the update happens almost instantaneously once that's been done (assuming the json contains valid metadata).

Note that if .zenodo.json contains *anything* not recognized by Zenodo as valid, then the Release will fail to be posted to Zenodo, and will only succeed once the errors have been corrected and put into a new Release. See Release "version 0.0.5" for the most comprehensive list of .zenodo.json properties that have been tested here and found to be valid.

### Notes on specific properties

The following property triggers an automated request to the community owner to accept or reject the Zenodo record:
```
"grants": [{"id": "10.13039/100000001::2022070"}]
"communities": [{"identifier": "emerge-bii"}]
```

Additional properties used in an earlier version that failed, which haven't been re-tested because they're not strictly necessary for EMERGE dataset tracking:
The following property is specific to the release under which it's specified (and therefore needs to be updated for each release, OR it can be omitted in order to default to the current date; also note that Zenodo does NOT check to ensure that this date is after the date of previous releases):
```
"upload_type": "dataset"
"publication_date": "2022-08-26"
```


### Known failed properties (do NOT add these to .zenodo.json; please update the list below if more are found)

The following properties were attempted to be added, but resulted in a failure to update the record on Zenodo:
```
"grants": [{"id": "10.13039/100000001::2022070"}]
```
(note: not sure if the EMERGE grant DOI above is valid, which may account for the failure-- it was generated based on the format at https://developers.zenodo.org/#representation, with the EMERGE grant number appended after the NSF funder DOI prefix; not sure how the "::" is intended to work)

0 comments on commit d93ec0d

Please sign in to comment.