解決すべき問題
$ git tag 0.1.0
こういうコマンドを実行すればGitレポジトリのなかでタグが作られる。Gitのタグとは何か？「サル先生のGit入門 タグ 」によればこうだ。
タグとは、コミットを参照しやすくするために、わかりやすい名前を付けるものです。
説明はこれで尽きる。でもタグを図に描いたらどうなるんだろう。複数のブランチを作ってそれぞれにたくさんタグを打ったら全体としてどう見えるだろう。
解決方法
Pythonでツール kazurayam/visualize_git_repository.py を開発した。これを使えばいま自分の手元にあるプロジェクトの .git ディレクトリのなかにあるオブジェクト群の実物を読み出し、Graphvizでグラフを生成してPNG画像ファイルを出力することができる。
説明
デモ用にディレクトリを作りGitレポジトリを作ろう。masterブランチとdevelopブランチでファイルを追加・変更などして、developをmasterにマージしよう。途中適宜にタグをつけていこう。Gitレポジトリの中がどのように形を変化させていくか、とくにタグがどんなふうに見えるか、図を示しつつ説明しよう。
ステップ1 最初のコミットをする
新しいGitレポジトリを作ろう。いくつかファイルを作ってコミットしよう。
作業用ディレクトリを作った
git initしたファイルを３つ(
README.md、.gitignore、src/greeting.pl)作った。git add .したgit commit -m "initial commit'した
この時点ではまだタグがありません。この時点でvisualize_git_repositoryツールを実行したら次のグラフが生成された。
| master | develop |
|---|---|
 |
まだ無い |
ステップ2 最初のコミットにタグ 0.1.0 を打つ
タグ 0.1.0 を打ちましょう。
-
% git tag 0.1.0コマンドを実行した。
この時点でvisualize_git_repositoryツールを実行したら次のグラフが生成された。
| master | develop |
|---|---|
 |
まだ無い |
このグラフから次のことが読みとれる。
-
git tag XXXXコマンドはgit tag XXXX HEADと同じ意味だ。つまり特殊な参照名 HEAD が指すところのcommitオブジェクトにたいしてXXXXというタグを付ける。HEADが指すcommitオブジェクトとはつまり最後に実行したgit commit -m "....."コマンドによって作られた最新のcommitオブジェクトだ。
ステップ3 developブランチでタグ 0.2.0 を打つ
新しくdevelopブランチを作ろう。developブランチでファイルdoc/TODO.txtを追加してコミットしよう。そしてタグ 0.2.0 を打とう。
git branch --show-currentコマンドでいまカレントブランチがmasterであることを確認してからgit branch developを実行したファイル
doc/TODO.txtを追加したgit add .を実行したgit commit -m "add doc"を実行したgit tag 0.2.0を実行した
この時点でvisualize_git_repositoryツールを実行したら次のグラフが生成された。
| master | develop |
|---|---|
| 前と同じ |  |
このグラフから次のことが読みとれる。
- いまカレント・ブランチがdevelopなのだが、masterブランチにおいて打ったタグ
0.1.0が見えている。えっ！そうなんですか？「タグ0.1.0はmasterブランチで打ったタグなのだから、developブランチではタグ0.1.0が見えなくなるだろう」とわたしは思っていたが、そうじゃないんだ。
タグが個々のcommitオブジェクトに付けられた名札のようなものという基本に戻ろう。タグを作る時にカレント・ブランチが何だったかはタグの性質に影響しない。この絵をみてわたしははじめて納得しました。
ステップ4 masterブランチでタグ 0.1.1 を打つ
masterブランチに戻って、masterブランチでもタグをひとつ打ってみよう。どう
見えるか？
git checkout masterを実行したファイル
src/greeting.plを修正したgit add .を実行したgit commit -m "modify src/greeting.pl"を実行したgit tag 0.1.1を実行した
この時点でvisualize_git_repositoryツールを実行したら次のグラフが生成された。
| master | develop |
|---|---|
 |
前と同じ |
このグラフから次のことが読みとれる。
- さきほどdevelopブランチでタグ
0.2.0を打ったが、masterブランチではそれが見えない。
developブランチをまだmasterにマージしていないのだから、masterからdevelopの変更点が見えないのは当然だ。
ステップ5 developブランチをmasterにマージする
developブランチをmasterにマージしよう。
-
git merge developを実行した
この時点でvisualize_git_repositoryツールを実行したら次のグラフが生成された。
| master | develop |
|---|---|
 |
前と同じ |
このグラフから次のことが読みとれる。
タグ
0.2.0が付いたcommitオブジェクトがマージされて、masterブランチにおいて見えるようになった。タグ
0.2.0が付いたコミットとタグ0.1.1が付いたコミットがグラフのなかで上下逆順に並んでいるのを見ておや？と迷うかもしれない。気にしないでほしい。タグの文字つまり0.2.0と0.1.1を数として読んだときにわれわれが感じる意味的順序どおりにcommitノードをGraphvizが配置するようにツールを作ってはいない。必要なことではないと思うから。
ステップ6 masterブランチでタグ 0.2.1 を打つ
さいごに、masterブランチでREADME.mdファイルを修正してコミットし、タグ 0.2.1 を打とう。
ファイル
README.mdを修正したgit add .を実行したgit commit -m "modified README.md"を実行したgit tag 0.2.1を実行した
この時点でvisualize_git_repositoryツールを実行したら次のグラフが生成された。
| master | develop |
|---|---|
 |
前と同じ |
はい。もう付け足すことはありません。
ツールについて
本稿で示したPNG画像は自作のツール visualize_git_repository で描画した。このツールはPython言語で開発した。ソースコードは下記のGitHubレポジトリにある。
このツールは下記2つのライブラリを利用している。
PNG画像を生成するにはコマンドラインで下記の操作をする。
$ cd $visualize_git_repository
$ pytest -s kazurayam/visualize_git_repository.py::test_3_tags
上記の例を作るのにどういうgitコマンドを実行したのかを知りたいならプログラムのソースコードを読み解いてください。下記を入り口として解読してください。
まとめ
「タグとは、コミットを参照しやすくするために、わかりやすい名前を付けるものです」という説明をクリアに図示することができたとおもいます。
- author: kazurayam
- date: June, 2021