どのバージョンでビルドされたかを記録するgit-commit-id-maven-pluginを使ってみる

Posted at 2023-01-14

はじめに

個人開発や、CI/CDが整っていない開発運用環境だと、このライブラリって、どのGitの断面でビルドされたものなのだろう、、とわからなくなって困ったことは無いでしょうか？

旧時代的には、ビルド直後にMD5などでハッシュ値を取って、その番号をどのリリースバージョンか台帳などに記録、それによりこのライブラリはこのバージョンだね、とかしていました。

MevenCentralリポジトリでも、大体のライブラリはmd5ファイルも保管してあります。

ビルド後にライブラリが意図せず改変されていないことを確認するためには妥当だとは思いますが、自分でビルドしたものだとこの確認方法と管理はちょっとやりすぎ（大変）な感じがします。

そこでGitのブランチやコミットIDがライブラリ内にファイルとして含むことができるMavenプラグインである、git-commit-id-maven-pluginをご紹介します。

git-commit-id-maven-plugin とは

以下のGithubリポジトリで公開されているOSSです。

git-commit-id-maven-plugin is a plugin quite similar to Build Number Maven Plugin for example but as the Build Number plugin at the time when I started this plugin only supported CVS and SVN, something had to be done. I had to quickly develop a Git version of such a plugin. For those who don't know the plugin, it basically helps you with the following tasks and answers related questions
・ Which version had the bug? Is that deployed already?
・ Make your distributed deployment aware of versions
・ Validate if properties are set as expected

DeepLで翻訳すると以下です。

git-commit-id-maven-plugin は、例えば Build Number Maven Plugin とよく似たプラグインですが、このプラグインを始めた当時は Build Number プラグインは CVS と SVN しかサポートしていなかったので、何か手を打たなければなりませんでした。このようなプラグインのGit版を早急に開発する必要がありました。このプラグインを知らない人のために説明すると、基本的には以下のような作業を支援し、関連する質問に答えてくれるものです。
・どのバージョンにバグがあったのか？それはすでにデプロイされているのか？
・分散デプロイメントでバージョンを認識させる
・プロパティが期待通りに設定されているかどうかを検証する

Build Number Maven Pluginというのもあるのですね。知りませんでした。。。

git-commit-id-maven-pluginはMavenCentralリポジトリでも公開されています。

早速やってみる

Mavenを使ってビルドをしている場合には、pom.xmlに利用することを追記するだけで利用することができます。

pom.xml

〜前略〜
      <build>
          <finalName>${project.artifactId}-${project.version}</finalName>
          <plugins>
〜中略〜
              <plugin>
                  <groupId>io.github.git-commit-id</groupId>
                  <artifactId>git-commit-id-maven-plugin</artifactId>
                  <version>5.0.0</version>
                  <executions>
                      <execution>
                          <goals>
                              <goal>revision</goal>
                          </goals>
                      </execution>
                  </executions>
                  <configuration>
                      <verbose>true</verbose>
                      <generateGitPropertiesFile>true</generateGitPropertiesFile>
                  </configuration>
              </plugin>
        </plugins>
      </build>
〜後略〜

generateGitPropertiesFileという設定箇所については、Git情報をファイルとして作成してライブラリ内に含むという設定となります。

この設定をした後、ビルド（mvn package)を実行すると、classesの中にgit.propertiesが生成されるようになります。