Simplifying the release process with lightweight automation

Aperta
#888 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 2 giorni

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
35/100
Tipo di issue
Funzionalità
Chiarezza
Da chiarire
Stato di attività
Attiva
Stack tecnologico
github-actions, java

Direzione di ricerca

Start by reading the Wayang release process and checking which pre-release and artifact validation steps already exist in the Maven build or CI. The issue proposes a release readiness script but leaves its first checks undecided; agree on a small initial scope before choosing an entry point. Done means the selected checks produce a clear pass/fail summary without duplicating existing CI checks.

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

Descrizione

I was going through wayang's release process and noticed that there are quite a few manual steps involved.

I was thinking whether we could automate some of these steps to reduce manual effort and avoid possible errors during releases.

A few things we could consider:

1. Pre-release checks
  • Check whether the Git working tree is clean.
  • Verify that version numbers are consistent across Maven modules.
  • Check whether the required release notes and documentation are present.
  • Verify that the required build and tests have passed.
2. Release candidate validation
  • Check whether the expected release artifacts are generated.
  • Verify checksums and GPG signatures.
  • Check whether the source archive contains the required LICENSE and NOTICE files.
3. Release preparation
  • Generate a simple release checklist.
  • Provide a summary of passed and failed checks, possibly through GitHub Actions later.

I donot think we should automate too much at once, as it might make the release process harder to debug and maintain.

maybe we could start with a small release readiness script that handles the basic checks and gradually extend it only where needed. we should also try to reuse existing CI checks rather than introduce duplicate workflows.

I came across rustup from the rust ecosystem and thought something along these lines might be useful for Wayang as well.

would like to know what others think about this and whether we already have some of these checks in place.

Lingua principale
Java
Stelle
284
Fork
147
Merge medio
2g 13h
PR unite (30g)
13

Preparare l'ambiente

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 apache/wayang

Tutte le issue di apache/wayang

Issue simili

Altre issue su Java

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.