carpentries-incubator / carpentries-incubator/python-intermediate-development

Release Procedure for GitHub + Zenodo publishing of the lesson

Open
#472 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
TeX
Stars
63
Forks
77
Avg merge
20h 8m
Merged PRs (30d)
3

Description

Release check list/procedure for GitHub + Zenodo publishing of the lesson - keep this issue open.

## 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](https://github.com/carpentries-incubator/python-intermediate-development/releases).
- 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).

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.