Rédiger un journal des modifications à partir des commits
Changelog draft lit les commits du premier parent entre deux points, les regroupe, suggère une version suivante et vous permet de copier Markdown. La note indique qu'il ne s'agit que d'un brouillon. Rien n'est tagué, publié ou poussé. Vous examinez les messages avant de les partager.
Fonctionne dans GitTree Gratuit : toutes les fonctionnalités Git locales, sans compte requis.
Sur cette page
Avant de commencer
- Le brouillon du journal des modifications fait partie du plan gratuit. Les deux points de terminaison doivent déjà être validés. La boîte de dialogue indique Choose both committed endpoints jusqu'à ce qu'ils le soient.
- Les messages que vous souhaitez regrouper doivent suivre Conventional Commits (
feat:,fix:,feat!:). Les messages bruts sont pris en compte pour examen. Ce ne sont pas des catégories inventées.
Où le trouver
- Le menu d'un commit ou le menu d'une balise : Changelog draft.
Alt+L, ou la palette de commandes.
| Action | macOS | Windows et Linux |
|---|---|---|
| Changelog draft | ⌥L | Alt+L |
| La palette de commandes | ⌘⇧P | Ctrl+Shift+P |
Mesures
Ouvrir le brouillon du journal des modifications
Sélectionnez le commit qui doit terminer la plage ou la balise pour laquelle vous écrivez des notes, puis choisissez Changelog draft. Vous pouvez également appuyer sur
Alt+L. Le titre est Changelog draft. La note dit Draft only. Review commit messages before sharing. Nothing is published.
Le brouillon du journal des modifications se trouve dans ce menu et dans le menu d'une balise. L'affiche toujours le menu de validation.Interface GitTree avec un référentiel de démonstration. Définir la plage
From (excluded) est le commit ou le tag que vous avez déjà publié. To (included) est le nouveau conseil. La ligne de portée indique que le projet utilise l'historique du premier parent. Les validations arrivées uniquement via une fusion sont représentées par la validation de fusion, et non répertoriées une par une.
Générer le brouillon
Appuyez sur Generate draft. Stop demande à la lecture de l'historique de se terminer. Le brouillon apparaît sous Editable Markdown draft, avec Suggested version lorsqu'une version peut être proposée, et Baseline tag lorsqu'une balise de version pointe vers le point de terminaison exclu. Copy Markdown le copie. Markdown copied confirme la copie.
Modifiez, puis décidez où cela va
Modifiez le Markdown dans la case. Replace draft with proposal remet le texte généré après votre modification. Si vous modifiez les points de terminaison, GitTree indique que les points de terminaison ont changé et que votre brouillon modifié est conservé. Insert draft into release notes est proposé lorsque vous rédigez des notes pour une version. La fermeture après les modifications demande Discard edited draft? Copiez d'abord si vous avez besoin des mots.
Résultat attendu
Vous avez Markdown dans le presse-papiers ou dans le champ des notes de version. Aucune balise n'a été créée et aucune release n'a été publiée. Lisez les groupes avant de les coller dans une version. Les messages simples, les retours et les fusions sont appelés afin que vous puissiez les réécrire.
Comment les commits sont regroupés
| Groupe | Ce qui y est placé |
|---|---|
| Modifications radicales | Commits marqués comme rompus, incluant un pied de page ! ou BREAKING CHANGE |
| Caractéristiques | exploit commet |
| Correctifs | corriger les commits |
| Performances | commits de performances |
| Autre | Types reconnus qui ne correspondent à aucun des messages ci-dessus et messages qui nécessitent encore un examen |
La ligne de décompte est Needs review, avec des messages bruts, des retours, des fusions et des messages non décodables. Ces chiffres expliquent pourquoi une version peut être refusée. No commits in this range; no release is proposed signifie que les points de terminaison excluent chaque validation.
Comment la version suggérée est choisie
La suggestion commence à partir d'une balise de version sur le point de terminaison exclu. La boîte de dialogue en explique la raison : les modifications majeures suggèrent une version majeure, ou une version mineure alors que la version majeure est nulle. Les caractéristiques suggèrent un mineur. D'autres Conventional Commits reconnus suggèrent un correctif. Vous pouvez ignorer la suggestion. Choose the next version after review apparaît lorsque GitTree n'en choisit pas.
git log --first-parent --pretty=format:%s v1.2.0..HEAD
git tag --points-at v1.2.0^{}La même plage dans un terminal va de git log --first-parent de la validation exclue à la pointe incluse. GitTree n'exécute pas git tag pour vous. La création de la balise est tags. La publication de notes sur un hôte est une action de publication distincte. La leçon tutoriel sur les balises montre comment une balise nomme un commit.
Rien n'est publié
Copy Markdown copie uniquement le texte. Insert draft into release notes remplit un champ. Ni l'un ni l'autre ne crée de balise, de version GitHub ou de push. Si la copie échoue, la boîte de dialogue indique Could not copy. Select and copy the draft text. Votre brouillon modifié reste dans la boîte jusqu'à ce que vous le remplaciez ou le supprimiez.
Si quelque chose ne va pas
« Choisissez les deux points de terminaison validés. »
From ou To n’est pas encore un commit. Choisissez deux commits ou une balise qui pointe vers un commit. Un nom de branche qui n'est pas résolu ne sera pas généré.
"Aucune balise de version ne pointe sur le point de terminaison exclu."
Il n'y a rien à augmenter. Choisissez vous-même la version suivante ou marquez d'abord le commit exclu et générez à nouveau.
"Différentes balises de version pointent vers le point de terminaison exclu. Choisissez la version de base."
Plus d’une balise de version se trouve sur ce commit. Choisissez la ligne de base dont vous parlez. GitTree ne devinera pas quelle balise correspond à la version du produit.
"La référence est une avant-première. Choisissez le canal de sortie et la version."
Une balise de préversion n'implique pas le prochain numéro stable. Choisissez la chaîne et la version, puis conservez le brouillon.
"Impossible de copier. Sélectionnez et copiez le brouillon de texte."
Le presse-papiers a été refusé. Sélectionnez le Markdown dans la case et copiez-le avec le raccourci système. Le projet est toujours là.
Questions
Le brouillon du journal des modifications crée-t-il une version ?
Non. La note indique que rien n’est publié. Vous copiez Markdown ou l'insérez dans les notes de version. Vous vous identifiez et vous publiez.
Quels commits sont inclus ?
Historique du premier parent depuis le point de terminaison exclu jusqu’au pourboire inclus. Les commits d’une branche fusionnée sont représentés par le commit de fusion.
Pourquoi n’y a-t-il aucune version suggérée ?
La boîte de dialogue en retient une lorsque la balise de base est manquante, ambiguë ou qu'il s'agit d'une version préliminaire, lorsque des messages bruts, des retours, des fusions ou des messages non décodables doivent être révisés, ou lorsqu'un composant de version ne peut pas être incrémenté.
Mes modifications survivront-elles à une nouvelle plage ?
Oui jusqu'à ce que vous les remplaciez. La boîte de dialogue indique que votre brouillon modifié est conservé. Remplacer le brouillon par la proposition l'écrase par le nouveau texte.
Dois-je utiliser Conventional Commits ?
Non. Les messages simples sont répertoriés sous Révision nécessaire. Les groupes et la version suggérée sont plus spécifiques lorsque les sujets utilisent feat, fix et le marqueur de rupture.