The property is set to {@code false} by default to prevent the overriding of - * properties that may be unrelated to the project. If you need to expose your git properties - * to another maven module (e.g. maven-antrun-plugin) you need to set it to {@code true}.
+ *The property is set to {@code false} by default to prevent the overriding of properties that + * may be unrelated to the project. If you need to expose your git properties to another maven + * module (e.g. maven-antrun-plugin) you need to set it to {@code true}. * - *
Inject git properties into all reactor projects, not just the current one - * may slow down the build and you don't always need this feature.
+ *Inject git properties into all reactor projects, not just the current one may slow down the + * build and you don't always need this feature. * - *
For details about why you might want to skip this, read this issue: - * pull #65
+ *For details about why you might want to skip this, read this issue: pull #65 * *
Example: - *
- * {@code
- * false
- * }
- *
- *
+ *
+ * {@code
+ * false
+ * }
*
* @since 2.1.4
*/
@@ -125,151 +130,136 @@ public class GitCommitIdMojo extends AbstractMojo {
boolean injectAllReactorProjects;
/**
- * Configuration to tell the git-commit-id-maven-plugin to print
- * some more verbose information during the build
- * (e.g. a summary of all collected properties when it's done).
+ * Configuration to tell the git-commit-id-maven-plugin to print some more verbose information
+ * during the build (e.g. a summary of all collected properties when it's done).
*
- * By default this option is disabled (set to {@code false})
+ *By default this option is disabled (set to {@code false}) * - *
Note, If enabled (set to {@code true}) the plugin may - * print information you deem sensible, so be extra cautious when you share those.
+ *Note, If enabled (set to {@code true}) the plugin may print information you deem sensible, + * so be extra cautious when you share those. * *
Example: - *
- * {@code
- * false
- * }
- *
- *
+ *
+ * {@code
+ * false
+ * }
*/
@Parameter(defaultValue = "false")
boolean verbose;
/**
- * Configuration to tell the git-commit-id-maven-plugin to not run in
- * a pom packaged project (e.g. {@code By default 'pom' packaged projects will be skipped (to {@code true})
+ *By default 'pom' packaged projects will be skipped (to {@code true}) * - *
You may want to set this to {@code false}, if the plugin - * should also run inside a pom packaged project. - * Most projects won't need to override this property. - * For an use-case for this kind of behaviour see: + *
You may want to set this to {@code false}, if the plugin should also run inside a pom + * packaged project. Most projects won't need to override this property. For an use-case for this + * kind of behaviour see: * - * Issue 21 - *
+ *Issue 21 * - *
Note: The plugin might not execute at all, if you also set {@code
Note: The plugin might not execute at all, if you also set {@code
+ *
Example: - *
- * {@code
- * true
- * }
- *
- *
+ *
+ * {@code
+ * true
+ * }
*/
@Parameter(defaultValue = "true")
boolean skipPoms;
/**
- * Configuration to tell the git-commit-id-maven-plugin to
- * generate a {@code 'git.properties'} file.
- * By default the plugin will not not generate such a file (set to {@code false}),
+ * Configuration to tell the git-commit-id-maven-plugin to generate a {@code 'git.properties'}
+ * file. By default the plugin will not not generate such a file (set to {@code false}),
* and only adds properties to maven project properties.
*
- * Set this to {@code 'true'} if you want an easy way to expose your git information - * into your final artifact (jar, war, ...), which will generate a properties file (with filled out values) - * that can be configured to end up in the final artifact. - * Refer to the configuration of {@link #generateGitPropertiesFilename}` - * that helps you setup that final path.
+ *Set this to {@code 'true'} if you want an easy way to expose your git information into your + * final artifact (jar, war, ...), which will generate a properties file (with filled out values) + * that can be configured to end up in the final artifact. Refer to the configuration of {@link + * #generateGitPropertiesFilename}` that helps you setup that final path. + * + *
Such generated property file, can normally be read using during runtime. * - *
Such generated property file, can normally be read using *
* new Properties().load(...)
*
- * during runtime.
*
- * Note: - * When writing the {@code git.properties} file the value *git.build.time* will only be updated - * when things in the commit information have changed. If you only change a bit of your code - * and rebuild/rerun you will see an older timestamp that you may have expected. Essentially - * the functional meaning becomes **The latest build time when the git information was written - * to the git.properties file**. - * The reason why this was done can be found in - * [issue 151](https://github.com/git-commit-id/git-commit-id-maven-plugin/issues/151).
+ *Note: When writing the {@code git.properties} file the value *git.build.time* will only be + * updated when things in the commit information have changed. If you only change a bit of your + * code and rebuild/rerun you will see an older timestamp that you may have expected. Essentially + * the functional meaning becomes **The latest build time when the git information was written to + * the git.properties file**. The reason why this was done can be found in [issue + * 151](https://github.com/git-commit-id/git-commit-id-maven-plugin/issues/151). * *
Example: - *
- * {@code
- * true
- * }
- *
- *
+ *
+ * {@code
+ * true
+ * }
*/
@Parameter(defaultValue = "false")
boolean generateGitPropertiesFile;
/**
- * Configuration to tell the git-commit-id-maven-plugin about the
- * location where you want to generate a {@code 'git.properties'} file.
+ * Configuration to tell the git-commit-id-maven-plugin about the location where you want to
+ * generate a {@code 'git.properties'} file.
*
- * By default the file would be generated under - * {@code ${project.build.outputDirectory}/git.properties}, but you would need to - * set {@link #generateGitPropertiesFile} to {@code true} first to "activate" the generation of this file. - * You can also choose the format of the generated properties by specifying it under {@link #format}.
+ *By default the file would be generated under {@code + * ${project.build.outputDirectory}/git.properties}, but you would need to set {@link + * #generateGitPropertiesFile} to {@code true} first to "activate" the generation of this file. + * You can also choose the format of the generated properties by specifying it under {@link + * #format}. * - *
The path can be relative to {@code ${project.basedir}} (e.g. {@code target/classes/git.properties}) or - * can be a full path (e.g. {@code ${project.build.outputDirectory}/git.properties}).
+ *The path can be relative to {@code ${project.basedir}} (e.g. {@code + * target/classes/git.properties}) or can be a full path (e.g. {@code + * ${project.build.outputDirectory}/git.properties}). * *
Note: If you plan to set the generateGitPropertiesFilename-Path to a location where usually
* the source-files comes from (e.g. {@code src/main/resources}) and experience that your IDE
- * (e.g. eclipse) invokes "Maven Project Builder" once every second, the chances that you
- * are using an IDE where the src-folder is a watched folder for files that are only
- * edited by humans is pretty high.
- *
- * For further information refer to the manual for your
- * specific IDE and check the workflow of "incremental project builders".
- *
- * In order to fix this problem we recommend to set the generateGitPropertiesFilename-Path
- * to a target folder (e.g. {@code ${project.build.outputDirectory}}) since this is
- * the place where all derived/generated resources should go.
- *
+ * (e.g. eclipse) invokes "Maven Project Builder" once every second, the chances that you are
+ * using an IDE where the src-folder is a watched folder for files that are only edited by
+ * humans is pretty high.
+ * For further information refer to the manual for your specific IDE and check the workflow of
+ * "incremental project builders".
+ * In order to fix this problem we recommend to set the generateGitPropertiesFilename-Path to a
+ * target folder (e.g. {@code ${project.build.outputDirectory}}) since this is the place where all
+ * derived/generated resources should go.
* With plugin version 3.0.0 we introduced a smarter way to counter that issue, but that might not
- * be supported by your IDE.
- * See: pull 385
- * for further information
Example: - *
- * {@code
- * ${project.build.outputDirectory}/git.properties
- * }
- *
- *
*
+ * {@code
+ *
+ * ${project.build.outputDirectory}/git.properties
+ *
+ * }
*/
@Parameter(defaultValue = "${project.build.outputDirectory}/git.properties")
String generateGitPropertiesFilename;
/**
- * Controls whether special characters in the properties
- * within the {@link #generateGitPropertiesFilename} should be unicode escaped.
- * By default properties are escaped (e.g. \\u6E2C\\u8A66\\u4E2D\\u6587).
- * If you write commit messages in chinese and want to extract the message
- * without any additional conversion from the generated properties
- * you may want to set this to {@code false}.
+ * Controls whether special characters in the properties within the {@link
+ * #generateGitPropertiesFilename} should be unicode escaped. By default properties are escaped
+ * (e.g. \\u6E2C\\u8A66\\u4E2D\\u6587). If you write commit messages in chinese and want to
+ * extract the message without any additional conversion from the generated properties you may
+ * want to set this to {@code false}.
*
- * See issue 590 - * for further details.
+ *See issue + * 590 for further details. * *
Example: - *
- * {@code
- * true
- * }
- *
- *
+ *
+ * {@code
+ *
+ * true
+ *
+ * }
*
* @since 6.0.0
*/
@@ -277,178 +267,178 @@ public class GitCommitIdMojo extends AbstractMojo {
boolean generateGitPropertiesFileWithEscapedUnicode;
/**
- * Configuration to tell the git-commit-id-maven-plugin about the
- * root directory of the git repository we want to check.
- * By default uses {@code ${project.basedir}/.git} will most probably be
- * ok for single module projects, in other cases please use `../` to get higher up
- * in the dir tree (e.g. {@code ${project.basedir}/../.git}).
+ * Configuration to tell the git-commit-id-maven-plugin about the root directory of the git
+ * repository we want to check. By default uses {@code ${project.basedir}/.git} will most probably
+ * be ok for single module projects, in other cases please use `../` to get higher up in the dir
+ * tree (e.g. {@code ${project.basedir}/../.git}).
*
* Example: - *
- * {@code
- * ${project.basedir}/.git
- * }
- *
- *
+ *
+ * {@code
+ *
+ * ${project.basedir}/.git
+ *
+ * }
*/
@Parameter(defaultValue = "${project.basedir}/.git")
File dotGitDirectory;
/**
- * Configuration for the {@code 'git-describe'} command.
- * You can modify the dirty marker, abbrev length and other options here.
- * The following `gitDescribe` configuration below is optional and can be leveraged as a
- * really powerful versioning helper. If you are not familiar with
- * git-describe
+ * Configuration for the {@code 'git-describe'} command. You can modify the dirty marker, abbrev
+ * length and other options here. The following `gitDescribe` configuration below is optional and
+ * can be leveraged as a really powerful versioning helper. If you are not familiar with git-describe
* it is highly recommended to go through this part of the documentation.
*
- * More advanced users can most likely skip the explanations in this section, as it just explains the - * same options that git provides. - * As a side note this plugin 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).
+ *More advanced users can most likely skip the explanations in this section, as it just + * explains the same options that git provides. As a side note this plugin 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). * - * For further information refer to this. + *
For further information refer to this. * *
Example: - *
- * {@code
- *
- *
- * false
- *
- *
- * true
- *
- *
- * 7
- *
- *
- * -dirty
- *
- *
- * *
- *
- *
- * false
- *
- *
- * false
- *
- * }
- *
- *
+ *
+ * {@code
+ *
+ *
+ * false
+ *
+ *
+ * true
+ *
+ *
+ * 7
+ *
+ *
+ * -dirty
+ *
+ *
+ * *
+ *
+ *
+ * false
+ *
+ *
+ * false
+ *
+ * }
+ *
+ *
*
* @since 2.1.0
*/
- @Parameter
- GitDescribeConfig gitDescribe;
+ @Parameter GitDescribeConfig gitDescribe;
/**
- * Minimum length of {@code 'git.commit.id.abbrev'} property. - * Value must be from 2 to 40 (inclusive), other values will result in an exception.
+ * Minimum length of {@code 'git.commit.id.abbrev'} property. Value must be from 2 to 40 + * (inclusive), other values will result in an exception. * - *Defaults to `7`
+ *Defaults to `7` * - *
An abbreviated commit is a shorter version of commit id. However, it is guaranteed to be unique. - * To keep this contract, the plugin may decide to print an abbreviated version - * that is longer than the value specified here.
+ *An abbreviated commit is a shorter version of commit id. However, it is guaranteed to be + * unique. To keep this contract, the plugin may decide to print an abbreviated version that is + * longer than the value specified here. * - *
Example: You have a very big repository, yet you set this value to 2. It's very probable that you'll end up - * getting a 4 or 7 char long abbrev version of the commit id. If your repository, on the other hand, - * has just 4 commits, you'll probably get a 2 char long abbreviation.
+ *Example: You have a very big repository, yet you set this value to 2. It's very + * probable that you'll end up getting a 4 or 7 char long abbrev version of the commit id. If your + * repository, on the other hand, has just 4 commits, you'll probably get a 2 char long + * abbreviation. * *
Example: - *
- * {@code
- * 7
- * }
- *
- *
+ *
+ * {@code
+ * 7
+ * }
*
* @since 2.0.4
*/
@@ -456,75 +446,67 @@ public class GitCommitIdMojo extends AbstractMojo {
int abbrevLength;
/**
- * Denotes the format to save properties of the properties file that can be configured with
- * {@link #generateGitPropertiesFilename}.
+ * Denotes the format to save properties of the properties file that can be configured with {@link
+ * #generateGitPropertiesFilename}.
*
- * Valid options are encoded in {@link CommitIdPropertiesOutputFormat} - * and currently would allow "properties" (default) and "json". - * Future option like yml, toml, ... might be supported at some point.
+ *Valid options are encoded in {@link CommitIdPropertiesOutputFormat} and currently would + * allow "properties" (default) and "json". Future option like yml, toml, ... might be supported + * at some point. * - *
Note:
- * If you set this to "json", you might also should checkout the documentation about
- * {@link #commitIdGenerationMode} and may want to set
- * {@code
Note: If you set this to "json", you might also should checkout the documentation about
+ * {@link #commitIdGenerationMode} and may want to set {@code
+ *
Example: - *
- * {@code
- * properties
- * }
- *
- *
+ *
+ * {@code
+ * properties
+ * }
*/
@Parameter(defaultValue = "properties")
String format;
/**
- * Not settable by any configuration in the {@code pom.xml}.
- * For internal use only (represents the {@link #format} the user has set as enum.
+ * Not settable by any configuration in the {@code pom.xml}. For internal use only (represents the
+ * {@link #format} the user has set as enum.
*/
private CommitIdPropertiesOutputFormat commitIdPropertiesOutputFormat;
/**
- * Configuration to tell the git-commit-id-maven-plugin about the
- * property that will be used as the "namespace" prefix for all exposed/generated properties.
- * An example the plugin may generate the property `${configured-prefix}.commit.id`.
- * Such behaviour can be used to generate properties for multiple git repositories (see
- * issue 173
- * for a full example).
+ * Configuration to tell the git-commit-id-maven-plugin about the property that will be used as
+ * the "namespace" prefix for all exposed/generated properties. An example the plugin may generate
+ * the property `${configured-prefix}.commit.id`. Such behaviour can be used to generate
+ * properties for multiple git repositories (see issue
+ * 173 for a full example).
*
- * By default is set to {@code 'git'} that for example would allow you to access {@code ${git.branch}}
+ *By default is set to {@code 'git'} that for example would allow you to access {@code + * ${git.branch}} * *
Example: - *
- * {@code
- * git
- * }
- *
- *
+ *
+ * {@code
+ * git
+ * }
*/
@Parameter(defaultValue = "git")
String prefix;
/**
- * This date format will be used to format the time of any exposed/generated property
- * that represents dates or times exported by this plugin (e.g. {@code git.commit.time}, {@code git.build.time}).
- * It should be a valid {@link SimpleDateFormat} string.
+ * This date format will be used to format the time of any exposed/generated property that
+ * represents dates or times exported by this plugin (e.g. {@code git.commit.time}, {@code
+ * git.build.time}). It should be a valid {@link SimpleDateFormat} string.
*
- * - * The current dateFormat is set to match maven's default {@code yyyy-MM-dd'T'HH:mm:ssZ}. - * Please note that in previous versions (2.2.0 - 2.2.2) the default dateFormat was set to: - * {@code dd.MM.yyyy '@' HH:mm:ss z}. However the {@code RFC 822 time zone} seems to give a more - * reliable option in parsing the date and it's being used in maven as default.
+ *The current dateFormat is set to match maven's default {@code yyyy-MM-dd'T'HH:mm:ssZ}. + * Please note that in previous versions (2.2.0 - 2.2.2) the default dateFormat was set to: {@code + * dd.MM.yyyy '@' HH:mm:ss z}. However the {@code RFC 822 time zone} seems to give a more reliable + * option in parsing the date and it's being used in maven as default. * *
Example: - *
- * {@code
- * yyyy-MM-dd'T'HH:mm:ssZ
- * }
- *
- *
+ *
+ * {@code
+ * yyyy-MM-dd'T'HH:mm:ssZ
+ * }
*
* @since 2.2.0
*/
@@ -532,48 +514,44 @@ public class GitCommitIdMojo extends AbstractMojo {
String dateFormat;
/**
- * The timezone used in the {@link #dateFormat} of dates exported by this plugin (e.g. {@code git.commit.time}, {@code git.build.time}). - * It should be a valid Timezone string such as {@code 'America/Los_Angeles'}, {@code 'GMT+10'} or {@code 'PST'}.
- * - *As a general warning try to avoid three-letter time zone IDs because the same abbreviation are often used for multiple time zones. - * Please review https://docs.oracle.com/javase/7/docs/api/java/util/TimeZone.html - * for more information on this issue.
- * - *The default value we'll use the timezone use the timezone that's shipped with java - * ({@code java.util.TimeZone.getDefault().getID()}). - * Note: If you plan to set the java's timezone by using - * {@code MAVEN_OPTS=-Duser.timezone=UTC mvn clean package}, - * {@code mvn clean package -Duser.timezone=UTC}, - * or any other configuration keep in mind that this option will override those settings and - * will not take other configurations into account!
+ * The timezone used in the {@link #dateFormat} of dates exported by this plugin (e.g. {@code + * git.commit.time}, {@code git.build.time}). It should be a valid Timezone string such as {@code + * 'America/Los_Angeles'}, {@code 'GMT+10'} or {@code 'PST'}. + * + *As a general warning try to avoid three-letter time zone IDs because the same abbreviation + * are often used for multiple time zones. Please review + * https://docs.oracle.com/javase/7/docs/api/java/util/TimeZone.html for more information on + * this issue. + * + *
The default value we'll use the timezone use the timezone that's shipped with java ({@code + * java.util.TimeZone.getDefault().getID()}). Note: If you plan to set the java's timezone + * by using {@code MAVEN_OPTS=-Duser.timezone=UTC mvn clean package}, {@code mvn clean package + * -Duser.timezone=UTC}, or any other configuration keep in mind that this option will override + * those settings and will not take other configurations into account! * *
Example: - *
- * {@code
- * ${user.timezone}
- * }
- *
- *
+ *
+ * {@code
+ * ${user.timezone}
+ * }
*
* @since 2.2.0
*/
- @Parameter
- String dateFormatTimeZone;
+ @Parameter String dateFormatTimeZone;
/**
- * Specify whether the plugin should fail when a {@code '.git'} directory cannot be found.
- * When set to {@code false} and no {@code .git} directory is found the plugin will skip execution.
+ * Specify whether the plugin should fail when a {@code '.git'} directory cannot be found. When
+ * set to {@code false} and no {@code .git} directory is found the plugin will skip execution.
*
- * Defaults to {@code true}, so a missing {@code '.git'} directory is treated as error - * and should cause a failure in your build.
+ *Defaults to {@code true}, so a missing {@code '.git'} directory is treated as error and + * should cause a failure in your build. * *
Example: - *
- * {@code
- * true
- * }
- *
- *
+ *
+ * {@code
+ * true
+ * }
*
* @since 2.0.4
*/
@@ -581,25 +559,25 @@ public class GitCommitIdMojo extends AbstractMojo {
boolean failOnNoGitDirectory;
/**
- * Set this to {@code false} to continue the build even if unable to get enough data for a complete run. - * This may be useful during CI builds if the CI server does weird things to the repository.
+ * Set this to {@code false} to continue the build even if unable to get enough data for a + * complete run. This may be useful during CI builds if the CI server does weird things to the + * repository. * *Setting this value to {@code false} causes the plugin to gracefully tell you "I did my best" - * and abort its execution if unable to obtain git meta data - yet the build will continue to run without failing.
+ * and abort its execution if unable to obtain git meta data - yet the build will continue to run + * without failing. * - *By default the plugin will fail the build (set to {@code true}) if unable to obtain enough data for a complete - * run.
+ *By default the plugin will fail the build (set to {@code true}) if unable to obtain enough + * data for a complete run. * - *
See issue #63 - * for a rationale behind this flag.
+ *See issue + * #63 for a rationale behind this flag. * *
Example: - *
- * {@code
- * true
- * }
- *
- *
+ *
+ * {@code
+ * true
+ * }
*
* @since 2.1.5
*/
@@ -607,30 +585,28 @@ public class GitCommitIdMojo extends AbstractMojo {
boolean failOnUnableToExtractRepoInfo;
/**
- * This plugin ships with custom {@code jgit} implementation that is being used to obtain all relevant information.
- * If set to {@code true} the plugin will use native git executable instead of the custom {@code jgit} implementation
- * to fetch information about the repository.
- * Of course if set to {@code true} will require a git executable to be installed in system.
+ * This plugin ships with custom {@code jgit} implementation that is being used to obtain all
+ * relevant information. If set to {@code true} the plugin will use native git executable instead
+ * of the custom {@code jgit} implementation to fetch information about the repository. Of course
+ * if set to {@code true} will require a git executable to be installed in system.
*
- * Although setting this to {@code true} (use the native git executable) - * should usually give your build some performance boost, it may randomly - * break if you upgrade your git version and it decides to print information in a different - * format suddenly.
+ *Although setting this to {@code true} (use the native git executable) should usually give + * your build some performance boost, it may randomly break if you upgrade your git version and it + * decides to print information in a different format suddenly. * - *
By default the plugin will use {@code jgit} implementation as a source of information about the repository. - * As rule of thumb, keep using the default {@code jgit} implementation (set to {@code false}) - * until you notice performance problems within your build (usually when you have *hundreds* of maven modules).
+ *By default the plugin will use {@code jgit} implementation as a source of information about + * the repository. As rule of thumb, keep using the default {@code jgit} implementation (set to + * {@code false}) until you notice performance problems within your build (usually when you have + * *hundreds* of maven modules). * - *
With plugin version *3.0.2* you can also control it using the commandline option - * {@code -Dmaven.gitcommitid.nativegit=true}. See {@link #useNativeGitViaCommandLine}
+ *With plugin version *3.0.2* you can also control it using the commandline option {@code + * -Dmaven.gitcommitid.nativegit=true}. See {@link #useNativeGitViaCommandLine} * *
Example: - *
- * {@code
- * true
- * }
- *
- *
+ *
+ * {@code
+ * true
+ * }
*
* @since 2.1.9
*/
@@ -641,18 +617,15 @@ public class GitCommitIdMojo extends AbstractMojo {
* Option to be used in command-line to override the value of {@link #useNativeGit} specified in
* the pom.xml, or its default value if it's not set explicitly.
*
- * NOTE / WARNING: - * Do *NOT* set this property inside the configuration of your plugin. - * Please read issue 315 - * to find out why.
+ *NOTE / WARNING: Do *NOT* set this property inside the configuration of your plugin. Please + * read issue + * 315 to find out why. * *
Example: - *
- * {@code
- * mvn clean package -Dmaven.gitcommitid.nativegit=true
- * }
- *
- *
+ *
+ * {@code
+ * mvn clean package -Dmaven.gitcommitid.nativegit=true
+ * }
*
* @since 3.0.2
*/
@@ -660,22 +633,19 @@ public class GitCommitIdMojo extends AbstractMojo {
boolean useNativeGitViaCommandLine;
/**
- * When set to {@code true} the plugin execution will completely skip.
- * This is useful for e.g. profile activated plugin invocations or to use properties to
- * enable / disable pom features.
+ * When set to {@code true} the plugin execution will completely skip. This is useful for e.g.
+ * profile activated plugin invocations or to use properties to enable / disable pom features.
*
- * By default the execution is not skipped (set to {@code false})
+ *By default the execution is not skipped (set to {@code false}) * - *
With version *2.2.3* you can also skip the plugin by using the commandline option - * {@code -Dmaven.gitcommitid.skip=true}. See {@link #skipViaCommandLine}
+ *With version *2.2.3* you can also skip the plugin by using the commandline option {@code + * -Dmaven.gitcommitid.skip=true}. See {@link #skipViaCommandLine} * *
Example: - *
- * {@code
- * false
- * }
- *
- *
+ *
+ * {@code
+ * false
+ * }
*
* @since 2.1.8
*/
@@ -683,22 +653,19 @@ public class GitCommitIdMojo extends AbstractMojo {
boolean skip;
/**
- * Option to be used in command-line to override the value of {@link #skip} specified in
- * the pom.xml, or its default value if it's not set explicitly.
- * Set this to {@code true} to skip plugin execution via commandline.
+ * Option to be used in command-line to override the value of {@link #skip} specified in the
+ * pom.xml, or its default value if it's not set explicitly. Set this to {@code true} to skip
+ * plugin execution via commandline.
*
- * NOTE / WARNING: - * Do *NOT* set this property inside the configuration of your plugin. - * Please read issue 315 - * to find out why.
+ *NOTE / WARNING: Do *NOT* set this property inside the configuration of your plugin. Please + * read issue + * 315 to find out why. * *
Example: - *
- * {@code
- * mvn clean package -Dmaven.gitcommitid.skip=true
- * }
- *
- *
+ *
+ * {@code
+ * mvn clean package -Dmaven.gitcommitid.skip=true
+ * }
*
* @since 2.2.4
*/
@@ -708,37 +675,34 @@ public class GitCommitIdMojo extends AbstractMojo {
/**
* Use with caution!
*
- * Set this to {@code true} to only run once in a multi-module build. - * This means that the plugins effects will only execute once for the first project in the execution graph. - * If {@code skipPoms} is set to {@code true} (default) the plugin will run for the first - * non pom project in the execution graph (as listed in the reactor build order). - * This probably won't "do the right thing" if your project has more than one git repository.
+ *Set this to {@code true} to only run once in a multi-module build. This means that the + * plugins effects will only execute once for the first project in the execution graph. If {@code + * skipPoms} is set to {@code true} (default) the plugin will run for the first non pom project in + * the execution graph (as listed in the reactor build order). This probably won't "do the right + * thing" if your project has more than one git repository. * - *
Defaults to {@code false}, so the plugin may get executed multiple times in a reactor build!
+ *Defaults to {@code false}, so the plugin may get executed multiple times in a reactor build! * - *
Important: If you're using {@link #generateGitPropertiesFile}, setting {@code runOnlyOnce} will make - * the plugin only generate the file in the project build directory which is the first one - * based on the execution graph (!).
+ *Important: If you're using {@link #generateGitPropertiesFile}, setting {@code runOnlyOnce} + * will make the plugin only generate the file in the project build directory which is the first + * one based on the execution graph (!). * *
Important: Please note that the git-commit-id-maven-plugin also has an option to skip pom
* project ({@code
For multi-module build you might also want to set {@link #injectAllReactorProjects} to make - * the {@code git.*} maven properties available in all modules.
+ * the {@code git.*} maven properties available in all modules. * - *Note: - * Prior to version 4.0.0 the plugin was simply using the execute once applied for the parent - * project (which might have skipped execution if the parent project was a pom project).
+ *Note: Prior to version 4.0.0 the plugin was simply using the execute once applied for the + * parent project (which might have skipped execution if the parent project was a pom project). * *
Example: - *
- * {@code
- * true
- * }
- *
- *
+ *
+ * {@code
+ * true
+ * }
*
* @since 2.1.12
*/
@@ -746,134 +710,120 @@ public class GitCommitIdMojo extends AbstractMojo {
boolean runOnlyOnce;
/**
- * Can be used to exclude certain properties from being emitted (e.g. filter out properties
- * that you *don't* want to expose). May be useful when you want to hide
- * {@code git.build.user.email} (maybe because you don't want to expose your eMail?),
- * or the email of the committer?
- *
- * Each value may be globbing, that is, you can write {@code git.commit.user.*} to - * exclude both the {@code name}, as well as {@code email} properties from being emitted. - * - *
Please note that the strings here are Java regexes ({@code .*} is globbing, - * not plain {@code *}). - * If you have a very long list of exclusions you may want to - * use {@link #includeOnlyProperties}. - * - *
This feature was implemented in response to issue 91, - * so if you're curious about the use-case, check that issue.
- * - *Prior to version 3.0.0 the plugin used the 'naive' approach to ask for all properties - * and then apply filtering. However, with the growing numbers of properties each property - * eat more and more of execution time that will be filtered out afterwards. - * With 3.0.0 this behaviour was readjusted to a 'selective running' approach whereby the - * plugin will not even try to get the property when excluded. Such behaviour can result in - * an overall reduced execution time of the plugin - * (see issue 408 for details).
+ * Can be used to exclude certain properties from being emitted (e.g. filter out properties that + * you *don't* want to expose). May be useful when you want to hide {@code git.build.user.email} + * (maybe because you don't want to expose your eMail?), or the email of the committer? + * + *Each value may be globbing, that is, you can write {@code git.commit.user.*} to exclude both + * the {@code name}, as well as {@code email} properties from being emitted. + * + *
Please note that the strings here are Java regexes ({@code .*} is globbing, not plain {@code + * *}). If you have a very long list of exclusions you may want to use {@link + * #includeOnlyProperties}. + * + *
This feature was implemented in response to issue 91, so + * if you're curious about the use-case, check that issue. + * + *
Prior to version 3.0.0 the plugin used the 'naive' approach to ask for all properties and + * then apply filtering. However, with the growing numbers of properties each property eat more + * and more of execution time that will be filtered out afterwards. With 3.0.0 this behaviour was + * readjusted to a 'selective running' approach whereby the plugin will not even try to get the + * property when excluded. Such behaviour can result in an overall reduced execution time of the + * plugin (see issue 408 for + * details). * *
Defaults to the empty list (= no properties are excluded). * *
Example: - *
- * {@code
- *
- * git.user.*
- *
- * }
- *
- *
+ *
+ * {@code
+ *
+ * git.user.*
+ *
+ * }
*
* @since 2.1.9
*/
- @Parameter
- ListThe inclusion rules, will be overruled by the {@link #excludeProperties} rules - * (e.g. you can write an inclusion rule that applies for multiple - * properties and then exclude a subset of them). - * You can therefor can be a bit broader in the inclusion rules and - * exclude more sensitive ones in the {@link #excludeProperties} rules. - * - *
Each value may be globbing, that is, you can write {@code git.commit.user.*} to - * exclude both the {@code name}, as well as {@code email} properties from being emitted. - * - *
Please note that the strings here are Java regexes ({@code .*} is globbing, - * not plain {@code *}). - * If you have a short list of exclusions you may want to - * use {@link #excludeProperties}. - * - *
Prior to version 3.0.0 the plugin used the 'naive' approach to ask for all properties - * and then apply filtering. However, with the growing numbers of properties each property - * eat more and more of execution time that will be filtered out afterwards. - * With 3.0.0 this behaviour was readjusted to a 'selective running' approach whereby the - * plugin will not even try to get the property when excluded. Such behaviour can result in - * an overall reduced execution time of the plugin - * (see issue 408 for details).
- * - *Defaults to the empty list (= no properties are excluded).
+ * Can be used to include only certain properties into the emission (e.g. include only properties + * that you want to expose). This feature was implemented to avoid big exclude properties + * tag when we only want very few specific properties. + * + *The inclusion rules, will be overruled by the {@link #excludeProperties} rules (e.g. you can + * write an inclusion rule that applies for multiple properties and then exclude a subset of + * them). You can therefor can be a bit broader in the inclusion rules and exclude more sensitive + * ones in the {@link #excludeProperties} rules. + * + *
Each value may be globbing, that is, you can write {@code git.commit.user.*} to exclude both + * the {@code name}, as well as {@code email} properties from being emitted. + * + *
Please note that the strings here are Java regexes ({@code .*} is globbing, not plain {@code + * *}). If you have a short list of exclusions you may want to use {@link #excludeProperties}. + * + *
Prior to version 3.0.0 the plugin used the 'naive' approach to ask for all properties and + * then apply filtering. However, with the growing numbers of properties each property eat more + * and more of execution time that will be filtered out afterwards. With 3.0.0 this behaviour was + * readjusted to a 'selective running' approach whereby the plugin will not even try to get the + * property when excluded. Such behaviour can result in an overall reduced execution time of the + * plugin (see issue 408 for + * details). + * + *
Defaults to the empty list (= no properties are excluded). * *
Example: - *
- * {@code
- *
- * ^git.commit.id.full$
- *
- * }
- *
- *
+ *
+ * {@code
+ *
+ * ^git.commit.id.full$
+ *
+ * }
*
* @since 2.1.14
*/
- @Parameter
- ListDue to the fact that this is one of the major properties the plugin is exporting we - * just don't want to change the exporting mechanism and somehow throw the backwards - * compatibility away. - * We rather provide a convenient switch where you can choose if you - * would like the properties as they always had been, or if you rather need to support - * full json-object compatibility.
- * - *In the case you need to fully support json-object we unfortunately need to change the - * {@code 'git.commit.id'} property from {@code 'git.commit.id'} to {@code 'git.commit.id.full'} in the exporting - * mechanism to allow the generation of a fully valid json object.
+ * The option can be used to tell the plugin how it should generate the {@code 'git.commit.id'} + * property. Due to some naming issues when exporting the properties as an json-object (issue 122) we + * needed to make it possible to export all properties as a valid json-object. + * + *Due to the fact that this is one of the major properties the plugin is exporting we just + * don't want to change the exporting mechanism and somehow throw the backwards compatibility + * away. We rather provide a convenient switch where you can choose if you would like the + * properties as they always had been, or if you rather need to support full json-object + * compatibility. + * + *
In the case you need to fully support json-object we unfortunately need to change the {@code + * 'git.commit.id'} property from {@code 'git.commit.id'} to {@code 'git.commit.id.full'} in the + * exporting mechanism to allow the generation of a fully valid json object. * *
Currently, the switch allows two different options: - *
Note: If you set the value to something that's not equal to {@code 'flat'} or {@code 'full'} (ignoring the case) - * the plugin will output a warning and will fallback to the default {@code 'flat'} mode.
* + *Note: If you set the value to something that's not equal to {@code 'flat'} or {@code + * 'full'} (ignoring the case) the plugin will output a warning and will fallback to the default + * {@code 'flat'} mode. * *
Example: - *
- * {@code
- * flat
- * }
- *
- *
+ *
+ * {@code
+ * flat
+ * }
*
* @since 2.2.0
*/
@@ -881,134 +831,127 @@ public class GitCommitIdMojo extends AbstractMojo {
String commitIdGenerationMode;
/**
- * Not settable by any configuration in the {@code pom.xml}.
- * For internal use only (represents the {@link #commitIdGenerationMode} the user has set as enum.
+ * Not settable by any configuration in the {@code pom.xml}. For internal use only (represents the
+ * {@link #commitIdGenerationMode} the user has set as enum.
*/
private CommitIdGenerationMode commitIdGenerationModeEnum;
/**
* Can be used to replace certain characters or strings using regular expressions within the
- * exposed properties.
- * Replacements can be performed using regular expressions and on a configuration level
- * it can be defined whether the replacement should affect all properties or just a single one.
- *
- * Please note that the replacement will only be applied to properties that are being generated by the plugin.
- * If you want to replace properties that are being generated by other plugins you may want to use the
- * maven-replacer-plugin or any other alternative.
- *
- * Replacements can be configured with a {@code replacementProperty}.
- * A {@code replacementProperty} can have a {@code property}` and a {@code regex}-tag.
- * If the {@code replacementProperty} configuration has a {@code property}-tag the
- * replacement will only be performed on that specific property
- * (e.g. {@code Defaults to the empty list / not set (= no properties are being replaced by default)
+ * exposed properties. Replacements can be performed using regular expressions and on a + * configuration level it can be defined whether the replacement should affect all properties or + * just a single one. + * + *Please note that the replacement will only be applied to properties that are being generated + * by the plugin. If you want to replace properties that are being generated by other plugins you + * may want to use the maven-replacer-plugin or any other alternative. + * + *
Replacements can be configured with a {@code replacementProperty}. A {@code
+ * replacementProperty} can have a {@code property}` and a {@code regex}-tag. If the {@code
+ * replacementProperty} configuration has a {@code property}-tag the replacement will only be
+ * performed on that specific property (e.g. {@code
In case this specific element is not defined or left empty the replacement will be performed + * on all generated properties. + * + *
The optional {@code regex}-tag can either be {@code true} to perform a replacement with + * regular expressions or {@code false} to perform a replacement with java's + * string.replace-function. + * + *
By default the replacement will be performed with regular expressions ({@code true}). + * Furthermore each {@code replacementProperty} need to be configured with a {@code token} and a + * {@code value}. The {@code token} can be seen as the needle and the {@code value} as the text to + * be written over any found tokens. If using regular expressions the value can reference grouped + * regex matches by using $1, $2, etc. + * + *
Since 2.2.4 the plugin allows to define a even more sophisticated ruleset and allows to set + * an {@code propertyOutputSuffix} within each {@code replacementProperty}. If this option is + * empty the original property will be overwritten (default behaviour in 2.2.3). However when this + * configuration is set to {@code something} and a user wants to modify the {@code git.branch} + * property the plugin will keep {@code git.branch} as the original one (w/o modifications) but + * also will be creating a new {@code git.branch.something} property with the requested + * replacement. + * + *
Furthermore with 2.2.4 the plugin allows to perform certain types of string manipulation + * either before or after the evaluation of the replacement. With this feature a user can + * currently easily manipulate the case (e.g. lower case VS upper case) of the input/output + * property. This behaviour can be achieved by defining a list of {@code transformationRules} for + * the property where those rules should take effect. Each {@code transformationRule} consist of + * two required fields {@code apply} and {@code action}. The {@code apply}-tag controls when the + * rule should be applied and can be set to {@code BEFORE} to have the rule being applied before + * or it can be set to {@code AFTER} to have the rule being applied after the replacement. The + * {@code action}-tag determines the string conversion rule that should be applied. Currently + * supported is {@code LOWER_CASE} and {@code UPPER_CASE}. Potential candidates in the feature are + * {@code CAPITALIZATION} and {@code INVERT_CASE} (open a ticket if you need them...). + * + *
Since 4.0.1 the plugin allows to define a {@code forceValueEvaluation}-switch which forces + * the plugin to evaluate the given value on every project. + * + *
This might come handy if every project needs a unique value and a user wants to + * project specific variables like {@code ${project.artifactId}}. Be advised that this essentially + * means that the plugin must run for every child-project of a reactor build and thus might + * cause some overhead (the git properties should be cached). For a use-case refer to issue 457 + * + *
Defaults to the empty list / not set (= no properties are being replaced by default) * *
Example: - *
- * {@code
- *
- *
- *
- * git.branch
- * something
- * ^([^\/]*)\/([^\/]*)$
- * $1-$2
- * true
- * false
- *
- *
- * BEFORE
- * UPPER_CASE
- *
- *
- * AFTER
- * LOWER_CASE
- *
- *
- *
- *
- * }
- *
- *
+ *
+ * {@code
+ *
+ *
+ *
+ * git.branch
+ * something
+ * ^([^\/]*)\/([^\/]*)$
+ * $1-$2
+ * true
+ * false
+ *
+ *
+ * BEFORE
+ * UPPER_CASE
+ *
+ *
+ * AFTER
+ * LOWER_CASE
+ *
+ *
+ *
+ *
+ * }
*
* @since 2.2.3
*/
- @Parameter
- ListIn general this property can be set to something generic like {@code HEAD^1} or point to a - * branch or tag-name. To support any kind or use-case this configuration can also be set - * to an entire commit-hash or it's abbreviated version.
+ * branch or tag-name. To support any kind or use-case this configuration can also be set to an + * entire commit-hash or it's abbreviated version. * - *A use-case for this feature can be found in - * here.
+ *A use-case for this feature can be found in here. * - *
Please note that for security purposes not all references might - * be allowed as configuration. If you have a specific use-case that is currently - * not white listed feel free to file an issue.
+ *Please note that for security purposes not all references might be allowed as configuration. + * If you have a specific use-case that is currently not white listed feel free to file an issue. * *
By default this property is simply set to {@code HEAD} which should reference to the latest - * commit in your repository.
+ * commit in your repository. * *Example: - *
- * {@code
- * HEAD
- * }
- *
- *
+ *
+ * {@code
+ * HEAD
+ * }
*
* @since 2.2.4
*/
@@ -1016,22 +959,20 @@ public class GitCommitIdMojo extends AbstractMojo {
String evaluateOnCommit;
/**
- * Allow to specify a timeout (in milliseconds) for fetching information with the native
- * Git executable. This option might come in handy in cases where fetching information
- * about the repository with the native Git executable does not terminate.
+ * Allow to specify a timeout (in milliseconds) for fetching information with the native Git
+ * executable. This option might come in handy in cases where fetching information about the
+ * repository with the native Git executable does not terminate.
*
- * Note: This option will only be taken into consideration when using the native git - * executable ({@link #useNativeGit} is set to {@code true}). + *
Note: This option will only be taken into consideration when using the native git executable + * ({@link #useNativeGit} is set to {@code true}). * *
By default this timeout is set to 30000 (30 seconds). * *
Example: - *
- * {@code
- * 30000
- * }
- *
- *
+ *
+ * {@code
+ * 30000
+ * }
*
* @since 3.0.0
*/
@@ -1040,22 +981,20 @@ public class GitCommitIdMojo extends AbstractMojo {
/**
* When set to {@code true} this plugin will try to use the branch name from build environment.
- * Set to {@code false} to use JGit/GIT to get current branch name which can be useful
- * when using the JGitflow maven plugin.
- * See https://github.com/git-commit-id/git-commit-id-maven-plugin/issues/24#issuecomment-203285398
+ * Set to {@code false} to use JGit/GIT to get current branch name which can be useful when using
+ * the JGitflow maven plugin. See
+ * https://github.com/git-commit-id/git-commit-id-maven-plugin/issues/24#issuecomment-203285398
*
- * Note: If not using "Check out to specific local branch' and setting this to false may result in getting
- * detached head state and therefore a commit id as branch name.
+ * Note: If not using "Check out to specific local branch' and setting this to false may result + * in getting detached head state and therefore a commit id as branch name. * - *
By default this is set to {@code true}.
+ *By default this is set to {@code true}. * *
Example: - *
- * {@code
- * true
- * }
- *
- *
+ *
+ * {@code
+ * true
+ * }
*
* @since 3.0.0
*/
@@ -1064,21 +1003,19 @@ public class GitCommitIdMojo extends AbstractMojo {
/**
* Controls if this plugin should expose the generated properties into {@code System.properties}
- * When set to {@code true} this plugin will try to expose the generated properties into
- * {@code System.getProperties()}. Set to {@code false} to avoid this exposure.
+ * When set to {@code true} this plugin will try to expose the generated properties into {@code
+ * System.getProperties()}. Set to {@code false} to avoid this exposure.
*
- * Note that parameters provided via command-line (e.g. {@code -Dgit.commit.id=value}) still
+ * Note that parameters provided via command-line (e.g. {@code -Dgit.commit.id=value}) still * have precedence. * - *
By default this is set to {@code true}.
+ *By default this is set to {@code true}. * *
Example: - *
- * {@code
- * true
- * }
- *
- *
+ *
+ * {@code
+ * true
+ * }
*
* @since 3.0.0
*/
@@ -1086,32 +1023,30 @@ public class GitCommitIdMojo extends AbstractMojo {
boolean injectIntoSysProperties;
/**
- * The plugin can generate certain properties that represents the count of commits
- * that your local branch is ahead or behind in perspective to the remote branch.
+ * The plugin can generate certain properties that represents the count of commits that your local
+ * branch is ahead or behind in perspective to the remote branch.
*
* When your branch is "ahead" it means your local branch has committed changes that are not - * pushed yet to the remote branch. - * When your branch is "behind" it means there are commits in the remote branch that are not yet - * integrated into your local branch.
+ * pushed yet to the remote branch. When your branch is "behind" it means there are commits in the + * remote branch that are not yet integrated into your local branch. * - *This configuration allows you to control if the plugin should somewhat ensure - * that such properties are more accurate. More accurate means that the plugin will perform a - * {@code git fetch} before the properties are calculated. - * Certainly a {@code git fetch} is an operation that may alter your local git repository - * and thus the plugin will operate not perform such operation (offline is set to {@code true}). - * If you however desire more accurate properties you may want to set this to {@code false}.
+ *This configuration allows you to control if the plugin should somewhat ensure that such + * properties are more accurate. More accurate means that the plugin will perform a {@code git + * fetch} before the properties are calculated. Certainly a {@code git fetch} is an operation that + * may alter your local git repository and thus the plugin will operate not perform such operation + * (offline is set to {@code true}). If you however desire more accurate properties you may want + * to set this to {@code false}. * - *
Before version 5.X.X the default was set to {@code false} causing the plugin to operate - * in online-mode by default. Now the default is set to {@code true} (offline-mode) so the plugin might generate - * inaccurate {@code git.local.branch.ahead} and {@code git.local.branch.behind} branch information. + *
Before version 5.X.X the default was set to {@code false} causing the plugin to operate in + * online-mode by default. Now the default is set to {@code true} (offline-mode) so the plugin + * might generate inaccurate {@code git.local.branch.ahead} and {@code git.local.branch.behind} + * branch information. * *
Example: - *
- * {@code
- * true
- * }
- *
- *
+ *
+ * {@code
+ * true
+ * }
*
* @since 3.0.1
*/
@@ -1120,10 +1055,10 @@ public class GitCommitIdMojo extends AbstractMojo {
/**
* Timestamp for reproducible output archive entries
- * (https://maven.apache.org/guides/mini/guide-reproducible-builds.html).
- * The value from ${project.build.outputTimestamp} is either formatted as ISO 8601
- * yyyy-MM-dd'T'HH:mm:ssXXX or as an int representing seconds since the epoch (like
- * SOURCE_DATE_EPOCH.
+ * (https://maven.apache.org/guides/mini/guide-reproducible-builds.html). The value from
+ * ${project.build.outputTimestamp} is either formatted as ISO 8601
+ * yyyy-MM-dd'T'HH:mm:ssXXX or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH.
*
* @since 4.0.2
*/
@@ -1132,17 +1067,14 @@ public class GitCommitIdMojo extends AbstractMojo {
// This is now the end of parameters that can be configured in the pom.xml
// Happy hacking!
- // ============================================================================================================
+ // ===============================================================================================
/**
* Injected {@link BuildContext} to recognize incremental builds.
*/
- @Component
- private BuildContext buildContext;
+ @Component private BuildContext buildContext;
- /**
- * Charset to read-write project sources.
- */
+ /** Charset to read-write project sources. */
private Charset sourceCharset = StandardCharsets.UTF_8;
/**
@@ -1156,53 +1088,54 @@ protected Map${project.build.outputTimestamp} is either formatted as ISO 8601
- * yyyy-MM-dd'T'HH:mm:ssXXX or as an int representing seconds since the epoch (like
- * SOURCE_DATE_EPOCH.
- *
- * Inspired by https://github.com/apache/maven-archiver/blob/a3103d99396cd8d3440b907ef932a33563225265/src/main/java/org/apache/maven/archiver/MavenArchiver.java#L765
- *
- * @param outputTimestamp the value of ${project.build.outputTimestamp} (may be null)
- * @return the parsed timestamp, may be null if null input or input contains only 1
- * character
+ * (https://maven.apache.org/guides/mini/guide-reproducible-builds.html). The value from
+ * ${project.build.outputTimestamp} is either formatted as ISO 8601
+ * yyyy-MM-dd'T'HH:mm:ssXXX or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH.
+ *
+ * Inspired by
+ * https://github.com/apache/maven-archiver/blob/a3103d99396cd8d3440b907ef932a33563225265/src/main/java/org/apache/maven/archiver/MavenArchiver.java#L765
+ *
+ * @param outputTimestamp the value of Note: this will only be appended to the current property key (e.g. when the property
+ * is set to {@code sample} the property {@code git.branch} will be transformed to
+ * {@code git.branch.sample}).
+ *
+ * Be advised that you might want to adjust your include or exclude filters which be
+ * applied after the regex validation.
+ *
+ * @since 2.2.4
*/
- @Parameter
- private String propertyOutputSuffix;
+ @Parameter private String propertyOutputSuffix;
- /**
- * Token to replace.
- * This may or may not be a regular expression.
- */
+ /** Token to replace. This may or may not be a regular expression. */
@Parameter(required = true)
private String token;
/**
- * Value to replace token with.
- * The text to be written over any found tokens.
- * You can also reference grouped regex matches made in the token here by $1, $2, etc.
+ * Value to replace token with. The text to be written over any found tokens. You can also
+ * reference grouped regex matches made in the token here by $1, $2, etc.
*/
@Parameter(defaultValue = "")
private String value = "";
- /**
- * Indicates if the token should be located with regular expressions.
- */
+ /** Indicates if the token should be located with regular expressions. */
@Parameter(defaultValue = "true")
private boolean regex = true;
/**
- * Forces the plugin to evaluate the value on *every* project.
- * Note that this essentially means that the plugin *must* run for every child-project of a reactor
- * build and thus might cause some overhead (the git properties should be cached).
+ * Forces the plugin to evaluate the value on *every* project. Note that this essentially means
+ * that the plugin *must* run for every child-project of a reactor build and thus might cause some
+ * overhead (the git properties should be cached).
*
- * For a use-case refer to https://github.com/git-commit-id/git-commit-id-maven-plugin/issues/457.
+ * For a use-case refer to
+ * https://github.com/git-commit-id/git-commit-id-maven-plugin/issues/457.
*/
@Parameter(defaultValue = "false")
private boolean forceValueEvaluation = false;
/**
+ * Provides the ability to perform certain string transformations before regex
+ * evaluation or after.
+ *
* @since 2.2.4
- * Provides the ability to perform certain string transformations before regex evaluation or after.
*/
- @Parameter
- private List Each {@code transformationRule} consist of two required fields {@code apply} and {@code
+ * action}.
+ * The {@code apply}-tag controls when the rule should be applied and can be set to {@link
+ * ApplyEnum#BEFORE} to have the rule being applied before or it can be set to
+ * {@link ApplyEnum#AFTER} to have the rule being applied after the replacement.
* The {@code action}-tag determines the string conversion rule that should be applied.
*
- * Refer to https://github.com/git-commit-id/git-commit-id-maven-plugin/issues/317 for a use-case.
+ * Refer to https://github.com/git-commit-id/git-commit-id-maven-plugin/issues/317 for a
+ * use-case.
*/
public class TransformationRule {
/**
- * Determines when the transformation should be taken place.
- * Currently supported is
- * - BEFORE_REGEX
- * - AFTER_REGEX
+ * Determines when the transformation should be taken place. Currently supported is - BEFORE_REGEX
+ * - AFTER_REGEX
*/
@Parameter(required = true)
private String apply;
private ApplyEnum applyRule;
+ /**
+ * Each {@code transformationRule} consist of two required fields {@code apply} and {@code
+ * action}.
+ * The {@code apply}-tag controls when the rule should be applied and can be set to {@link
+ * ApplyEnum#BEFORE} to have the rule being applied before or it can be set to
+ * {@link ApplyEnum#AFTER} to have the rule being applied after the replacement.
+ */
protected enum ApplyEnum {
- /**
- * have the rule being applied before the replacement
- */
+ /** have the rule being applied before the replacement. */
BEFORE,
- /**
- * have the rule being applied after the replacement
- */
+ /** have the rule being applied after the replacement. */
AFTER,
;
}
/**
- * Determines the action that should be performed as transformation.
- * Currently supported is
- * - LOWER_CASE
- * - UPPER_CASE
+ * Determines the action that should be performed as transformation. Currently supported is -
+ * LOWER_CASE - UPPER_CASE
*/
@Parameter(required = true)
private String action;
private ActionEnum actionRule;
+ /**
+ * Each {@code transformationRule} consist of two required fields {@code apply} and {@code
+ * action}.
+ * The {@code action}-tag determines the string conversion rule that should be applied.
+ */
protected enum ActionEnum {
LOWER_CASE {
@Override
@@ -86,11 +92,11 @@ protected String perform(String input) {
}
},
;
+
protected abstract String perform(String input);
}
- public TransformationRule() {
- }
+ public TransformationRule() {}
public TransformationRule(String apply, String action) {
this(ApplyEnum.valueOf(apply), ActionEnum.valueOf(action));
@@ -114,7 +120,8 @@ public void setApply(String apply) {
public ApplyEnum getApplyRule() {
if (applyRule == null) {
- throw new IllegalStateException("The parameter 'apply' for TransformationRule is missing or invalid");
+ throw new IllegalStateException(
+ "The parameter 'apply' for TransformationRule is missing or invalid");
}
return applyRule;
}
@@ -130,7 +137,8 @@ public void setAction(String action) {
public ActionEnum getActionRule() {
if (actionRule == null) {
- throw new IllegalStateException("The parameter 'action' for TransformationRule is missing or invalid");
+ throw new IllegalStateException(
+ "The parameter 'action' for TransformationRule is missing or invalid");
}
return actionRule;
}
diff --git a/src/main/java/pl/project13/maven/validation/ValidationMojo.java b/src/main/java/pl/project13/maven/validation/ValidationMojo.java
index 6e80a4cb..46e1dfb3 100644
--- a/src/main/java/pl/project13/maven/validation/ValidationMojo.java
+++ b/src/main/java/pl/project13/maven/validation/ValidationMojo.java
@@ -1,5 +1,6 @@
/*
- * This file is part of git-commit-id-maven-plugin by Konrad 'ktoso' Malawski
+ * Each validation you may want to perform can be configured using a {@link ValidationProperty}.
+ *
+ * Note: This configuration will only be taken into account when the additional goal
+ * `validateRevision` is configured inside an execution like so
+ * Konrad Malawski Konrad Malawski Konrad Malawski Konrad Malawski The test case will still finish successfully because all git-related errors are cught in.
*
* @author eternach
- *
*/
@RunWith(JUnitParamsRunner.class)
public class BigDiffTest extends GitIntegrationTest {
@@ -46,7 +45,8 @@ public class BigDiffTest extends GitIntegrationTest {
// @Ignore("Run this to simulate hanging native-git-process for repo-state with lots of changes")
public void bigDiff() throws Exception {
// given
- mavenSandbox.withParentProject("my-pom-project", "pom")
+ mavenSandbox
+ .withParentProject("my-pom-project", "pom")
.withChildProject("my-jar-module", "jar")
.withGitRepoInChild(AvailableGitTestRepo.MAVEN_GIT_COMMIT_ID_PLUGIN)
.create();
@@ -62,7 +62,10 @@ public void bigDiff() throws Exception {
mojo.gitDescribe = gitDescribeConfig;
for (int i = 0; i < 100000; i++) {
- final Path path = Paths.get(mavenSandbox.getChildProject().getBasedir().toString(), "very-long-file-name-with-id-" + Integer.toString(i) + ".txt");
+ final Path path =
+ Paths.get(
+ mavenSandbox.getChildProject().getBasedir().toString(),
+ "very-long-file-name-with-id-" + Integer.toString(i) + ".txt");
final byte[] bytes = "for performance test\n".getBytes();
Files.createFile(path);
try (FileOutputStream fos = new FileOutputStream(path.toFile())) {
@@ -77,8 +80,7 @@ public void bigDiff() throws Exception {
mojo.execute();
final long estimatedTime = System.currentTimeMillis() - startTime;
- System.out.println(
- "[***] time: " + (double) estimatedTime + " ms");
+ System.out.println("[***] time: " + (double) estimatedTime + " ms");
// then
assertGitPropertiesPresentInProject(targetProject.getProperties());
@@ -101,7 +103,8 @@ private void assertGitPropertiesPresentInProject(final Properties properties) {
assertThat(properties).satisfies(new ContainsKeyCondition("git.remote.origin.url"));
}
- private GitDescribeConfig createGitDescribeConfig(final boolean forceLongFormat, final int abbrev) {
+ private GitDescribeConfig createGitDescribeConfig(
+ final boolean forceLongFormat, final int abbrev) {
final GitDescribeConfig gitDescribeConfig = new GitDescribeConfig();
gitDescribeConfig.setTags(true);
gitDescribeConfig.setForceLongFormat(forceLongFormat);
diff --git a/src/test/java/pl/project13/maven/git/ContainsKeyCondition.java b/src/test/java/pl/project13/maven/git/ContainsKeyCondition.java
index c4a8deea..e172a9f2 100644
--- a/src/test/java/pl/project13/maven/git/ContainsKeyCondition.java
+++ b/src/test/java/pl/project13/maven/git/ContainsKeyCondition.java
@@ -1,5 +1,6 @@
/*
- * This file is part of git-commit-id-maven-plugin by Konrad 'ktoso' Malawski Konrad Malawski
- * Notice that git will not use less than 4 chars for the abbrev, and in large repositories,
- * it will use the abbrev so long that it's guaranteed to be unique.
- * Notice that git will not use less than 4 chars for the abbrev, and in large repositories, it
+ * will use the abbrev so long that it's guaranteed to be unique.
*/
@Test
public void shouldGiveTheCommitIdAndDirtyMarkerWhenNothingElseCanBeFound() throws Exception {
@@ -69,10 +71,11 @@ public void shouldGiveTheCommitIdAndDirtyMarkerWhenNothingElseCanBeFound() throw
.withGitRepoInParent(AvailableGitTestRepo.WITH_LIGHTWEIGHT_TAG_BEFORE_ANNOTATED_TAG)
.create();
- try (final Git git = git(); final Repository repo = git.getRepository()) {
+ try (final Git git = git();
+ final Repository repo = git.getRepository()) {
// when
- DescribeResult res = DescribeCommand
- .on(evaluateOnCommit, repo, new DummyTestLoggerBridge())
+ DescribeResult res =
+ DescribeCommand.on(evaluateOnCommit, repo, new DummyTestLoggerBridge())
.abbrev(2) // 2 is enough to be unique in this small repo
.call();
@@ -85,7 +88,8 @@ public void shouldGiveTheCommitIdAndDirtyMarkerWhenNothingElseCanBeFound() throw
}
@Test
- public void onGitCommitIdsRepo_shouldNoticeThat2CharsIsTooLittleToBeUniqueAndUse4CharsInstead() throws Exception {
+ public void onGitCommitIdsRepo_shouldNoticeThat2CharsIsTooLittleToBeUniqueAndUse4CharsInstead()
+ throws Exception {
// given
mavenSandbox
.withParentProject(PROJECT_NAME, "jar")
@@ -93,10 +97,11 @@ public void onGitCommitIdsRepo_shouldNoticeThat2CharsIsTooLittleToBeUniqueAndUse
.withGitRepoInParent(AvailableGitTestRepo.GIT_COMMIT_ID)
.create();
- try (final Git git = git(); final Repository repo = git.getRepository()) {
+ try (final Git git = git();
+ final Repository repo = git.getRepository()) {
// when
- DescribeResult res = DescribeCommand
- .on(evaluateOnCommit, repo, new DummyTestLoggerBridge())
+ DescribeResult res =
+ DescribeCommand.on(evaluateOnCommit, repo, new DummyTestLoggerBridge())
.abbrev(2) // way too small to be unique in git-commit-id's repo!
.call();
diff --git a/src/test/java/pl/project13/maven/jgit/DescribeCommandTagsIntegrationTest.java b/src/test/java/pl/project13/maven/jgit/DescribeCommandTagsIntegrationTest.java
index e49c85a9..d50588c3 100644
--- a/src/test/java/pl/project13/maven/jgit/DescribeCommandTagsIntegrationTest.java
+++ b/src/test/java/pl/project13/maven/jgit/DescribeCommandTagsIntegrationTest.java
@@ -1,5 +1,6 @@
/*
- * This file is part of git-commit-id-maven-plugin by Konrad 'ktoso' Malawski Konrad Malawski${project.build.outputTimestamp} (may be
+ * null)
+ * @return the parsed timestamp, may be null if null input or input
+ * contains only 1 character
*/
private Date parseOutputTimestamp(String outputTimestamp) throws GitCommitIdExecutionException {
- if (outputTimestamp != null && !outputTimestamp.trim().isEmpty() && outputTimestamp.chars().allMatch(Character::isDigit)) {
+ if (outputTimestamp != null
+ && !outputTimestamp.trim().isEmpty()
+ && outputTimestamp.chars().allMatch(Character::isDigit)) {
return new Date(Long.parseLong(outputTimestamp) * 1000);
}
@@ -1509,8 +1466,7 @@ private Date parseOutputTimestamp(String outputTimestamp) throws GitCommitIdExec
return df.parse(outputTimestamp);
} catch (ParseException pe) {
throw new GitCommitIdExecutionException(
- "Invalid 'project.build.outputTimestamp' value '" + outputTimestamp + "'",
- pe);
+ "Invalid 'project.build.outputTimestamp' value '" + outputTimestamp + "'", pe);
}
}
@@ -1531,8 +1487,8 @@ private void appendPropertiesToReactorProjects(LogInterface log, Properties prop
}
/**
- * Find the git directory of the currently used project.
- * If it's not already specified, this method will try to find it.
+ * Find the git directory of the currently used project. If it's not already specified, this
+ * method will try to find it.
*
* @return the File representation of the .git directory
*/
diff --git a/src/main/java/pl/project13/maven/git/GitDirLocator.java b/src/main/java/pl/project13/maven/git/GitDirLocator.java
index c8cb62ba..4926ab61 100644
--- a/src/main/java/pl/project13/maven/git/GitDirLocator.java
+++ b/src/main/java/pl/project13/maven/git/GitDirLocator.java
@@ -1,5 +1,6 @@
/*
- * This file is part of git-commit-id-maven-plugin by Konrad 'ktoso' Malawski {@code
+ *
+ *
* @since 2.2.2
*/
@Mojo(name = "validateRevision", defaultPhase = LifecyclePhase.VERIFY, threadSafe = true)
@@ -35,13 +60,12 @@ public class ValidationMojo extends AbstractMojo {
@Parameter(defaultValue = "true")
private boolean validationShouldFailIfNoMatch;
- @Parameter
- private List{@code
+ *
+ */
public class ValidationProperty {
private String name;
private String value;
private String shouldMatchTo;
- public ValidationProperty() {
- }
+ public ValidationProperty() {}
ValidationProperty(String name, String value, String shouldMatchTo) {
this.name = name;
@@ -32,26 +45,52 @@ public ValidationProperty() {
this.shouldMatchTo = shouldMatchTo;
}
+ /**
+ * Sets a descriptive name that will be used to be able to identify the validation that
+ * does not match up (will be displayed in the error message).
+ *
+ * @param name The name that shall be used to identify the validation
+ */
public void setName(String name) {
this.name = name;
}
+ /**
+ * Sets the value that needs to be validated.
+ *
+ * @param value The value that needs to be validated.
+ */
public void setValue(String value) {
this.value = value;
}
+ /**
+ * Sets the expectation what the given value should match to.
+ *
+ * @param shouldMatchTo The expectation what the given value should match to.
+ */
public void setShouldMatchTo(String shouldMatchTo) {
this.shouldMatchTo = shouldMatchTo;
}
+ /**
+ * @return A descriptive name that will be used to be able to identify the validation that
+ * does not match up (will be displayed in the error message).
+ */
public String getName() {
return name;
}
+ /**
+ * @return The value that needs to be validated.
+ */
public String getValue() {
return value;
}
+ /**
+ * @return The expectation what the given value should match to.
+ */
public String getShouldMatchTo() {
return shouldMatchTo;
}
diff --git a/src/test/java/pl/project13/core/jgit/DescribeCommandIntegrationTest.java b/src/test/java/pl/project13/core/jgit/DescribeCommandIntegrationTest.java
index d1847f54..1eb0153d 100644
--- a/src/test/java/pl/project13/core/jgit/DescribeCommandIntegrationTest.java
+++ b/src/test/java/pl/project13/core/jgit/DescribeCommandIntegrationTest.java
@@ -1,5 +1,6 @@
/*
- * This file is part of git-commit-id-maven-plugin by Konrad 'ktoso' Malawski
* $ lg
* * b6a73ed - (HEAD, master) third addition (32 hours ago)
*
* Where the newest-tag was created latest:
+ *
*
* $ tag -v newest-tag
* object d37a598a7a98531ad1375966642c6b1263129436
@@ -50,14 +56,19 @@ public enum AvailableGitTestRepo {
ON_A_TAG_DIRTY("src/test/resources/_git_on_a_tag_dirty"),
WITH_SUBMODULES("src/test/resources/_git_with_submodules"),
/**
+ *
+ *
*
* b6a73ed - (HEAD, master) third addition (4 minutes ago)
*/
- WITH_LIGHTWEIGHT_TAG_BEFORE_ANNOTATED_TAG("src/test/resources/_git_lightweight_tag_before_annotated_tag"),
+ WITH_LIGHTWEIGHT_TAG_BEFORE_ANNOTATED_TAG(
+ "src/test/resources/_git_lightweight_tag_before_annotated_tag"),
/**
+ *
+ *
*
* * 9cb810e - Change in tag - Fri, 29 Nov 2013 10:39:31 +0100 (tag: test_tag, branch: test)
* | * 2343428 - Moved master - Fri, 29 Nov 2013 10:38:34 +0100 (HEAD, branch: master)
@@ -68,16 +79,18 @@ public enum AvailableGitTestRepo {
WITH_TAG_ON_DIFFERENT_BRANCH("src/test/resources/_git_with_tag_on_different_branch"),
WITH_ONE_COMMIT_WITH_SPECIAL_CHARACTERS("src/test/resources/_git_one_commit_with_umlaut"),
/**
- *
- * b0c6d28b3b83bf7b905321bae67d9ca4c75a203f 2015-06-04 00:50:18 +0200 (HEAD, master)
- * 0e3495783c56589213ee5f2ae8900e2dc1b776c4 2015-06-03 23:59:10 +0200 (tag: v2.0)
- * f830b5f85cad3d33ba50d04c3d1454e1ae469057 2015-06-03 23:57:53 +0200 (tag: v1.0)
- *
- */
- WITH_THREE_COMMITS_AND_TWO_TAGS_CURRENTLY_ON_COMMIT_WITHOUT_TAG("src/test/resources/_git_three_commits_and_two_tags_currently_on_commit_without_tag"),
+ *
+ *
+ *
+ * b0c6d28b3b83bf7b905321bae67d9ca4c75a203f 2015-06-04 00:50:18 +0200 (HEAD, master)
+ * 0e3495783c56589213ee5f2ae8900e2dc1b776c4 2015-06-03 23:59:10 +0200 (tag: v2.0)
+ * f830b5f85cad3d33ba50d04c3d1454e1ae469057 2015-06-03 23:57:53 +0200 (tag: v1.0)
+ *
+ */
+ WITH_THREE_COMMITS_AND_TWO_TAGS_CURRENTLY_ON_COMMIT_WITHOUT_TAG(
+ "src/test/resources/_git_three_commits_and_two_tags_currently_on_commit_without_tag"),
// TODO: Why do the tests get stuck when we use .git??
- MAVEN_GIT_COMMIT_ID_PLUGIN("src/test/resources/_git_one_commit_with_umlaut")
- ;
+ MAVEN_GIT_COMMIT_ID_PLUGIN("src/test/resources/_git_one_commit_with_umlaut");
private String dir;
diff --git a/src/test/java/pl/project13/maven/git/BigDiffTest.java b/src/test/java/pl/project13/maven/git/BigDiffTest.java
index ec1880b1..b06d2318 100644
--- a/src/test/java/pl/project13/maven/git/BigDiffTest.java
+++ b/src/test/java/pl/project13/maven/git/BigDiffTest.java
@@ -1,5 +1,6 @@
/*
- * This file is part of git-commit-id-maven-plugin by Konrad 'ktoso' Malawski
* master!tag-test$ lg
* b6a73ed - (HEAD, master) third addition (8 hours ago)
*
- *
* $ lg
* * b6a73ed - (HEAD, master) third addition (32 hours ago)