Add release instructions

Aperta
#412 9 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
30/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
github-actions, python
Ambito
ci-cd, documentation, release

Direzione di ricerca

Start with whats-new.rst and CITATION.cff, then inspect recent commits and the test-build tag requirements. Run the test suite before creating the pull request, and monitor the GitHub Action after tagging the release. Done means the release notes and citation metadata are updated, the GitHub release is created, PyPI deployment succeeds, and the conda-forge PR is merged.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

documentation
  1. Update whats-new and CITATION.cff
    1. Create a new section with date in whats-new.rst
    2. Add entries in the section looking at recent commits.
    3. Create a PR to update whats-new.
    4. Add version info and release date at bottom of CITATION.cff
    5. Add the test-build tag.
    6. Make sure tests pass.
    7. Merge the PR.
  2. Tag a release using the Github UI
    1. Click "Draft a new release"
    2. Add a new tag vX.Y.Z
    3. Use vX.Y.Z as name
    4. Generate release notes, and edit to make it understandable to Github users.
    5. Create the release!
  3. After the tag is created, a Github Action to deploy to pypi will be triggered. Monitor to make sure this succeeds (click "Actions")
  4. Wait for the conda-forge PR to show up and merge that after checking that requirements have been updated.
Lingua principale
Python
Stelle
181
Fork
49
Merge medio
43m
PR unite (30g)
1

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di xarray-contrib/cf-xarray

Tutte le issue di xarray-contrib/cf-xarray

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.