You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+20-3Lines changed: 20 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,13 +29,13 @@ If you have a nice use case to share, please do fork this file and file a pull r
29
29
30
30
Getting the plugin
31
31
==================
32
-
The plugin is available from **Maven Central** (<ahref="http://search.maven.org/#search%7Cga%7C1%7Cpl.project13">see here</a>), so you don't have to configure any additional repositories to use this plugin.
32
+
The plugin **is available from Maven Central** (<ahref="http://search.maven.org/#search%7Cga%7C1%7Cpl.project13">see here</a>), so you don't have to configure any additional repositories to use this plugin.
33
33
34
34
A detailed description of using the pluing is available in the <ahref="https://github.com/ktoso/maven-git-commit-id-plugin#using-the-plugin">Using the plugin</a> section. All you need to do in the basic setup is to include that plugin definition in your `pom.xml` - more advanced configurations are also explained so... read on!
35
35
36
36
Versions
37
37
--------
38
-
The current version is **2.1.7**.
38
+
The current version is **2.1.9**.
39
39
40
40
You can check the available versions by visiting [search.maven.org](http://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22pl.project13.maven%22%20AND%20a%3A%22git-commit-id-plugin%22), though using the newest is obviously the best choice.
41
41
@@ -150,7 +150,23 @@ It's really simple to setup this plugin; below is a sample pom that you may base
150
150
to use properties to enable / disable pom features. Default value is 'false'.
151
151
-->
152
152
<skip>false</skip>
153
-
153
+
154
+
<!-- @since 2.1.9 -->
155
+
<!--
156
+
Can be used to exclude certain properties from being emited into the resulting file.
157
+
May be useful when you want to hide {@code git.remote.origin.url} (maybe because it contains your repo password?),
158
+
or the email of the committer etc.
159
+
160
+
Each value may be globbing, that is, you can write {@code git.commit.user.*} to exclude both, the {@code name},
161
+
as well as {@code email} properties from being emitted into the resulting files.
162
+
163
+
Please note that the strings here are Java regexes ({@code .*} is globbing, not plain {@code *}).
read up about git-describe on the in man, or it's homepage - it's a really powerful versioning helper
@@ -490,6 +506,7 @@ Optional parameters:
490
506
***skipPoms** - `(default: true)` - Force the plugin to run even if you're inside of an pom packaged project.
491
507
***failOnNoGitDirectory** - `(default: true)`*(available since v2.0.4)* - Specify whether the plugin should fail when a .git directory can not be found. When set to false and no .git directory is found the plugin will skip execution.
492
508
***skip** - `(default: false)`*(available since v2.1.8)* - Skip the plugin execution completely.
509
+
***excludeProperties** - `(default: empty)`*(available since v2.1.9)* - Allows to filter out properties that you *don't* want to expose. This feature was implemented in response to [this issue](https://github.com/ktoso/maven-git-commit-id-plugin/issues/91), so if you're curious about the use-case, check that issue.
493
510
494
511
**gitDescribe**:
495
512
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](https://github.com/ktoso/maven-git-commit-id-plugin#git-describe---short-intro-to-an-awesome-command), you probably can skip this section, as it just explains the same options that git provides.
0 commit comments