Включить git commit hash в версию jar

Question

Я использую maven, и моя цель - включить хеш git commit в номер версии. Что-то вроде: 1.1.{Git_hash}.

Я пытаюсь следовать этому уроку.

Q: возможно ли как-то переопределить номер версии, указанный в элементе версии файла pom?

Answer 1

Один из способов добиться этого - использовать плагин git-commit-id-plugin. Добавьте это в список плагинов в build раздел вашего pom.xml:

<plugin>
    <groupId>pl.project13.maven</groupId>
    <artifactId>git-commit-id-plugin</artifactId>
    <version>${git-commit-id-plugin.version}</version>
    <executions>
        <execution>
            <id>get-the-git-infos</id>
            <goals>
                <goal>revision</goal>
            </goals>
            <phase>validate</phase>
        </execution>
    </executions>
    <configuration>
        <dotGitDirectory>${project.basedir}/.git</dotGitDirectory>
    </configuration>
</plugin>

Обратите внимание, что я изменил фазу на validate, поэтому свойство номера ревизии уже доступно, когда артефакт упакован.

Затем добавьте следующее к build раздел:

<build>
    <finalName>${project.artifactId}-${project.version}-${git.commit.id.describe-short}</finalName>
    <!-- your list of plugins -->
</build>

git.commit.id.describe-short собственность производится git-commit-id-plugin, Он содержит текущий номер редакции git (сокращен до 7 цифр) и необязательный dirty индикатор.

Полученный артефакт будет выглядеть так: examplelib-1.0.2-efae3b9.jar (или же examplelib-1.0.2-efae3b9-dirty.jar если в вашем репозитории есть незафиксированные изменения).

Кроме того, вы также можете поместить эту информацию в файл MANIFEST.MF вашего артефакта. В таком случае добавьте это в список плагинов (в примере предполагается, что артефакт является jar):

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-jar-plugin</artifactId>
    <configuration>
        <archive>
            <manifestEntries>
                <SCM-Revision>${git.commit.id.describe-short}</SCM-Revision>
            </manifestEntries>
        </archive>
    </configuration>
</plugin>

---

Дополнительные замечания:

1. Я показал простую конфигурацию git-commit-id-plugin, На их сайте вы можете найти больше вариантов и свойств. В дополнение к свойствам, которые можно использовать внутри pom.xml, плагин также может генерировать файл свойств, содержащий информацию о ревизии.

2. В качестве альтернативы git-commit-id-pluginВы можете предпочесть buildnumber-maven-plugin. Для получения номеров ревизий этому плагину требуется плагин SCM, также настроенный в вашем pom.xml.

3. Эта настройка может мешать другим плагинам, которые преобразуют или переименовывают ваши артефакты (в моем случае это был плагин maven-shade-plugin - один из исходных файлов jar не содержал правильный номер ревизии).

Answer 2

Приведенный выше ответ не сработал для меня. Я нашел ссылку https://dzone.com/articles/maven-git-commit-id-plugin, откуда я скопировал код плагина ниже. У меня это сработало впервые. Теперь у меня есть файл git.properties, который автоматически включается в мой целевой JAR-файл. Очень полезно для отслеживания.

<plugin>
<groupId>pl.project13.maven</groupId>
<artifactId>git-commit-id-plugin</artifactId>
<version>2.2.4</version>
<executions>
    <execution>
        <id>get-the-git-infos</id>
        <goals>
            <goal>revision</goal>
        </goals>
    </execution>
</executions>
<configuration>
    <dotGitDirectory>${project.basedir}/.git</dotGitDirectory>
    <prefix>git</prefix>
    <verbose>false</verbose>
    <generateGitPropertiesFile>true</generateGitPropertiesFile>
    <generateGitPropertiesFilename>${project.build.outputDirectory}/git.properties</generateGitPropertiesFilename>
    <format>json</format>
    <gitDescribe>
        <skip>false</skip>
        <always>false</always>
        <dirty>-dirty</dirty>
    </gitDescribe>
</configuration>

Добавьте finalName в раздел сборки, чтобы также указать версию в имени целевого файла.

<build>

<finalName>${project.artifactId}-${project.version}-${git.commit.id.describe-short}</finalName>

...

</build>