SCM使用GIT而非SVN時(shí),使用Maven發(fā)布,總是會(huì)出一些莫名其妙的問題,google查找原因,無意中看到了這個(gè)插件;

對于該插件,到目前為止,文檔比較少,尤其是中文的文檔;全部的信息都包含在項(xiàng)目說明文件中了;項(xiàng)目地址:

https://github.com/ktoso/maven-git-commit-id-plugin

對于英語不好的我來說,看英語很痛苦,為了不讓自己在同一個(gè)地方痛苦兩次,嘗試在此記錄下該插件的使用及其配置, 方便自己,也方便其他英語不好的同仁們;如有歧義,請以原版文檔為主.

?

    <plugin>

	<groupId>pl.project13.maven</groupId>

	<artifactId>git-commit-id-plugin</artifactId>

	<version>2.1.5</version>

	<executions>

		<execution>

			<goals>

				<goal>revision</goal>

			</goals>

		</execution>

	</executions>

	<configuration>

		<!--日期格式;默認(rèn)值:dd.MM.yyyy '@' HH:mm:ss z;-->

		<dateFormat>yyyyMMddHHmmss</dateFormat>

		<!--,構(gòu)建過程中,是否打印詳細(xì)信息;默認(rèn)值:false;-->

		<verbose>true</verbose>

		<!-- ".git"文件路徑;默認(rèn)值:${project.basedir}/.git; -->

		<dotGitDirectory>${project.basedir}/.git</dotGitDirectory>

		<!--若項(xiàng)目打包類型為pom,是否取消構(gòu)建;默認(rèn)值:true;-->

		<skipPoms>false</skipPoms>

		<!--是否生成"git.properties"文件;默認(rèn)值:false;-->

		<generateGitPropertiesFile>true</generateGitPropertiesFile>

		<!--指定"git.properties"文件的存放路徑(相對于${project.basedir}的一個(gè)路徑);-->

		<generateGitPropertiesFilename>git.properties</generateGitPropertiesFilename>

		<!--".git"文件夾未找到時(shí),構(gòu)建是否失敗;若設(shè)置true,則構(gòu)建失敗;若設(shè)置false,則跳過執(zhí)行該目標(biāo);默認(rèn)值:true;-->

		<failOnNoGitDirectory>true</failOnNoGitDirectory>



		<!--git描述配置,可選;由JGit提供實(shí)現(xiàn);-->

		<gitDescribe>

			<!--是否生成描述屬性-->

			<skip>false</skip>

			<!--提交操作未發(fā)現(xiàn)tag時(shí),僅打印提交操作ID,-->

			<always>false</always>

			<!--提交操作ID顯式字符長度,最大值為:40;默認(rèn)值:7;

				0代表特殊意義;后面有解釋; 

			-->

			<abbrev>7</abbrev>

			<!--構(gòu)建觸發(fā)時(shí),代碼有修改時(shí)(即"dirty state"),添加指定后綴;默認(rèn)值:"";-->

			<dirty>-dirty</dirty>

			<!--always print using the "tag-commits_from_tag-g_commit_id-maybe_dirty" format, even if "on" a tag.

				The distance will always be 0 if you're "on" the tag.

			-->

			<forceLongFormat>false</forceLongFormat>

		</gitDescribe>

	</configuration>

</plugin>
  

以上代碼給出了插件的使用及屬性使用,中文內(nèi)容則是根據(jù)自己的理解翻譯; 以下是從項(xiàng)目文檔中翻譯過來的屬性解釋:

?

configuration options depth

dotGitDirectory -(默認(rèn)值:${project.basedir}/.git)".git"文件夾路徑;在多模塊項(xiàng)目中,可以使用以下寫法得到上一級目錄中的".git"文件夾:${project.basedir}/../.git;

prefix -(默認(rèn)值:git)公開屬性的命名空間,保持默認(rèn),無須指定;
dateFormat -(默認(rèn)值:dd.MM.yyyy '@' HH:mm:ss z)是SimpleDateFormat類使用的 格式化 標(biāo)準(zhǔn);用于格式化" git.build.time "和" git.commit.time ";
verbose -(默認(rèn)值:false)如果設(shè)置為true,則會(huì)打印出獲取的所有屬性信息;
generateGitPropertiesFile -(默認(rèn)值:false)強(qiáng)制生成" git.properties "文件;

generateGitPropertiesFilename -(默認(rèn)值:src/main/resources/git.properties)指定生成的屬性文件的路徑,相對于${project.basedir}來說;
skipPoms -(默認(rèn)值:true)如果是pom類型項(xiàng)目,是否跳過執(zhí)行;
failOnNoGitDirectory -(默認(rèn)值:true) ".git"文件夾未找到時(shí),構(gòu)建是否失敗;若設(shè)置true,則構(gòu)建失敗;若設(shè)置false,則跳過執(zhí)行該目標(biāo);

gitDescribe :Worth pointing out is, that git-commit-id tries to be 1-to-1 compatible with git's plain output, even though the describe functionality has been reimplemented manually using JGit (you don't have to have a git executable to use the plugin). So if you're familiar with git-describe, you probably can skip this section, as it just explains the same options that git provides.

abbrev -(默認(rèn)值:7)打印的object id的長度;

典型輸出的例子:v2.1.0-1-gf5cd254,where -1- means the number of commits away from the mentioned tag;" -gf5cd254 "部分表示此次提交操作的ID的前7位字符( f5cd254 ),請注意,包含前綴"g"是為了說明它是一個(gè)commit id,它不是object id的一部分,這是git的一個(gè)默認(rèn)行為;

abbrev=0 是一個(gè)特殊情況.其隱藏了從"tag"到"object id"的部分,具體請參考項(xiàng)目文檔;
dirty -(默認(rèn)值:"")當(dāng)有代碼未提交時(shí),執(zhí)行此次操作,信息輸出時(shí)添加后綴;"-"符號不會(huì)自動(dòng)添加,建議設(shè)定該屬性時(shí)添加"-"前綴,和commit ID區(qū)分開來;
tags -(默認(rèn)值:false);
long -(默認(rèn)值:false)如果當(dāng)前提交是tag,git-describe默認(rèn)只會(huì)輸出tag名稱;使用該屬性可以強(qiáng)制格式化為指定格式.例如:tagname-0-gc0ffebabe,注意此處 -0-,如果不使用 forceLongFormat 模式,則輸出為:tagname;
always -(默認(rèn)值:true)如果不能發(fā)現(xiàn)tag,則此次提交會(huì)打印object id;

skip -(默認(rèn)值:false)若沒有在構(gòu)建中使用"git-describe"信息,you can opt to be calculate it;

本文只是簡單的介紹了插件的基本配置,更多深入的用法,請查看項(xiàng)目代碼及使用文檔;

?

Maven插件之git-commit-id-plugin