GitHub タグを構成してリポジトリを整理する
GitHub リポジトリのタグは、指定されたコミットやリリース バージョンなど、プロジェクトの履歴内の特定のポイントを示すマーカーです。 コミットまたはリリースにタグを割り当てることで、開発者はプロジェクトの開発の構造化されたタイムラインを作成できるため、重要なソフトウェア ライフサイクル マイルストーンを追跡して参照しやすくなります。
計画
GitHub リポジトリのタグを最大限に活用してコードベースを整理し、移動や解釈を容易にするには、実装を計画する際に次の考慮事項を考慮してください。
リリース バージョン
特定のコミットまたはリリースをバージョンとしてタグ付けします。 ソフトウェア リリースのラベル付けの事実上の標準として広く受け入れられているセマンティック バージョン表記に従います。 バージョン名の前に v という文字を付けるのが一般的です (v1.0.0 や v2.3.4 など)。 運用環境でのタグの使用が意図されていない場合は、バージョン名の後にプレリリース バージョン (v0.2.0-alpha や v5.9-beta.3 など) を追加します。 これにより、ユーザーとコラボレーターは、安定したリリースと、まだテスト段階にある機能を簡単に区別できます。
機能リリース
コードベースに新機能や大幅な変更を導入するコミットまたはマージにタグを付けます。 特定の機能リリースを強調表示するには、"feature/new-login-page" や "feature/payment-integration" などのわかりやすいタグを使用します。 これらのタグは、機能の追加の明確な履歴を示し、経時的に個々の機能の進行状況を追跡するのに役立ちます。
バグ修正
ユーザーまたはコラボレーターによって報告されたバグ修正プログラムまたは問題に対処するコミットまたはマージにタグを付けます。 "bugfix/issue123" や "fix/critical-bug" などのタグを使用して、バグ修正プログラムのリリースを示します。 バグの修正タグを使用すると、特定の問題を解決するコミットを簡単に特定し、異なるバージョンのプロジェクトにわたって修正プログラムが一貫して適用されるようにすることができます。
メンテナンス リリース
コードのリファクタリング、ドキュメントの更新、依存関係のアップグレードなどのメンテナンス タスクを含むコミットまたはマージにタグを付けます。 メンテナンス リリースをマークするには、"maintenance/code-refactor" や "update/documentation" などのタグを使用します。 メンテナンス リリース タグは、コード メンテナンスに関連する変更を追跡し、必要な更新プログラムが文書化され、正しく適用されるようにするのに役立ちます。
カスタム タグ
カスタム タグを作成して、組織の特定のニーズまたはワークフローに基づいてコミットまたはリリースを分類します。 たとえば、"documentation"、"performance"、"security" などのタグを作成して、コミットをフォーカス領域に応じて分類できます。 カスタム タグを使用すると、プロジェクトの要件に従ってコードベースを整理および構成する柔軟性が向上します。
実装
GitHub の Git リポジトリにタグを割り当てるには、次の手順に従います。
- リポジトリ内でタグ付けする特定のコミットまたはリリースを特定します。 コミット ハッシュまたはリリース バージョンは、リポジトリのコミット履歴またはリリース セクションにあります。 コミットにタグを付ける場合は、タグ付けするコミットに関連付けられているコミット ハッシュをコピーします。 リリースにタグを付ける場合は、リリース バージョン ("v1.0.0" など) をコピーします。
- リポジトリのローカル クローンで、git tag コマンド ラインを使用してタグを作成します。 タグを作成するための基本的な構文は、git タグ <tag_name ><commit_hash> です。 <tag_name> をタグの名前に置き換え、<commit_hash> を前にコピーしたコミット ハッシュまたはリリース バージョンに置き換えます。
- git push origin <tag_name> コマンドを実行して、タグを GitHub にプッシュします。 <tag_name> を、作成したタグの名前に置き換えます。
- タグをプッシュした後、GitHub のリポジトリの Releases\Tags ページに移動して、タグが正常に作成されたことを確認できます。
共同作成者がタグを作成または削除できないように、リポジトリのタグ保護ルールを構成できます。 ただし、2024 年 3 月の時点では、タグ保護ルールはベータ版であり、変更される可能性があることに注意してください。