Guides: Creating GitHub releases and Zenodo DOIs

GitHub & Zenodo

Create a GitHub release
Link your repository to Zenodo. More information is available in GitHub docs.

Adding the DOI to your guide

Update the DOI field in the CITATION.cff file: example here

Note: Updating your CITATION.cff file allows GitHub to generate a citation for your repository automatically, which can be accessed in the repository ‘About’ menu.

Add the DOI (or even a complete citation!) into your how-to cite instructions on the index.md page. See example below:

Gustafsson, J., Al Bkhetan, Z., Shadbolt, M., Murigneux, V., Williams, S., 
Capon, P., Khan, F. Z., & Nelson, T. (2023). How-to Guide for creating a 
How-to Guide (Version 1.0.0) [Computer software]. https://doi.org/10.5281/zenodo.8210269

Important: A blank CITATION.cff example is provided below. Don’t forget to fill out the other metadata in this file!

cff-version: 0.0.0
message: "Please cite as below."
authors:
  - family-names: [family name goes here]
    given-names: [given names go here]
    orcid: [ORCID goes here]
title: "Title of repository goes here"
version: 0.0.0
doi: [DOI goes here]
date-released: YYYY-MM-DD