ReScience C published articles

In order to publish a new article (after acceptance), you'll need to have the article metadata file (YAML format) and the corresponding article (PDF format). The metadata file should be missing the article DOI, number and URL. The first step is to request this information from Zenodo. Before proceeding further, you'll need a Zenodo token that can be requested from the sandbox server and from the actual server. The sandbox token is expected to be stored in the environment variable ZENODO_SANDBOX_TOKEN while the true token must be stored in ZENODO_TOKEN. We strongly advise you to first test the procedure on the sandbox server using the --sandbox switch.

Pre-Publication (article DOI, URL and number)

You can run the process.py script using the provided metadata file. In the example below, we use the actual server but you can first test the procedure on the sandbox server by using the --sandbox switch.

$ ./process.py --zenodo --metadata metadata.yaml --pdf article.pdf
Article #: y
Article ID: xxxxx
Article DOI: 10.5281/zenodo.xxxxx
Article URL: https://zenodo.org/record/xxxxxx/file/article.pdf

You need to give this information back to author(s) such that they can update the metadata file as well as the article that display the DOI in the left margin (make sure they actually update this information).

Publication (Zenodo and GitHub)

In order to publish the final article, you'll need to run the publish.py script:

$ ./publish.py --zenodo --metadata metadata.yaml --pdf article.pdf
Uploading content... done!
Uploading metadata... done!
Publishing... done!
Entry is online at https://zenodo.org/record/xxxxx

Saved working directory and index state WIP on master: 30cd860 Typo
Switched to a new branch '10.5072_zenodo.xxxxx'
[10.5072_zenodo.248588 2e613e7] Created local entry for 10.5072/zenodo.xxxxx
 3 files changed, 158 insertions(+)
 create mode 100644 10.5072_zenodo.xxxxx/article.bib
 create mode 100644 10.5072_zenodo.xxxxx/article.pdf
 create mode 100644 10.5072_zenodo.xxxxx/article.yaml
Switched to branch 'master'
Your branch is up to date with 'origin/master'.

Local entry has been created in 10.5072_zenodo.xxxxx
A new git branch (10.5072_zenodo.xxxxx) has been created.

This will create a new public record on Zenodo and this will also create a new local directory corresponding to the entry. This means you need to push this new branch on GitHub and make a pull request (the commit will have been created automatically).

Website update

To have the new article to appear on the website, you'll need to prepend the newly created bibtex entry (look into the local repository) to the published.bib file on the website (you can do it directly from the GitHub interface). If you previously added the entry to the under_review.bib file, don't forget to remove it.