Skip to content

Commit 11373ea

Browse files
authored
Add a section about plugin options and configurations
1 parent ee5424e commit 11373ea

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

docs/faq.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,17 @@
11
Frequently Asked Question (FAQ)
22
=========
33

4+
Plugin options and configurations
5+
-------------------------------
6+
This plugin is around for quite some time and has various options and configurations.
7+
The most up-to-date documentation about the various options can be found in the [plugin itself](https://github.com/git-commit-id/git-commit-id-maven-plugin/blob/master/src/main/java/pl/project13/maven/git/GitCommitIdMojo.java#L105).
8+
9+
On top of the various options that can be configured in the `pom.xml` the plugin has the following command-line arguments:
10+
* `-Dmaven.gitcommitid.skip=true` - skip the plugin execution
11+
* `-Dmaven.gitcommitid.nativegit=true` - by default this plugin will use the `jgit` implementation to interact with your git repository, specify this command-line option to use the native `git` binary instead
12+
Note that all command-line options can also be configured in the `pom.xml`.
13+
14+
415
Generated properties are not usable inside the pom / properties don't get exposed by the plugin
516
-------------------------------
617
Since version `2.1.4` there is a switch to control if you want the plugin to expose the generated properties to your pom as well.

0 commit comments

Comments
 (0)