carpentries-incubator / carpentries-incubator/python-intermediate-development
Release Procedure for GitHub + Zenodo publishing of the lesson
- Lingua principale
- TeX
- Stelle
- 63
- Fork
- 77
- Merge medio
- 20h 8m
- PR unite (30g)
- 3
Descrizione
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).
Guida per i contributori
Apri la guida per i contributori
Direzione di ricerca
Inizia leggendo la checklist della release in questa issue e controllando CITATION.md. Segui la procedura di GitHub Releases, verifica che Zenodo archivi la release con i metadati corretti e conferma che le informazioni sulla citazione corrispondano all'ultima versione. Il lavoro è completato quando la release è pubblicata, archiviata con un DOI e comunicata come necessario.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- github
- Ambito
- documentation, release
- Tipo di issue
- Documentazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100