Wrong git describe version is being chosen

[mrubin]

I am trying the following build settings:

    git.useGitDescribe := true,
    git.gitTagToVersionNumber := { tag: String =>
      if (tag matches "[0-9]+\\..*") Some(tag) else None
    },
    git.uncommittedSignifier := None

Everything was working as expected for several versions (i.e. 1.5, 1.6, 1.7, 1.8, 1.9). As soon as I bumped my tag to "1.10", the detected version got stuck on "1.9". I bumped the tag to "1.11", the version I'm getting from sbt-git is still "1.9". git describe in both the project directory and via the sbt shell is showing me "1.11".

How can I debug this?

[mrubin]

Note that I had a bunch of tags all pointing to the same commit. At some point this broke sbt-git. When I force-pushed an empty commit just to get "1.12" to point to a different commit, my version went from "1.9" to "1.12".

[haavardw]

Test for this case found here: haavardw@b72d9d1

Note that the current behavior is different from what git describe --tags returns.

As far as I can see this is caused by using JGit as the git-reader and JGit returns the first matching tag not considering time of creation.

[mrubin]

@haavardw Thank you for reproducing the issue. The documentation mentions that if I do not have git available, I can specify useJGit. I am not doing this. I have git available. Are you suggesting that JGit is still being used under the hood?

[haavardw]

Yes, I believe the only thing you change with that setting is the git client being used when using git in the sbt console, not the client being used internally by sbt-git. My impression so far at least.

…

On Tue, Sep 4, 2018, 17:03 Michael Rubin ***@***.***> wrote: @haavardw <https://github.com/haavardw> Thank you for reproducing the issue. The documentation <https://github.com/sbt/sbt-git#using-jgit> mentions that if I do not have git available, I can specify useJGit. I am not doing this. I have git available. Are you suggesting that JGit is still being used under the hood? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#161 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAF2Hkj-VbWFYcOmJFhvWrp33sNaWVTBks5uXpY1gaJpZM4WKvcr> .

[mrubin]

Hi @haavardw,

I just ran into this again and this time I am unable to get past the issue. Any luck with further investigations of this issue?

[haavardw]

Sorry @mrubin, I haven't had time to look further into it. We're getting hit by this quite frequently now, so we need to prioritize it soon though..

[mrubin]

@haavardw thank you - the behavior is really inconsistent. We just ran into an issue (trying to deploy to prod, of course) where the wrong version got picked. The version was 1.20. We tried the build again - this time the git version was 1.21 and that went through. It seems like the plugin has issues with multiples of 10....

[javierarrieta]

Is this fixed by #162 ? I think it is but maybe it is a different case?

[haavardw]

#162 is wrong behavior in the sense that it is different than git describe (tie-breakers should be decided based on date), but ey, I like it! It is correct in 99% of the use-cases with sbt-git and super as a work-around until jgit gets fixed. I've created this issue with jgit: https://bugs.eclipse.org/bugs/show_bug.cgi?id=538610

[haavardw]

Actually #162 doesn't really work unless the multiple tags are on HEAD so I think it should be reverted. I've pushed fixes to jgit here https://github.com/eclipse/jgit/pull/78, but nobody seems to be picking it up.. I'll try to follow up.

[lJoublanc]

Hey guys, does this help at all:
https://stackoverflow.com/questions/27796561/git-describe-does-not-provide-expected-tag

in brief, if you don't use the --annotate switch when tagging, tag describe won't pick up that tag. Is this related at all, or something entirely different? Ran into this today and was going to raise an issue but then I saw this.

[mrubin]

@lJoublanc Thank you for the gotcha - I did come across the same information at some point and I do happen to use git tag -a (annotated tags) for all tags. So that's not the problem.

[haavardw]

jgit has the fix included in 5.2.0 (https://projects.eclipse.org/projects/technology.jgit/releases/5.2.0). I expect it to be included in the next 4.11 release as well.

[alexmnyc]

same issue here.

running "git describe" returns the correct version
checking for gitDescribedVersion in sbt returns the one behind

[alexmnyc]

The fix for now is to use the actual git describe

git.gitDescribedVersion := git.gitDescribedVersion(v => {
  import scala.sys.process._
  val nativeGitDescribeResult = ((shell :+ s"git describe --tags") !!).trim
  git.defaultTagByVersionStrategy(nativeGitDescribeResult)
}).value

[keweishang]

Can you try and add this libraryDependencies ++= Seq( "org.eclipse.jgit" % "org.eclipse.jgit" % "4.11.6.201812241910-r" ) in your plugins.sbt? So that sbt-git will use the jgit version 4.11.6 that has this bug fixed.

[blast-hardcheese]

Can you try and add this libraryDependencies ++= Seq( "org.eclipse.jgit" % "org.eclipse.jgit" % "4.11.6.201812241910-r" ) in your plugins.sbt? So that sbt-git will use the jgit version 4.11.6 that has this bug fixed.

This did not work for me