Я использую maven, и моя цель - включить хэш-код git commit в номер версии. Что-то вроде: 1.1. {Git_hash}.
Я пытаюсь следовать этому учебнику.
Q: возможно ли каким-либо образом переопределить номер версии, указанный в элементе версии файла pom?
Я использую maven, и моя цель - включить хэш-код git commit в номер версии. Что-то вроде: 1.1. {Git_hash}.
Я пытаюсь следовать этому учебнику.
Q: возможно ли каким-либо образом переопределить номер версии, указанный в элементе версии файла pom?
Один из способов добиться этого - использовать 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>
Дополнительные замечания:
Я показал простую конфигурацию git-commit-id-plugin
. На их сайте вы можете найти дополнительные параметры и свойства. В дополнение к свойствам, которые могут быть использованы внутри pom.xml, плагин также может генерировать файл свойств, содержащий информацию о ревизии.
В качестве альтернативы git-commit-id-plugin
вы можете предпочесть buildnumber-maven-plugin. Чтобы получить номера версий, для этого плагина требуется плагин SCM, также настроенный в вашем pom.xml.
Эта настройка может мешать другим плагинам, которые преобразуют или переименовывают ваши артефакты (в моем случае это был maven-shade-plugin - один из источников, который он создает, не содержал правильный номер версии).
Приведенный выше ответ не работает для меня. Я нашел ссылку 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>