Generatore di changelog

Ancora niente. Incolla qualche riga sopra e premi Genera.

Cosa fa con ogni riga

Le regole sono deliberatamente semplici e visibili, così puoi prevedere il risultato invece di indovinarlo:

1. I conventional commit sono raggruppati per tipo. `feat` diventa Novità, `fix` diventa Correzioni, `perf` diventa Migliorie. Un `!` prima dei due punti, o un marcatore BREAKING CHANGE, sposta la riga in Cambiamenti importanti a prescindere dal tipo.
2. Ciò che non è un conventional commit viene ordinato in base alla prima parola. Sono riconosciuti i VERBI IN INGLESE tipici dei commit: Add, Added, Introduce e Support diventano Novità; Fix, Fixed e Resolve diventano Correzioni; Improve, Update, Speed e Optimise diventano Migliorie; Remove, Removed, Drop e Deprecate diventano Rimosso. Tutto il resto finisce in Altro perché tu lo sistemi a mano.
3. Il rumore viene eliminato: un numero di pull request finale, una riga `Merge pull request ...`, uno scope tra parentesi e il prefisso del tipo stesso. La frase restante viene messa in maiuscolo iniziale.
4. Con il filtro attivo vengono scartate le righe con `chore`, `ci`, `test`, `build`, `style` e `refactor`, oltre a tutto ciò che sembra un aggiornamento di dipendenza. È la differenza più grande tra un changelog che si legge e uno che si smette di leggere.

Cosa non può fare

Cambia la forma dei tuoi messaggi di commit, non il loro contenuto. Se un commit dice `fix: race in MembershipCache.resolve()`, è quello che esce, ed è ancora una frase sul tuo codice invece che sull'esperienza dell'utente. Trasformare «race in MembershipCache» in «i membri invitati non vedono più una dashboard vuota» richiede di sapere cosa ha fatto il cambiamento, ed è proprio ciò che un generatore non può dedurre da una riga di oggetto di commit.

Tratta quindi il risultato come una prima bozza: struttura corretta, raggruppamento corretto, rumore interno già eliminato, il testo resta compito tuo.

Domande frequenti

Viene caricato qualcosa di ciò che incollo?

No. Il generatore è uno script su questa pagina; il testo non esce mai dal tuo browser e premendo Genera non parte alcuna richiesta verso di noi. Puoi verificarlo con la scheda di rete aperta.

Devo usare i conventional commit?

No. Le righe che seguono la convenzione vengono raggruppate con più precisione, e tutto il resto ricade sul verbo iniziale. Un repository con messaggi di commit in forma di frase normale produce comunque una bozza utilizzabile.

Come lo ottengo automaticamente dal mio repository?

Per un uso occasionale, `git log --pretty=format:%s v1.2.0..HEAD` ti dà esattamente l'input atteso qui. Per qualcosa di continuativo, git-cliff e github-changelog-generator costruiscono un file di changelog nella CI a partire dalla cronologia dei commit, e Changeloop redige una voce rivolta all'utente per ogni pull request unita e la trattiene per la revisione.

Perché il mio risultato è pieno di Altro?

I verbi iniziali non corrispondevano a nulla di noto, il che di solito significa oggetti di commit che iniziano con un sostantivo o un id di ticket. Modificali nel campo prima di generare, oppure sposta a mano le righe in Altro dopo.

Per continuare a leggere: Dai conventional commits a un changelog, su cosa offre il formato dei commit e dove si ferma.