Redigere un registro delle modifiche dai commit
Changelog draft legge i commit del primo genitore tra due punti, li raggruppa, suggerisce una versione successiva e ti consente di copiare Markdown. La nota dice che è solo una bozza. Niente viene taggato, rilasciato o inviato. Rivedi i messaggi prima di condividerli.
Funziona in GitTree Gratuito: tutte le funzionalità Git locali, senza bisogno di un account.
In questa pagina
Prima di iniziare
- La bozza del registro delle modifiche fa parte del piano gratuito. Entrambi gli endpoint devono già essere confermati. La finestra di dialogo dice Choose both committed endpoints finché non lo sono.
- I messaggi che desideri raggruppare dovrebbero seguire Conventional Commits (
feat:,fix:,feat!:). I messaggi semplici vengono conteggiati per la revisione. Non sono categorie inventate.
Dove trovarlo
- Il menu di un commit o il menu di un tag: Changelog draft.
Alt+Lo la tavolozza dei comandi.
| Azione | macOS | Windows e Linux |
|---|---|---|
| Changelog draft | ⌥L | Alt+L |
| La tavolozza dei comandi | ⌘⇧P | Ctrl+Shift+P |
Passi
Apri la bozza del registro delle modifiche
Seleziona il commit che dovrebbe terminare l'intervallo o il tag per cui stai scrivendo le note e scegli Changelog draft. Puoi anche premere
Alt+L. Il titolo è Changelog draft. La nota dice Draft only. Review commit messages before sharing. Nothing is published.
La bozza del registro delle modifiche si trova in questo menu e nel menu di un tag. L'ancora mostra il menu di commit.GitTree interfaccia con un repository dimostrativo. Imposta l'intervallo
From (excluded) è il commit o il tag che hai già rilasciato. To (included) è il nuovo suggerimento. La riga dell'ambito dice che la bozza utilizza la storia del primo genitore. I commit arrivati solo tramite un'unione sono rappresentati dal commit dell'unione, non elencati uno per uno.
Genera la bozza
Premi Generate draft. Stop chiede il completamento della lettura della cronologia. La bozza viene visualizzata sotto Editable Markdown draft, con Suggested version quando è possibile proporre una versione e Baseline tag quando un tag di versione punta all'endpoint escluso. Copy Markdown lo copia. Markdown copied conferma la copia.
Modifica, quindi decidi dove va
Modifica il Markdown nella casella. Replace draft with proposal ripristina il testo generato dopo la modifica. Se modifichi gli endpoint, GitTree indica che gli endpoint sono cambiati e la bozza modificata viene conservata. Insert draft into release notes viene offerto quando scrivi note per una versione. La chiusura dopo le modifiche richiede prima Discard edited draft? Copia se ti servono le parole.
Risultato atteso
Hai Markdown negli appunti o nel campo delle note di rilascio. Nessun tag è stato creato e nessuna versione è stata pubblicata. Leggere i gruppi prima di incollarli in una versione. Messaggi semplici, ripristini e unioni vengono richiamati in modo da poterli riscrivere.
Come vengono raggruppati i commit
| Gruppo | Cosa c'è messo lì |
|---|---|
| Cambiamenti decisivi | Commit contrassegnati come non funzionanti, incluso un piè di pagina ! o BREAKING CHANGE |
| Caratteristiche | commit feat |
| Correzioni | correggere i commit |
| Prestazioni | commit perf |
| Altro | Tipi riconosciuti che non rientrano tra quelli precedenti e messaggi che necessitano ancora di essere esaminati |
La riga dei conteggi è Needs review, con messaggi semplici, ripristini, unioni e messaggi non decodificabili. Questi numeri sono il motivo per cui una versione potrebbe essere trattenuta. No commits in this range; no release is proposed significa che gli endpoint escludono ogni commit.
Come viene scelta la versione suggerita
Il suggerimento inizia da un tag di versione sull'endpoint escluso. La finestra di dialogo spiega il motivo: le modifiche sostanziali suggeriscono una versione maggiore, o minore mentre la maggiore è zero. Le caratteristiche suggeriscono un minore. Altri Conventional Commits riconosciuti suggeriscono una patch. Puoi ignorare il suggerimento. Choose the next version after review appare quando GitTree non ne sceglierà uno.
git log --first-parent --pretty=format:%s v1.2.0..HEAD
git tag --points-at v1.2.0^{}Lo stesso intervallo in un terminale è git log --first-parent dal commit escluso al suggerimento incluso. GitTree non esegue git tag per te. La creazione del tag è tags. La pubblicazione di note su un host è un'azione di rilascio separata. La lezione tutorial sui tag mostra come un tag nomina un commit.
Non viene pubblicato nulla
Copy Markdown copia solo il testo. Insert draft into release notes riempie un campo. Nessuno dei due crea un tag, un rilascio GitHub o un push. Se la copia fallisce, la finestra di dialogo dice Could not copy. Select and copy the draft text. La bozza modificata rimane nella casella finché non la sostituisci o la elimini.
Se qualcosa va storto
"Scegli entrambi gli endpoint confermati."
From o To non è ancora un commit. Scegli due commit o un tag che punti a un commit. Un nome di ramo che non viene risolto non verrà generato.
"Nessun tag di versione punta all'endpoint escluso."
Non c'è nulla da incrementare. Scegli tu stesso la versione successiva oppure tagga prima il commit escluso e generalo di nuovo.
"I tag di versione diversi puntano all'endpoint escluso. Scegli la versione di base. "
Su quel commit si trova più di un tag di versione. Scegli la linea di base che intendi. GitTree non indovinerà quale tag è la versione del prodotto.
"La linea di base è una prerelease. Scegli il canale di rilascio e la versione. "
Un tag prerelease non implica il numero stabile successivo. Scegli il canale e la versione, poi conserva la bozza.
"Impossibile copiare. Seleziona e copia la bozza di testo."
Gli appunti sono stati rifiutati. Seleziona Markdown nella casella e copialo con il collegamento di sistema. La bozza è ancora lì.
Domande
La bozza del Changelog crea una versione?
No. La nota dice che non viene pubblicato nulla. Copi Markdown o lo inserisci nelle note di rilascio. Ti tagghi e ti pubblichi.
Quali commit sono inclusi?
Cronologia del primo genitore dall'endpoint escluso fino alla mancia inclusa. I commit di un ramo unito sono rappresentati dal commit di unione.
Perché non esiste una versione suggerita?
La finestra di dialogo ne trattiene uno quando il tag della linea di base manca, è ambiguo o è una versione preliminare, quando messaggi semplici, ripristini, unioni o messaggi non decodificabili necessitano di revisione o quando un componente di versione non può essere incrementato.
Le mie modifiche sopravviveranno a un nuovo intervallo?
Sì finché non li sostituisci. La finestra di dialogo dice che la bozza modificata è conservata. Sostituisci bozza con proposta la sovrascrive con il nuovo testo.
Devo utilizzare Conventional Commits?
No. I messaggi semplici sono elencati in Richiede revisione. I gruppi e la versione suggerita sono più specifici quando i soggetti utilizzano il talento, la correzione e il segnalino di cambiamento rivoluzionario.