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

Release Procedure for GitHub + Zenodo publishing of the lesson

Offen
#472 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
TeX
Sterne
63
Forks
77
Ø Merge
20 Std. 8 Min.
Gemergte PRs (30 T.)
3

Beschreibung

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).

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginne damit, die Release-Checkliste in diesem Issue zu lesen und CITATION.md zu prüfen. Befolge das Verfahren für GitHub Releases, verifiziere, dass Zenodo das Release mit den korrekten Metadaten archiviert, und bestätige, dass die Zitierinformationen mit der neuesten Version übereinstimmen. Als erledigt gilt die Aufgabe, wenn das Release veröffentlicht, mit einem DOI archiviert und wie erforderlich kommuniziert wurde.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
github
Bereich
documentation, release
Issue-Typ
Dokumentation
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.