Support of git worktree option (for JGIT) #215

qboileau · 2015-09-02T09:27:20Z

Hi, since git 2.5.0 worktree option allow to create many working tree linked to a single repository.

Building a linked working tree using git-commit-id-plugin mojo failed because current git reference can't be retrieve. Seems to be JGit issue, but I think it's useful to report here first.

Build exception :

[INFO] --- git-commit-id-plugin:2.1.15:revision (default)  ---
org.apache.maven.plugin.MojoExecutionException: Could not get HEAD Ref, are you sure you have some commits in the dotGitDirectory?
    at pl.project13.maven.git.JGitProvider.prepareGitToExtractMoreDetailedReproInformation(JGitProvider.java:106)
    at pl.project13.maven.git.GitDataProvider.loadGitData(GitDataProvider.java:98)
    at pl.project13.maven.git.GitCommitIdMojo.loadGitDataWithJGit(GitCommitIdMojo.java:585)
    at pl.project13.maven.git.GitCommitIdMojo.loadGitData(GitCommitIdMojo.java:558)
    at pl.project13.maven.git.GitCommitIdMojo.execute(GitCommitIdMojo.java:376)
    at org.apache.maven.plugin.DefaultBuildPluginManager.executeMojo(DefaultBuildPluginManager.java:134)
    at org.apache.maven.lifecycle.internal.MojoExecutor.execute(MojoExecutor.java:208)
    at org.apache.maven.lifecycle.internal.MojoExecutor.execute(MojoExecutor.java:153)
    at org.apache.maven.lifecycle.internal.MojoExecutor.execute(MojoExecutor.java:145)
    at org.apache.maven.lifecycle.internal.LifecycleModuleBuilder.buildProject(LifecycleModuleBuilder.java:116)
    at org.apache.maven.lifecycle.internal.LifecycleModuleBuilder.buildProject(LifecycleModuleBuilder.java:80)
    at org.apache.maven.lifecycle.internal.builder.singlethreaded.SingleThreadedBuilder.build(SingleThreadedBuilder.java:51)
    at org.apache.maven.lifecycle.internal.LifecycleStarter.execute(LifecycleStarter.java:128)
    at org.apache.maven.DefaultMaven.doExecute(DefaultMaven.java:307)
    at org.apache.maven.DefaultMaven.doExecute(DefaultMaven.java:193)
    at org.apache.maven.DefaultMaven.execute(DefaultMaven.java:106)
    at org.apache.maven.cli.MavenCli.execute(MavenCli.java:862)
    at org.apache.maven.cli.MavenCli.doMain(MavenCli.java:286)
    at org.apache.maven.cli.MavenCli.main(MavenCli.java:197)
    at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
    at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:57)
    at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
    at java.lang.reflect.Method.invoke(Method.java:606)
    at org.codehaus.plexus.classworlds.launcher.Launcher.launchEnhanced(Launcher.java:289)
    at org.codehaus.plexus.classworlds.launcher.Launcher.launch(Launcher.java:229)
    at org.codehaus.plexus.classworlds.launcher.Launcher.mainWithExitCode(Launcher.java:415)
    at org.codehaus.plexus.classworlds.launcher.Launcher.main(Launcher.java:356)

The text was updated successfully, but these errors were encountered:

TheSnoozer · 2015-09-02T15:22:46Z

Hi,
yes this seems not yet implemented in the jGit Implementation.
Does it fail as well when you use the native git binary?

Recently started discussion on eclipse about the "worktree"
https://www.eclipse.org/forums/index.php/m/1703524/
Couldn't find a feature-request on the bug-list yet:
https://bugs.eclipse.org/bugs/buglist.cgi?quicksearch=worktree
(maybe we should file one?)

Also it should be worth quoting from here https://github.com/blog/2042-git-2-5-including-multiple-worktrees-and-triangular-workflows:

Please note that the worktree feature is experimental. It may have some bugs, and its interface may change based on user feedback. It's not recommended to use git worktree with a repository that contains submodules.

Is it still experimental? if so we still have a bit time to implement ;-)

TheSnoozer · 2016-06-08T17:35:10Z

see: https://bugs.eclipse.org/bugs/show_bug.cgi?id=477475

athrunsun · 2017-04-14T01:20:50Z

@qboileau @TheSnoozer Now it is 2017 and git comes to version 2.12.x, but I am still having issue with git-commit-id-plugin:2.2.2, that when I tried to build a maven project under a git worktree, it gave me:

[ERROR] Failed to execute goal pl.project13.maven:git-commit-id-plugin:2.2.2:revision (default) on project <some_project>: Could not complete Mojo execution... Error: Could not get
HEAD Ref, are you sure you have some commits in the dotGitDirectory? -> [Help 1]

Could you help me please?

TheSnoozer · 2017-06-30T16:01:52Z

Would be happy to have this in this plugin as well, but as outlined its a JGit issue (a library we use inside the plugin). If the library doesn't support it, this plugin doesn't support it either.

The Bug 7 Enhancement request for JGit (https://bugs.eclipse.org/bugs/show_bug.cgi?id=477475) is still open and thus it is not available afaik.

TheSnoozer · 2017-07-11T13:53:09Z

Note: This feature will prop break java jdk 1.7 support.

With jgit v4.6 the build was moved towards 1.8 only (https://bugs.eclipse.org/bugs/show_bug.cgi?id=500059)

TheSnoozer · 2017-09-18T02:06:34Z

Well sometimes third party libs takes ages...the bug /enhancement request for JGit (https://bugs.eclipse.org/bugs/show_bug.cgi?id=477475) is still open and thus it is not available for jgit...just saying if it isn't obvious....the native git-implementation (<useNativeGit>true</useNativeGit>) should support this

athrunsun · 2017-09-18T06:35:21Z

@TheSnoozer That's sad... But on the other hand I can at least skip execution of this plugin from now on when I am on a git worktree since Added property to skip from CLI is released in 2.2.3.

TheSnoozer · 2017-09-18T17:51:49Z

@athrunsun agree this is kinda annoying...
For skipping from CLI please checkout this issue:
#315

In a nutshell you can't skip by command-line when the property is configured as plugin configuration (a maven bug). The workaround that even was suggested by the maven team is outlined in #315 (comment)
Regardless I fixed this properly and this workaround won't be required in 2.2.4.

athrunsun · 2017-09-19T01:24:17Z

@TheSnoozer That sounds really great, thanks for the fix! Looking forward to 2.2.4 release.

lysium · 2018-04-23T10:50:15Z

FWIW, I still get the error with 2.2.4:

[ERROR] Failed to execute goal pl.project13.maven:git-commit-id-plugin:2.2.4:revision (default) on project system-activation-service-app: Could not complete Mojo execution...: Error: Could not get HEAD Ref, are you sure you have some commits in the dotGitDirectory? -> [Help 1]

Or am doing sth. wrong?

The workaround with adding -Dmaven.gitcommitid.skip=true works, though.

TheSnoozer · 2018-04-23T17:50:42Z

Well this issue that is reported here is still open and the corresponding changes about git worktree are still not merged into jgit. So if you are using git worktree I'd suggest to follow #215 (comment)

If you don't use git worktree, check if you have any commits in your repo (thats at least what the error says).

lysium · 2018-05-07T19:52:06Z

Thanks for the reply -- I got confused about the "Closed" message above, which references another issue; sorry about that.

I do have commits in the repo; I guess jgit gets confused that .git is a file in a worktree, hence the misleading error message.

TheSnoozer · 2018-09-01T23:40:18Z

There is finally some progress on the JGit side on this issue (https://bugs.eclipse.org/bugs/show_bug.cgi?id=477475).

The native git-implementation (<useNativeGit>true</useNativeGit>) should (still) support this...

elexx · 2019-12-09T11:37:25Z

2019 and it looks like JGit finally supports read-operations on worktrees, which might be enough to fix this issue, since we don't want to create/modify/delete worktrees here?

https://bugs.eclipse.org/bugs/show_bug.cgi?id=477475#c41

TheSnoozer · 2019-12-10T19:32:16Z

Maybe I'm missing something, but the changes are not merged?!?

At least the linked change-set (e.g. https://git.eclipse.org/r/#/c/126440/, https://git.eclipse.org/r/#/c/126454/ or https://git.eclipse.org/r/#/c/67873/ are labeled as Needs Code-Review Label or even Abandoned. The issue itself is labeled with version 4.1, this plugin uses 5.2.2.201904231744-r

elexx · 2019-12-11T05:57:36Z

You are right. I was just reading the linked issue, but did not check the actual code/patches.

TheSnoozer · 2019-12-11T19:11:39Z

Yeah...thanks for reminding me on this issue, but sadly it seems there is no progress on the JGit-side....the native git-implementation (<useNativeGit>true</useNativeGit>) should (still) support this...let's see if it gets merged in 2020...when it does it perhaps will also break some java versioning support for java 8

holle · 2020-07-09T11:59:28Z

Hey folks, are there any news on this issue?
Regarding the post https://bugs.eclipse.org/bugs/show_bug.cgi?id=477475#c53 a egit + jgit version for testing in Eclipse is available -- and it works for me (Eclipse 2020-06).
So what would it take to make the changes work here as well?

The Eclipse Package contains org.eclipse.jgit 5.8.0.202006012134

Cheers,
Holger

TheSnoozer · 2020-07-14T20:43:28Z

Hi,
thanks for bringing this long living ticket up again!
Unfortunately it seems the referenced ticket is still open and not merged.
One of the more recent comments points to https://git.eclipse.org/r/126454, however the status there is Abandoned and it is superseeded by https://git.eclipse.org/r/163940. This specific commit has a merge conflict and thus it appears nothing was yet merged that supports 'git worktrees'. Also the release-notes (e.g. https://projects.eclipse.org/projects/technology.jgit/releases/5.8.0) seem to lack to point to such support.

I know there is also an unofficial build linked in the discussion you mentioned, however I'd rather have some official support over some random binary shared via dropbox. Perhaps I'm missing a link?

holle · 2020-07-14T22:51:53Z

Hi,

in regard to your question:

I know there is also an unofficial build linked in the discussion you mentioned, however I'd rather have some official support over some random binary shared via dropbox. Perhaps I'm missing a link?

No, but maybe we could check the source he attached and build a „unofficial test Version“ as well in order to see if it works for us.
To be frank, I did not go through to repo or PRs, but rather read the conversation and took from it that he resolved that merge conflict somehow and the maintainers are „looking into it“ themselves.

Andre Bossert wrote:

Hi,andre,thank you very much for your private work. Can this zip can be used
as sbt plugin? and how?
Btw, i still don't get why jgit don't support worktree in official way.

Hi, thanks, but i'm not alone ;) we are preparing new version for review.

Thanks in advance,
Holger

TheSnoozer · 2020-07-15T20:53:59Z

Ah thanks for the clarifications on your observation! Technically we potentially could assemble our own JGit version with the support of worktrees, however I feel I'm not the maintainer or a contributor to jGit. This plugin (or me in the case) are "simply" users. What happens if such support doesn't work accurate? Then I'm forced to keep monkey-patching a release and integrate whatever JGit changes come in. From the perspective of the plugin user's still can work when using <useNativeGit>true</useNativeGit>. Furthermore there are already many merge-requests and attempts made to integrate the functionality. From my perspective it's the responsibility of a maintainer of JGit to take care of getting them integrated.

All together I'd prefer to wait until the changes are integrated officially.

holle · 2020-07-16T06:57:10Z

All together I'd prefer to wait until the changes are integrated officially.

Understood, thanks for clarifying

👍

shoffmeister · 2021-04-20T08:01:54Z

For the record (and folks who hit this via an Internet search), version 4.0.3 of this plugin still has challenges with "worktree".

Not sure about 4.0.4 (the latest release as of this comment)

shoffmeister · 2021-04-20T10:34:19Z

FWIW, https://git.eclipse.org/r/c/jgit/jgit/+/163940/ (upstream jgit gerrit review) still exists, last activity there is from mid-December 2020; that patch has a merge conflict.

I am not surprised then that version 4.0.4 of this plugin remains unhappy about worktrees; I suppose the workaround mentioned above - <useNativeGit>true</useNativeGit> - still applies.

TheSnoozer · 2021-04-20T20:47:29Z

Hi, thanks for the update. Indeed if JGit doesn't support worktrees the plugin will sadly will not suddenly work with JGit. The workaround by using the native git implementation (via <useNativeGit>true</useNativeGit>) should still work fine. This applies for all plugin versions that have been released so far.

jeffjensen · 2021-11-19T13:14:57Z

Interestingly, the JGit change to correctly solve this issue https://bugs.eclipse.org/bugs/show_bug.cgi?id=477475 has 85 votes, the highest JGit one at the moment by nearly three times, with the next highest at 29 votes. While the entry is 6 years old, there are promising comments this year (June, October) on implementation movement.

This is a workaround for inability to build Trino in a git worktree. This is a long-standing issue in the plugin, see git-commit-id/git-commit-id-maven-plugin#215.

…rktrees see git-commit-id/git-commit-id-maven-plugin#215

…rktrees (#1285) ### Motivation You cannot use git worktrees in KOP development. ### Modifications see git-commit-id/git-commit-id-maven-plugin#215

…rktrees (#1285) ### Motivation You cannot use git worktrees in KOP development. ### Modifications see git-commit-id/git-commit-id-maven-plugin#215 (cherry picked from commit dbea538)

…rktrees (#1285) ### Motivation You cannot use git worktrees in KOP development. ### Modifications see git-commit-id/git-commit-id-maven-plugin#215 (cherry picked from commit dbea538) (cherry picked from commit e9d4e20)

justincranford · 2023-02-10T20:27:14Z

Does this help anyone out?

Set maven.gitcommitid.nativegit=true to make git-commit-id-plugin bypass JGit and use native Git instead.

Workaround: Command Line

mvn package -Dmaven.gitcommitid.nativegit=true

Workaround: pom.xml

    <properties>
        <maven.gitcommitid.nativegit>true</maven.gitcommitid.nativegit>
    </properties>

Tested with:

git-commit-id-plugin: 4.9.10
command line Git: 2.39.1

holle · 2023-02-13T08:43:48Z

Hi @justincranford

yes, it works for me, albeit I am using the following clone/fork with this setting:

        <build>
                <plugins>
                        <plugin>
                                <groupId>pl.project13.maven</groupId>
                                <artifactId>git-commit-id-plugin</artifactId>
[...]
                                <configuration>
                                        <useNativeGit>true</useNativeGit>
[...]
                                </configuration>
                        </plugin>
                </plugins>

Cheers,
Holger

Does this help anyone out?

Set maven.gitcommitid.nativegit=true to make git-commit-id-plugin bypass JGit and use native Git instead.

Workaround: Command Line

mvn package -Dmaven.gitcommitid.nativegit=true

Workaround: pom.xml
    <properties>
        <maven.gitcommitid.nativegit>true</maven.gitcommitid.nativegit>
    </properties>
Tested with:
* git-commit-id-plugin: 4.9.10

* command line Git: 2.39.1

TheSnoozer · 2024-10-07T18:58:20Z

Not sure if any of the initial reporters still monitors this discussion...but JGIT seems to have finally added (read) support for git worktrees.
Refs:

https://eclipse.gerrithub.io/c/eclipse-jgit/jgit/+/1194900
eclipse-jgit/jgit@f9beeb3
However that is only available in JGIT 7.X and as per https://projects.eclipse.org/projects/technology.jgit/releases/7.0.0 this would require Java 17 (Require Java 17 (LTS) #708).....

Using the native git is still an option and I certainly haven't run any tests whatsoever...

TheSnoozer added enhancement feature labels Nov 16, 2015

TheSnoozer mentioned this issue Jun 30, 2017

Does not work with git worktree #285

Closed

TheSnoozer changed the title ~~Support of git worktree option~~ Support of git worktree option (for JGIT) Sep 23, 2017

TheSnoozer added the BREAKS_JAVA7 label Dec 4, 2017

TheSnoozer removed the BREAKS_JAVA7 label Aug 11, 2019

bodograumann mentioned this issue Apr 27, 2020

[BUG] Regression: Compilation fails with git worktree OpenAPITools/openapi-generator#6072

Closed

4 tasks

ksobolew mentioned this issue Mar 8, 2022

Set useNativeGit in git-commit-id-plugin trinodb/trino#11365

Merged

ksobolew added a commit to ksobolew/trino that referenced this issue Mar 8, 2022

Set useNativeGit in git-commit-id-plugin

a5f7e57

This is a workaround for inability to build Trino in a git worktree. This is a long-standing issue in the plugin, see git-commit-id/git-commit-id-maven-plugin#215.

hashhar pushed a commit to trinodb/trino that referenced this issue Mar 8, 2022

Set useNativeGit in git-commit-id-plugin

6a63d25

This is a workaround for inability to build Trino in a git worktree. This is a long-standing issue in the plugin, see git-commit-id/git-commit-id-maven-plugin#215.

juriad mentioned this issue May 10, 2022

Please re-open issue GH-14 n0mer/gradle-git-properties#155

Open

eolivelli added a commit to eolivelli/kop that referenced this issue May 13, 2022

Add useNativeGit to Git Commit Id Plugin - to support working with wo…

1753b6b

…rktrees see git-commit-id/git-commit-id-maven-plugin#215

eolivelli mentioned this issue May 13, 2022

Add useNativeGit to Git Commit Id Plugin - to support working with worktrees streamnative/kop#1285

Merged

1 task

This was referenced Jun 23, 2023

Plugin fails in git worktree even when native git is used #639

Closed

Trino can't build from a git worktree trinodb/trino#18027

Closed

Fix build inside git worktrees by working around git-commit-id #639 trinodb/trino#18046

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support of git worktree option (for JGIT) #215

Support of git worktree option (for JGIT) #215

qboileau commented Sep 2, 2015

TheSnoozer commented Sep 2, 2015

TheSnoozer commented Jun 8, 2016

athrunsun commented Apr 14, 2017

TheSnoozer commented Jun 30, 2017

TheSnoozer commented Jul 11, 2017

TheSnoozer commented Sep 18, 2017

athrunsun commented Sep 18, 2017 •

edited

Loading

TheSnoozer commented Sep 18, 2017

athrunsun commented Sep 19, 2017

lysium commented Apr 23, 2018

TheSnoozer commented Apr 23, 2018

lysium commented May 7, 2018

TheSnoozer commented Sep 1, 2018

elexx commented Dec 9, 2019

TheSnoozer commented Dec 10, 2019

elexx commented Dec 11, 2019

TheSnoozer commented Dec 11, 2019

holle commented Jul 9, 2020 •

edited

Loading

TheSnoozer commented Jul 14, 2020

holle commented Jul 14, 2020

TheSnoozer commented Jul 15, 2020

holle commented Jul 16, 2020

shoffmeister commented Apr 20, 2021

shoffmeister commented Apr 20, 2021

TheSnoozer commented Apr 20, 2021

jeffjensen commented Nov 19, 2021

justincranford commented Feb 10, 2023 •

edited

Loading

holle commented Feb 13, 2023 •

edited

Loading

Does this help anyone out?

Workaround: Command Line

Workaround: pom.xml

TheSnoozer commented Oct 7, 2024

Support of git worktree option (for JGIT) #215

Support of git worktree option (for JGIT) #215

Comments

qboileau commented Sep 2, 2015

TheSnoozer commented Sep 2, 2015

TheSnoozer commented Jun 8, 2016

athrunsun commented Apr 14, 2017

TheSnoozer commented Jun 30, 2017

TheSnoozer commented Jul 11, 2017

TheSnoozer commented Sep 18, 2017

athrunsun commented Sep 18, 2017 • edited Loading

TheSnoozer commented Sep 18, 2017

athrunsun commented Sep 19, 2017

lysium commented Apr 23, 2018

TheSnoozer commented Apr 23, 2018

lysium commented May 7, 2018

TheSnoozer commented Sep 1, 2018

elexx commented Dec 9, 2019

TheSnoozer commented Dec 10, 2019

elexx commented Dec 11, 2019

TheSnoozer commented Dec 11, 2019

holle commented Jul 9, 2020 • edited Loading

TheSnoozer commented Jul 14, 2020

holle commented Jul 14, 2020

TheSnoozer commented Jul 15, 2020

holle commented Jul 16, 2020

shoffmeister commented Apr 20, 2021

shoffmeister commented Apr 20, 2021

TheSnoozer commented Apr 20, 2021

jeffjensen commented Nov 19, 2021

justincranford commented Feb 10, 2023 • edited Loading

Does this help anyone out?

Workaround: Command Line

Workaround: pom.xml

holle commented Feb 13, 2023 • edited Loading

Does this help anyone out?

Workaround: Command Line

Workaround: pom.xml

TheSnoozer commented Oct 7, 2024

athrunsun commented Sep 18, 2017 •

edited

Loading

holle commented Jul 9, 2020 •

edited

Loading

justincranford commented Feb 10, 2023 •

edited

Loading

holle commented Feb 13, 2023 •

edited

Loading