Update dependency pl.project13.maven:git-commit-id-plugin to v4 #7
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR contains the following updates:
2.2.1
->4.9.10
Release Notes
git-commit-id/git-commit-id-maven-plugin
v4.9.10
: Version 4.9.10 (The continued relocation saga)Compare Source
Where should I start....this release should not exists.
Ideally the entire 4.9.9 "relocation" release was just intended to inform that the plugin moved to a new artifactId/groupId combination.
As outlined in https://github.com/git-commit-id/git-commit-id-maven-plugin/issues/571 or https://issues.apache.org/jira/browse/MNG-7204 there seems to be a problem where Maven will not forward the correct settings when you use the old coordinates with the 4.9.9 version.
Since the 4.9.9 release contains relocation information it essentially became unusable triggering this "fix".
Please note that the plugin is still moving to it's new coordinates.
This 4.9.10 release is just a follow up to avoid any silent configuration issues being present somewhere....
TLDR:
If you can use:
v4.9.9
: Version 4.9.9 (Relocation Release)Compare Source
This is a special release and should function in the same way as v4.0.5.
Initially this release was just intended to inform that the plugin moved to a new artifactId/groupId combination, but to avoid having published a release that might be considered broken I decided to just "fix" it.
Currently the 4.9.9 release works only when using the new coordinates
v4.0.5
: Version 4.0.5Compare Source
Version 4.0.5 is finally there and includes various bug-fixes and improvements :-)
New Features / Bug-Fixes:
The main key-aspects that have been improved or being worked on are the following:
Getting the latest release
The plugin is available from Maven Central (see here), so you don't have to configure any additional repositories to use this plugin. All you need to do is to configure it inside your project as dependency:
Getting the latest snapshot (build automatically)
If you can't wait for the next release, you can also get the latest snapshot version from sonatype, that is being deployed automatically by travis:
Even though travis will only deploy a new snapshot once all tests have finished, it is recommended to rely on the released and more stable version.
Known Issues / Limitations:
mvn com.test.plugins:myPlugin:myMojo
) might result in unresolved properties even with<injectAllReactorProjects>true</injectAllReactorProjects>
. Please refer to https://github.com/git-commit-id/maven-git-commit-id-plugin/issues/287 or https://github.com/git-commit-id/maven-git-commit-id-plugin/issues/413#issuecomment-487952607 for details and potential workaroundsReporting Problems
If you find any problem with this plugin, feel free to report it here
v4.0.4
: Version 4.0.4Compare Source
Version 4.0.4 is finally there and includes various bug-fixes and improvements :-)
New Features / Bug-Fixes:
The main key-aspects that have been improved or being worked on are the following:
NullPointerException
whensession.getProjectDependencyGraph()
might benull
when running the plugin from eclipsegit.commit.author.time
,git.commit.committer.time
)Getting the latest release
The plugin is available from Maven Central (see here), so you don't have to configure any additional repositories to use this plugin. All you need to do is to configure it inside your project as dependency:
Getting the latest snapshot (build automatically)
If you can't wait for the next release, you can also get the latest snapshot version from sonatype, that is being deployed automatically by travis:
Even though travis will only deploy a new snapshot once all tests have finished, it is recommended to rely on the released and more stable version.
Known Issues / Limitations:
mvn com.test.plugins:myPlugin:myMojo
) might result in unresolved properties even with<injectAllReactorProjects>true</injectAllReactorProjects>
. Please refer to https://github.com/git-commit-id/maven-git-commit-id-plugin/issues/287 or https://github.com/git-commit-id/maven-git-commit-id-plugin/issues/413#issuecomment-487952607 for details and potential workaroundsReporting Problems
If you find any problem with this plugin, feel free to report it here
v4.0.3
: Version 4.0.3Compare Source
Version 4.0.3 is finally there and includes various bug-fixes and improvements :-)
New Features / Bug-Fixes:
The main key-aspects that have been improved or being worked on are the following:
Getting the latest release
The plugin is available from Maven Central (see here), so you don't have to configure any additional repositories to use this plugin. All you need to do is to configure it inside your project as dependency:
Getting the latest snapshot (build automatically)
If you can't wait for the next release, you can also get the latest snapshot version from sonatype, that is being deployed automatically by travis:
Even though travis will only deploy a new snapshot once all tests have finished, it is recommended to rely on the released and more stable version.
Known Issues / Limitations:
mvn com.test.plugins:myPlugin:myMojo
) might result in unresolved properties even with<injectAllReactorProjects>true</injectAllReactorProjects>
. Please refer to https://github.com/git-commit-id/maven-git-commit-id-plugin/issues/287 or https://github.com/git-commit-id/maven-git-commit-id-plugin/issues/413#issuecomment-487952607 for details and potential workaroundsReporting Problems
If you find any problem with this plugin, feel free to report it here
v4.0.2
: Version 4.0.2Compare Source
Version 4.0.2 is finally there and includes various bug-fixes and improvements :-)
New Features / Bug-Fixes:
The main key-aspects that have been improved or being worked on are the following:
injectAllReactorProjects
git.build.time
fromproject.build.outputTimestamp
to support reproducible buildsjgit 5.8.1.202007141445-r
,jackson-databind 2.11.2
,joda-time 2.10.6
Getting the latest release
The plugin is available from Maven Central (see here), so you don't have to configure any additional repositories to use this plugin. All you need to do is to configure it inside your project as dependency:
Getting the latest snapshot (build automatically)
If you can't wait for the next release, you can also get the latest snapshot version from sonatype, that is being deployed automatically by travis:
Even though travis will only deploy a new snapshot once all tests have finished, it is recommended to rely on the released and more stable version.
Known Issues / Limitations:
mvn com.test.plugins:myPlugin:myMojo
) might result in unresolved properties even with<injectAllReactorProjects>true</injectAllReactorProjects>
. Please refer to https://github.com/git-commit-id/maven-git-commit-id-plugin/issues/287 or https://github.com/git-commit-id/maven-git-commit-id-plugin/issues/413#issuecomment-487952607 for details and potential workaroundsReporting Problems
If you find any problem with this plugin, feel free to report it here
v4.0.1
: Version 4.0.1Compare Source
Version 4.0.1 is finally there and includes various bug-fixes and improvements :-)
New Features / Bug-Fixes:
The main key-aspects that have been improved or being worked on are the following:
git.branch
andgit.build.number
for GitHub ActionsforceValueEvaluation
-switch to thereplacementProperty
to tell the plugin that the value needs to be regenerated for every project. Note that this will make the plugin run for every project (e.g. which might be needed for sonar that requires unique keys for the sonar)https://:@​git.server.com/pathToRepo.git
)git.branch
andgit.build.number
for AWS CodeBuildGetting the latest release
The plugin is available from Maven Central (see here), so you don't have to configure any additional repositories to use this plugin. All you need to do is to configure it inside your project as dependency:
Getting the latest snapshot (build automatically)
If you can't wait for the next release, you can also get the latest snapshot version from sonatype, that is being deployed automatically by travis:
Even though travis will only deploy a new snapshot once all tests have finished, it is recommended to rely on the released and more stable version.
Known Issues / Limitations:
mvn com.test.plugins:myPlugin:myMojo
) might result in unresolved properties even with<injectAllReactorProjects>true</injectAllReactorProjects>
. Please refer to https://github.com/git-commit-id/maven-git-commit-id-plugin/issues/287 or https://github.com/git-commit-id/maven-git-commit-id-plugin/issues/413#issuecomment-487952607 for details and potential workaroundsReporting Problems
If you find any problem with this plugin, feel free to report it here
v4.0.0
: Version 4.0.0Compare Source
Version 4.0.0 is finally there and includes various bug-fixes, improvements and some changes that can be considered as potential breaking changes :-)
The main key-aspects that have been improved or being worked on are the following:
Potential breaking changes:
maven
and acore
-project) -- https://github.com/git-commit-id/maven-git-commit-id-plugin/pull/441 (initial idea https://github.com/git-commit-id/maven-git-commit-id-plugin/issues/228)runOnlyOnce
coupled with Maven's--projects
parameter makes plugin not run at all -- https://github.com/git-commit-id/maven-git-commit-id-plugin/issues/387, https://github.com/git-commit-id/maven-git-commit-id-plugin/pull/443New Features / Bug-Fixes:
injectAllReactorProjects
slightly less verbose -- https://github.com/git-commit-id/maven-git-commit-id-plugin/pull/431useNativeGit
from command line via-Dmaven.gitcommitid.nativegit=true
-- https://github.com/git-commit-id/maven-git-commit-id-plugin/pull/433git.branch
andgit.build.number
for Azure DevOps -- https://github.com/git-commit-id/maven-git-commit-id-plugin/pull/439git.branch
andgit.build.number
for CircleCI -- https://github.com/git-commit-id/maven-git-commit-id-plugin/pull/449git.branch
in sonar's project version:See https://github.com/git-commit-id/maven-git-commit-id-plugin/pull/444 for further details.
Getting the latest release
The plugin is available from Maven Central (see here), so you don't have to configure any additional repositories to use this plugin. All you need to do is to configure it inside your project as dependency:
Getting the latest snapshot (build automatically)
If you can't wait for the next release, you can also get the latest snapshot version from sonatype, that is being deployed automatically by travis:
Even though travis will only deploy a new snapshot once all tests have finished, it is recommended to rely on the released and more stable version.
Known Issues / Limitations:
mvn com.test.plugins:myPlugin:myMojo
) might result in unresolved properties even with<injectAllReactorProjects>true</injectAllReactorProjects>
. Please refer to https://github.com/git-commit-id/maven-git-commit-id-plugin/issues/287 or https://github.com/git-commit-id/maven-git-commit-id-plugin/issues/413#issuecomment-487952607 for details and potential workaroundsorg.eclipse.jgit.api.errors.TransportException: USERAUTH fail
under java 13 (I can't reproduce the issue), however a workaround would be specifying<offline>true</offline>
or using the native git implementation with<useNativeGit>true</useNativeGit>
.Reporting Problems
If you find any problem with this plugin, feel free to report it here
v3.0.1
: Version 3.0.1Compare Source
Version 3.0.1 is finally there and includes various bug-fixes and improvements :-)
New Features / Bug-Fixes:
The main key-aspects that have been improved or being worked on are the following:
git fetch
operation to determine the propertiesgit.local.branch.ahead
andgit.local.branch.behind
. If the plugin is operating in 'offline' mode both those properties will only reflect the view of the local clone and thus might be off from the actual repository. Note this 'offline' mode is also respected when one set's the maven "-o" offline switch).org.apache.httpcomponents:httpclient
dependency -- https://github.com/git-commit-id/maven-git-commit-id-plugin/pull/425git.build.time
since theTimeZone.getTimeZone()
may also have an impact upon performance -- https://github.com/git-commit-id/maven-git-commit-id-plugin/pull/428.injectAllReactorProjects
-- https://github.com/git-commit-id/maven-git-commit-id-plugin/pull/429.Getting the latest release
The plugin is available from Maven Central (see here), so you don't have to configure any additional repositories to use this plugin. All you need to do is to configure it inside your project as dependency:
Getting the latest snapshot (build automatically)
If you can't wait for the next release, you can also get the latest snapshot version from sonatype, that is being deployed automatically by travis:
Even though travis will only deploy a new snapshot once all tests have finished, it is recommended to rely on the released and more stable version.
Known Issues / Limitations:
mvn com.test.plugins:myPlugin:myMojo
) might result in unresolved properties even with<injectAllReactorProjects>true</injectAllReactorProjects>
. Please refer to https://github.com/git-commit-id/maven-git-commit-id-plugin/issues/287 or https://github.com/git-commit-id/maven-git-commit-id-plugin/issues/413#issuecomment-487952607 for details and potential workaroundsReporting Problems
If you find any problem with this plugin, feel free to report it here
v3.0.0
: Version 3.0.0Compare Source
Version 3.0.0 is finally there and includes various bug-fixes and improvements :-)
New Features / Bug-Fixes:
The main key-aspects that have been improved or being worked on are the following:
<useBranchNameFromBuildEnvironment>false</useBranchNameFromBuildEnvironment>
). This behaviour might be useful in combination with the JGitflow maven plugin #393.git-commit-id
organization account #384git.local.branch.ahead
andgit.local.branch.behind
that provide some information if the local branch is either ahead or behind the remote. Note that using this property will perform agit fetch
operation and may have a performance impact on the overall execution of the plugin. #395git fetch
operation performed when gathering the propertiesgit.local.branch.ahead
andgit.local.branch.behind
simply exclude those to avoid that step:evaluateOnCommit
to anything besides the defaultHEAD
resulted only in the commit-id. in case users want toevaluateOnCommit
on any commit or branch that is not the defaultHEAD
, please be advised that this plugin will rungit branch --points-at
that may or may not result in agit.branch
property that has multiple branches that are comma separated. IfevaluateOnCommit
is kept as the defaultHEAD
thegit.branch
property still may fallback to the commit-id. #403injectAllReactorProjects
to true for multi-modules project now stores the computed properties in the project context. If the properties are present in the project context this plugin will essentially reuse those properties from a previously computed version (kudus to https://github.com/git-commit-id/maven-git-commit-id-plugin/pull/411, implemented in https://github.com/git-commit-id/maven-git-commit-id-plugin/pull/414)Getting the latest release
The plugin is available from Maven Central (see here), so you don't have to configure any additional repositories to use this plugin. All you need to do is to configure it inside your project as dependency:
Getting the latest snapshot (build automatically)
If you can't wait for the next release, you can also get the latest snapshot version from sonatype, that is being deployed automatically by travis:
Even though travis will only deploy a new snapshot once all tests have finished, it is recommended to rely on the released and more stable version.
Known Issues / Limitations:
mvn com.test.plugins:myPlugin:myMojo
) might result in unresolved properties even with<injectAllReactorProjects>true</injectAllReactorProjects>
. Please refer to https://github.com/git-commit-id/maven-git-commit-id-plugin/issues/287 or https://github.com/git-commit-id/maven-git-commit-id-plugin/issues/413#issuecomment-487952607 for details and potential workaroundsReporting Problems
If you find any problem with this plugin, feel free to report it here
v2.2.6
: Version 2.2.6Compare Source
Version 2.2.6 is a security update for a potential issue within the jackson-databind dependency. As usual you can checkout the detailed list of bug-fixes :-)
New Features / Bug-Fixes:
The main key-aspects is a security update for a potential issue within the jackson-databind dependency. This specific dependency was updated to v2.9.8 in response to https://github.com/FasterXML/jackson-databind/issues/2186 (CVE-2018-19360, CVE-2018-19361, CVE-2018-19362). Even though by default an user of this plugin does not seem to be affected by this potential issue, it is highly recommended to adopt the latest version at your earliest convenience. Similar to version 2.2.5 this version provides full support for Java 7, Java 8, Java 9, Java 10 and Java 11 (and is potentially also working for any higher version).
Am I affected? (technical details)
The specific issues that have been fixed with the update of jackson-databind dependency are:
This plugin uses the jackson-databind dependency for dumping the git information (serialization) to the generated properties file and determining if the generated json properties are up-to-date (deserialization). As of now it appears that only user who generate json properties via
<format>json</format>
may be affected by those issues. This specific configuration is set to<format>properties</format>
by default and hence by default it appears that those issues are out of scope. Only when this configuration is altered a user may need to consider the linked CVE's as potential security problem.In general I would be unsure if this ever even could be considered a true attack vector of this plugin, since the generated json file would need to contain data that would trigger this specific bug in the dependency. If an adversary has access to the content to the location where the generated file is residing, I would assume he can also modify the any local file (including project files) and hence would not need to go through the pain and exploit this problem....
Getting the latest release
The plugin is available from Maven Central (see here), so you don't have to configure any additional repositories to use this plugin. All you need to do is to configure it inside your project as dependency:
Known Issues / Limitations:
Reporting Problems
If you find any problem with this plugin, feel free to report it here
v2.2.5
: Version 2.2.5Compare Source
Version 2.2.5 is finally there and includes various bug-fixes and improvements :-)
New Features / Bug-Fixes:
The main key-aspects that have been improved or being worked on are the following:
git.build.number
andgit.build.number.unique
) for Bamboo, Hudson, Jenkins, TeamCity, Travis, Gitlab CI - https://github.com/ktoso/maven-git-commit-id-plugin/issues/353 / https://github.com/ktoso/maven-git-commit-id-plugin/pull/369git.branch
support for GitlabCI - https://github.com/ktoso/maven-git-commit-id-plugin/pull/368Getting the latest release
The plugin is available from Maven Central (see here), so you don't have to configure any additional repositories to use this plugin. All you need to do is to configure it inside your project as dependency:
Known Issues / Limitations:
Reporting Problems
If you find any problem with this plugin, feel free to report it here
v2.2.4
: Version 2.2.4Compare Source
Version 2.2.4 is finally there and includes various bug-fixes and improvements :-)
New Features / Bug-Fixes:
The main key-aspects that have been improved or being worked on are the following:
-Dmaven.gitcommitid.skip=true
does not skip the plugin execution when the configuration in the POM includes a<skip>false</skip>
- https://github.com/ktoso/maven-git-commit-id-plugin/issues/315transformationRules
for the property where those rules should take effect. EachtransformationRule
consist of two required fieldsapply
andaction
. Theapply
-tag controls when the rule should be applied and can be set toBEFORE
to have the rule being applied before or it can be set toAFTER
to have the rule being applied after the replacement. Theaction
-tag determines the string conversion rule that should be applied. Currenlty supported isLOWER_CASE
andUPPER_CASE
. Potential candidates in the feature areCAPITALIZATION
andINVERT_CASE
(open a ticket if you need them...).See https://github.com/ktoso/maven-git-commit-id-plugin/issues/317 for more details on a use-case.
mvn clean verify -Pcheckstyle -Dmaven.test.skip=true -B
for java 7 and java 8. For java9 one may want to runmvn clean verify -Pcheckstyle -Dcheckstyle.version=8.2 -Dmaven.test.skip=true -B
that uses a more recent checkstyle version. Feel free to check out our FAQ-Section in the Readme that contains a small write up on how you can integrate checkstyle into your IDE.git.closest.tag.name
andgit.closest.tag.count
now will be determined based on properties configured inside the git-describe command (https://github.com/ktoso/maven-git-commit-id-plugin/issues/221). Example:will cause that lightweight tags are also included for the closest tags
Also the
pattern
used inside the gitDescribe might have an impact on the resultinggit.closest.tag.name
andgit.closest.tag.count
git.tags
property (basically it wasn't reporting all tags of a given commit) - https://github.com/ktoso/maven-git-commit-id-plugin/issues/339HEAD
which should reference to the latest commit in your repository. In general this property can be set to something generic likeHEAD^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. Please note that for security purposes not all references might be allowed as configuration.The configuration can be used in the following:
Getting the latest release
The plugin is available from Maven Central (see here), so you don't have to configure any additional repositories to use this plugin. All you need to do is to configure it inside your project as dependency:
Known Issues / Limitations:
Reporting Problems
If you find any problem with this plugin, feel free to report it here
v2.2.3
: Version 2.2.3Compare Source
Version 2.2.3 is finally there and includes various bug-fixes and improvements :-)
New Features / Bug-Fixes:
The main key-aspects that have been improved or being worked on are the following:
-Dmaven.gitcommitid.skip=true
- https://github.com/ktoso/maven-git-commit-id-plugin/issues/268runOnIncremental=false
- https://github.com/ktoso/maven-git-commit-id-plugin/issues/269Getting the latest release
The plugin is available from Maven Central ([
Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR has been generated by Mend Renovate. View repository job log here.