Skip to content

Instantly share code, notes, and snippets.

@seignovert

seignovert/zenodo-doi-first-badge.md

Created February 21, 2019 20:02
Show Gist options
  • Star 17 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save seignovert/ae6771f400ca464d294261f42900823a to your computer and use it in GitHub Desktop.
Save seignovert/ae6771f400ca464d294261f42900823a to your computer and use it in GitHub Desktop.
Download ZIP
Setup Zenodo DOI badge before the first release
Raw
zenodo-doi-first-badge.md

Setup Zenodo DOI badge before the first release

Zenodo doi badge

Before submitting your first release, identify your Github repo id on Github API at:

https://api.github.com/repos/{user}/{repo}

Then add the following badge to your README.md:

[![DOI](https://zenodo.org/badge/{github_id}.svg)](https://zenodo.org/badge/latestdoi/{github_id})

or to your README.rst:

|DOI|

.. |DOI| image:: https://zenodo.org/badge/{github_id}.svg
        :target: https://zenodo.org/badge/latestdoi/{github_id}

Then, submit your first release

Notes:

  • The DOI badge will not be issued until you make you first release but will be included in your release.
  • See Github documentation to setup Zenodo webhooks.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment