Archiving and Publication

Let’s think about the future…

  • Will this repository still be here in five years?

  • Will my account?

  • Will GitHub?

Publishing and archiving

  • Frozen version of the current state of your code repository.

  • You will get an actual DOI, and your project will (probably?) not be deleted!

  • You can only publish public repositories with Zenodo.

  • Only do this following exercise if you are OK with your code staying online!

Zenodo and Github have a pipeline that makes your life easier! (Check the full how-to on GitHub.)

Demo or follow along:

  • Make sure you have a test repository on GitHub!

  • Go to: sandbox.zenodo.org, and log in with GitHub. (If you do not have GitHub, simply sign up for a zenodo account; some of the coming steps you will need to do manually…)

  • GitHub will then ask permission to give Zenodo access; click “Authorize application”.

Select your repository

  • On Zenodo, click on your user name and select “GitHub”.

Click on your enabled repository. This will take you to a page with a green GitHub button. With this button you can create a release for your publication.

Release your project!

… and follow the workflow!

(Unsure about version number? Wait a slide! :-)

Semantic versioning

A version has three numbers: MAJOR.MINOR.PATCH

  • MAJOR version denotes changes that alter the compatibility (i.e. someone using your functions may need to change their use for their code to still work),
  • MINOR version adds functionality, but remains compatible
  • PATCH version makes (compatible) bug fixes.

(If your bug fix changes compatibility, it is therefore a MAJOR version change!)

You can release today with v0.1.0

Check Zenodo

Your code is now uploading to Zenodo: you can check it under the ‘upload’ tab:

Getting your DOI

  • Add some final descriptions
  • Click ‘publish’
  • Voilá!

Getting your DOI

Do you know your DOI?

As a final touch (only with real Zenodo!): you can take your DOI and place it as a badge at the top of your README. 

[![DOI](https://zenodo.org/badge/doi/YOUR.DOI.svg)](http://dx.doi.org/YOUR.DOI)



This is not recommended with a Sandbox DOI, because sandbox projects are not permanent. The Sandbox DOI will not work like a normal one does!

Are you ready?

Let’s exchange projects!

Find one of your neighbours and exchange the URLs to your GitHub repository.

As you reproduce, please give your colleague feedback!

Open an issue in your colleague’s GitHub repository and copy/paste this feedback template