Skip to content

Release Process

Douglas Lowe edited this page Oct 28, 2025 · 1 revision

Steps for creating a release copy of the lesson on Zenodo. The DOI for all versions is https://doi.org/10.5281/zenodo.6532056.

Prepare the repository

  • Ensure the materials are complete and ready for release.

Create a GitHub release

  • Commit all final changes and push to the main branch.
  • Go to the repository’s Releases tab on GitHub.
  • Click Draft a new release.
  • Tag the release - normally we use the following notation for release labels "beta-MMMYYYY" (e.g. beta-Nov2024)
  • Write very short description/release notes summarising key changes.
  • Publish the release.

Zenodo archiving

  • GitHub–Zenodo integration is already set up, so Zenodo will automatically archive the release and assign a DOI.
  • Check Zenodo to ensure the release appears as expected and that the metadata (title, authors, description, license) is correct.

Citation information

  • Check and update the citation info to the latest version in CITATION.md file
  • No need to update README.md to include the Zenodo DOI for the release as we are already pointing to the DOI that includes all versions

Communicate the release

  • Share the DOI and GitHub release link as needed (e.g. in publications, presentations, or project websites).
Clone this wiki locally