コミットから変更ログを下書きする
Changelog draft は、2 つのポイント間の最初の親コミットを読み取り、それらをグループ化し、次のバージョンを提案し、Markdown をコピーできるようにします。注記には、これは単なる草案であると記載されています。何もタグ付けもリリースもプッシュもされません。メッセージを共有する前に確認します。
GitTree で無料で動作: すべてのローカル Git 機能。アカウントは必要ありません。
始める前に
- 変更ログのドラフトは無料プランの一部です。両方のエンドポイントがすでにコミットされている必要があります。ダイアログには、そうなるまで Choose both committed endpoints と表示されます。
- グループ化したいメッセージは、Conventional Commits (
feat:、fix:、feat!:) の後に続く必要があります。単純なメッセージはレビュー対象としてカウントされます。これらは発明されたカテゴリーではありません。
どこで見つけられますか
- コミットのメニューまたはタグのメニュー: Changelog draft。
Alt+L、またはコマンド パレット。
| アクション | macOS | WindowsとLinux |
|---|---|---|
| Changelog draft | ⌥L | Alt+L |
| コマンドパレット | ⌘⇧P | Ctrl+Shift+P |
ステップ
変更ログのドラフトを開く
範囲を終了するコミット、またはメモを作成するタグを選択し、Changelog draft を選択します。
Alt+Lを押すこともできます。タイトルはChangelog draftです。メモにはDraft only. Review commit messages before sharing. Nothing is published.と書かれています
変更ログのドラフトはこのメニューとタグのメニューにあります。まだコミットメニューが表示されています。GitTree はデモ リポジトリとのインターフェイスです。 範囲を設定する
From (excluded) は、すでに解放したコミットまたはタグです。 To (included) は新しいヒントです。スコープ行には、ドラフトでは最初の親の履歴が使用されていることが記載されています。マージによってのみ到着したコミットは、1 つずつリストされるのではなく、マージ コミットによって表されます。
ドラフトを生成する
Generate draftを押します。 Stop は履歴の読み取りを終了するよう要求します。ドラフトは Editable Markdown draft の下に表示されます。バージョンが提案できる場合は Suggested version、バージョン タグが除外されたエンドポイントを指している場合は Baseline tag が表示されます。 Copy Markdown がそれをコピーします。 Markdown copied はコピーを確認します。
編集してから、どこに配置するかを決定します
ボックス内のMarkdownを編集します。 Replace draft with proposal は、編集後に生成されたテキストを元に戻します。エンドポイントを変更すると、GitTree はエンドポイントが変更され、編集した下書きが保存されたことを示します。 Insert draft into release notes は、リリースのメモを作成するときに提供されます。編集後に閉じると、単語が必要かどうかを Discard edited draft? まずコピーするよう求められます。
期待される結果
Markdown はクリップボードまたはリリースノートフィールドにあります。タグは作成されず、リリースも公開されませんでした。グループをリリースに貼り付ける前に、グループを読んでください。プレーンなメッセージ、取り消し、マージが呼び出されるので、書き換えることができます。
コミットのグループ化方法
| グループ | そこに置かれているものは |
|---|---|
| 重大な変更 | ! または BREAKING CHANGE フッターを含む、中断としてマークされたコミット |
| 機能 | 偉業のコミット |
| 修正 | コミットを修正する |
| パフォーマンス | パフォーマンスコミット |
| その他 | 上記のいずれでもない認識されたタイプ、およびまだ確認が必要なメッセージ |
カウント行は Needs review で、プレーン メッセージ、リバート、マージ、およびデコードできないメッセージが含まれます。これらの数字が、バージョンが保留される理由です。 No commits in this range; no release is proposed は、エンドポイントがすべてのコミットを除外することを意味します。
推奨バージョンの選択方法
提案は、除外されたエンドポイントのバージョン タグから始まります。ダイアログにはその理由が説明されています。重大な変更はメジャー バージョン、またはメジャー バージョンが 0 の場合にマイナー バージョンを示唆しています。特徴は未成年を示唆しています。その他の認識された Conventional Commits はパッチを提案します。この提案は無視して構いません。 Choose the next version after review は、GitTree がいずれかを選択しない場合に表示されます。
git log --first-parent --pretty=format:%s v1.2.0..HEAD
git tag --points-at v1.2.0^{}ターミナル内の同じ範囲は、除外されたコミットから含まれるチップまでの git log --first-parent です。 GitTree は git tag を実行しません。タグの作成はtagsです。ホスト上でのノートの公開は、別のリリース アクションです。タグに関する チュートリアル レッスンでは、タグがコミットに名前を付ける方法を示します。
何も公開されていない
Copy Markdown はテキストのみをコピーします。 Insert draft into release notes はフィールドに入力されます。どちらもタグ、GitHub リリース、プッシュを作成しません。コピーが失敗した場合、ダイアログには「Could not copy. Select and copy the draft text.」と表示されます。編集した下書きは、置き換えるか破棄するまでボックス内に残ります。
何か問題が発生した場合
「コミットされた両方のエンドポイントを選択してください。」
From または To はまだコミットされていません。 2 つのコミット、またはコミットを指すタグを選択します。解決されないブランチ名は生成されません。
「除外されたエンドポイントを指すバージョン タグがありません。」
増やすものは何もありません。次のバージョンを自分で選択するか、最初に除外されたコミットにタグを付けて、再度生成します。
「さまざまなバージョン タグが除外されたエンドポイントを指しています。ベースライン バージョンを選択してください。」
そのコミットには複数のバージョン タグが存在します。意味するベースラインを選択してください。 GitTree は、どのタグが製品バージョンであるかを推測しません。
「ベースラインはプレリリースです。リリース チャネルとバージョンを選択してください。」
プレリリース タグは、次の安定した番号を意味するものではありません。チャンネルとバージョンを選択し、下書きを保存します。
「コピーできませんでした。下書きテキストを選択してコピーしてください。」
クリップボードが拒否されました。ボックス内のMarkdownを選択し、システム ショートカットを使用してコピーします。ドラフトはまだ残っています。
質問
変更ログのドラフトはリリースを作成しますか?
いいえ、メモには何も公開されていないと書かれています。 Markdown をコピーするか、リリース ノートに挿入します。自分でタグ付けして公開します。
どのコミットが含まれますか?
除外されたエンドポイントからチップまでの最初の親の履歴。マージされたブランチのコミットは、マージ コミットによって表されます。
推奨バージョンがないのはなぜですか?
ベースライン タグが欠落している場合、あいまいな場合、またはプレリリースである場合、プレーン メッセージ、元に戻す、マージ、またはデコードできないメッセージを確認する必要がある場合、またはバージョン コンポーネントをインクリメントできない場合、ダイアログは 1 つを保留します。
私の編集は新しい範囲でも存続しますか?
交換するまではい。ダイアログには、編集した下書きが保存されると表示されます。ドラフトを提案に置き換えると、ドラフトが新しいテキストで上書きされます。
Conventional Commitsを使用する必要がありますか?
いいえ。単純なメッセージは「レビューが必要」の下にリストされます。被験者が特技、修正、および重大な変更マーカーを使用する場合、グループと推奨バージョンはより具体的になります。