Merge pull request #206 from TheSnoozer/master

Drop support for java jdk1.6 and fix #122

Author: TheSnoozer

.travis.yml

@@ -2,4 +2,3 @@ language: java
 jdk:
   - oraclejdk8
   - oraclejdk7
-  - openjdk6

README.md

@@ -42,6 +42,14 @@ The current version is **2.1.15** ([changelist](https://github.com/ktoso/maven-g
 
 You can check the available versions by visiting [search.maven.org](http://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22pl.project13.maven%22%20AND%20a%3A%22git-commit-id-plugin%22), though using the newest is obviously the best choice.
 
+Migration Issues you may come across when using the latest 2.2.X
+-----------------------------
+If you are already using the git-commit-id-plugin and would like to move to the latest major release (2.2.X) there are some design choices we made to fix some of your issues.
+1. We dropped the support of Java 1.6 (if you still rely on this version, the version 2.1.15 still has support for this and you may want to check the fixed issues since then before reporting a new one)
+2. We renamed git.commit.id to git.commit.id.full to enable full compability with json (see https://github.com/ktoso/maven-git-commit-id-plugin/issues/122)
+
+I think especially the second one will strike all of our users and we really would like to apologize for any inconvenience :-)
+
 Getting SNAPSHOT versions of the plugin
 ---------------------------------------
 If you really want to use **snapshots**, here's the repository they are deployed to. 
@@ -215,7 +223,7 @@ It's really simple to setup this plugin; below is a sample pom that you may base
                         Please note that the strings here are Java regexes ({@code .*} is globbing, not plain {@code *}).
                     -->
                     <includeOnlyProperties>
-                      <!-- <includeOnlyProperty>^git.commit.id$</includeOnlyProperty> -->
+                      <!-- <includeOnlyProperty>^git.commit.id.full$</includeOnlyProperty> -->
                     </includeOnlyProperties>
 
                     <!-- @since 2.1.10 -->
@@ -297,7 +305,7 @@ git.branch=${git.branch}
 git.dirty=${git.dirty}
 git.remote.origin.url=${git.remote.origin.url}
 
-git.commit.id=${git.commit.id}
+git.commit.id.full=${git.commit.id.full}
 git.commit.id.abbrev=${git.commit.id.abbrev}
 git.commit.id.describe=${git.commit.id.describe}
 git.commit.id.describe-short=${git.commit.id.describe-short}
@@ -335,7 +343,7 @@ Start out with with adding the above steps to your project, next paste this **gi
         <property name="dirty" value="${git.dirty}"/>
         <property name="remoteOriginUrl" value="${git.remote.origin.url}"/>
 
-        <property name="commitId" value="${git.commit.id}"/>
+        <property name="commitId" value="${git.commit.id.full}"/>
         <property name="commitIdAbbrev" value="${git.commit.id.abbrev}"/>
         <property name="describe" value="${git.commit.id.describe}"/>
         <property name="describeShort"  value="${git.commit.id.describe-short}"/>
@@ -375,7 +383,7 @@ public class GitRepositoryState {
   String dirty;                   // =${git.dirty}
   String remoteOriginUrl;         // =${git.remote.origin.url}
 
-  String commitId;                // =${git.commit.id}
+  String commitId;                // =${git.commit.id.full}
   String commitIdAbbrev;          // =${git.commit.id.abbrev}
   String describe;                // =${git.commit.id.describe}
   String describeShort;           // =${git.commit.id.describe-short}
@@ -506,7 +514,7 @@ public GitRepositoryState(Properties properties)
   this.dirty = properties.get("git.dirty").toString();
   this.remoteOriginUrl = properties.get("git.remote.origin.url").toString();
 
-  this.commitId = properties.get("git.commit.id").toString();
+  this.commitId = properties.get("git.commit.id.full").toString();
   this.commitIdAbbrev = properties.get("git.commit.id.abbrev").toString();
   this.describe = properties.get("git.commit.id.describe").toString();
   this.describeShort = properties.get("git.commit.id.describe-short").toString();

pom.xml

@@ -76,7 +76,7 @@
     <junit.version>4.12</junit.version>
     <mockito.version>2.0.5-beta</mockito.version>
 
-    <java.target>1.6</java.target>
+    <java.target>1.7</java.target>
     <sourceEncoding>UTF-8</sourceEncoding>
     <outputEncoding>UTF-8</outputEncoding>
     <fest-assert.version>1.4</fest-assert.version>

src/main/java/pl/project13/maven/git/GitCommitIdMojo.java

@@ -65,7 +65,7 @@ public class GitCommitIdMojo extends AbstractMojo {
   // these properties will be exposed to maven
   public static final String BRANCH = "branch";
   public static final String DIRTY = "dirty";
-  public static final String COMMIT_ID = "commit.id";
+  public static final String COMMIT_ID = "commit.id.full";
   public static final String COMMIT_ID_ABBREV = "commit.id.abbrev";
   public static final String COMMIT_DESCRIBE = "commit.id.describe";
   public static final String COMMIT_SHORT_DESCRIBE = "commit.id.describe-short";

src/test/java/pl/project13/maven/git/GitCommitIdMojoIntegrationTest.java

@@ -653,9 +653,9 @@ public void runGitDescribeWithMatchOption(boolean useNativeGit) throws Exception
       assertThat(targetProject.getProperties().stringPropertyNames()).contains("git.commit.id.describe");
       assertThat(targetProject.getProperties().getProperty("git.commit.id.describe")).startsWith(gitDescribeMatchNeedle);
 
-      assertThat(targetProject.getProperties().stringPropertyNames()).contains("git.commit.id");
-      assertThat(targetProject.getProperties().get("git.commit.id")).isNotEqualTo(commitIdOfMatchNeedle);
-      assertThat(targetProject.getProperties().get("git.commit.id")).isEqualTo(headCommitId);
+      assertThat(targetProject.getProperties().stringPropertyNames()).contains("git.commit.id.full");
+      assertThat(targetProject.getProperties().get("git.commit.id.full")).isNotEqualTo(commitIdOfMatchNeedle);
+      assertThat(targetProject.getProperties().get("git.commit.id.full")).isEqualTo(headCommitId);
     }
   }
 
@@ -765,7 +765,7 @@ private void assertGitPropertiesPresentInProject(Properties properties) {
     assertThat(properties).satisfies(new ContainsKeyCondition("git.build.time"));
     assertThat(properties).satisfies(new ContainsKeyCondition("git.build.host"));
     assertThat(properties).satisfies(new ContainsKeyCondition("git.branch"));
-    assertThat(properties).satisfies(new ContainsKeyCondition("git.commit.id"));
+    assertThat(properties).satisfies(new ContainsKeyCondition("git.commit.id.full"));
     assertThat(properties).satisfies(new ContainsKeyCondition("git.commit.id.abbrev"));
     assertThat(properties).satisfies(new ContainsKeyCondition("git.commit.id.describe"));
     assertThat(properties).satisfies(new ContainsKeyCondition("git.build.user.name"));

src/test/java/pl/project13/maven/git/GitCommitIdMojoTest.java

@@ -80,7 +80,7 @@ public void shouldIncludeExpectedProperties() throws Exception {
 
     assertThat(properties).satisfies(new ContainsKeyCondition("git.branch"));
     assertThat(properties).satisfies(new ContainsKeyCondition("git.dirty"));
-    assertThat(properties).satisfies(new ContainsKeyCondition("git.commit.id"));
+    assertThat(properties).satisfies(new ContainsKeyCondition("git.commit.id.full"));
     assertThat(properties).satisfies(new ContainsKeyCondition("git.commit.id.abbrev"));
     assertThat(properties).satisfies(new ContainsKeyCondition("git.build.user.name"));
     assertThat(properties).satisfies(new ContainsKeyCondition("git.build.user.email"));
@@ -115,7 +115,7 @@ public void shouldExcludeAsConfiguredProperties() throws Exception {
 
     // these stay
     assertThat(properties).satisfies(new ContainsKeyCondition("git.branch"));
-    assertThat(properties).satisfies(new ContainsKeyCondition("git.commit.id"));
+    assertThat(properties).satisfies(new ContainsKeyCondition("git.commit.id.full"));
     assertThat(properties).satisfies(new ContainsKeyCondition("git.commit.id.abbrev"));
     assertThat(properties).satisfies(new ContainsKeyCondition("git.commit.message.full"));
     assertThat(properties).satisfies(new ContainsKeyCondition("git.commit.message.short"));
@@ -125,7 +125,7 @@ public void shouldExcludeAsConfiguredProperties() throws Exception {
   @Test
   public void shouldIncludeOnlyAsConfiguredProperties() throws Exception {
     // given
-    mojo.setIncludeOnlyProperties(ImmutableList.of("git.remote.origin.url", ".*.user.*", "^git.commit.id$"));
+    mojo.setIncludeOnlyProperties(ImmutableList.of("git.remote.origin.url", ".*.user.*", "^git.commit.id.full$"));
 
     // when
     mojo.execute();
@@ -139,7 +139,7 @@ public void shouldIncludeOnlyAsConfiguredProperties() throws Exception {
     // glob included
     assertThat(properties).satisfies(new ContainsKeyCondition("git.build.user.name"));
     assertThat(properties).satisfies(new ContainsKeyCondition("git.build.user.email"));
-    assertThat(properties).satisfies(new ContainsKeyCondition("git.commit.id"));
+    assertThat(properties).satisfies(new ContainsKeyCondition("git.commit.id.full"));
     assertThat(properties).satisfies(new ContainsKeyCondition("git.commit.user.name"));
     assertThat(properties).satisfies(new ContainsKeyCondition("git.commit.user.email"));
 
@@ -176,7 +176,7 @@ public void shouldExcludeAndIncludeAsConfiguredProperties() throws Exception {
 
     // these excluded
     assertThat(properties).satisfies(new DoesNotContainKeyCondition("git.branch"));
-    assertThat(properties).satisfies(new DoesNotContainKeyCondition("git.commit.id"));
+    assertThat(properties).satisfies(new DoesNotContainKeyCondition("git.commit.id.full"));
     assertThat(properties).satisfies(new DoesNotContainKeyCondition("git.commit.id.abbrev"));
     assertThat(properties).satisfies(new DoesNotContainKeyCondition("git.commit.message.full"));
     assertThat(properties).satisfies(new DoesNotContainKeyCondition("git.commit.message.short"));

src/test/java/pl/project13/maven/git/GitSubmodulesTest.java

@@ -57,7 +57,7 @@ private void assertGitPropertiesPresentInProject(Properties properties) {
     assertThat(properties).satisfies(new ContainsKeyCondition("git.build.time"));
     assertThat(properties).satisfies(new ContainsKeyCondition("git.build.host"));
     assertThat(properties).satisfies(new ContainsKeyCondition("git.branch"));
-    assertThat(properties).satisfies(new ContainsKeyCondition("git.commit.id"));
+    assertThat(properties).satisfies(new ContainsKeyCondition("git.commit.id.full"));
     assertThat(properties).satisfies(new ContainsKeyCondition("git.commit.id.abbrev"));
     assertThat(properties).satisfies(new ContainsKeyCondition("git.build.user.name"));
     assertThat(properties).satisfies(new ContainsKeyCondition("git.build.user.email"));

src/test/java/pl/project13/maven/git/NaivePerformanceTest.java

@@ -95,7 +95,7 @@ private void assertGitPropertiesPresentInProject(Properties properties) {
     assertThat(properties).satisfies(new ContainsKeyCondition("git.build.time"));
     assertThat(properties).satisfies(new ContainsKeyCondition("git.build.host"));
     assertThat(properties).satisfies(new ContainsKeyCondition("git.branch"));
-    assertThat(properties).satisfies(new ContainsKeyCondition("git.commit.id"));
+    assertThat(properties).satisfies(new ContainsKeyCondition("git.commit.id.full"));
     assertThat(properties).satisfies(new ContainsKeyCondition("git.commit.id.abbrev"));
     assertThat(properties).satisfies(new ContainsKeyCondition("git.commit.id.describe"));
     assertThat(properties).satisfies(new ContainsKeyCondition("git.build.user.name"));

src/test/java/pl/project13/maven/git/NativeAndJGitProviderTest.java

@@ -37,7 +37,7 @@ public class NativeAndJGitProviderTest extends GitIntegrationTest
     "git.build.time",
     "git.build.host",
     "git.branch",
-    "git.commit.id",
+    "git.commit.id.full",
     "git.commit.id.abbrev",
     "git.commit.id.describe",
     "git.build.user.name",

src/test/resources/git.properties

@@ -21,7 +21,7 @@ git.build.user.name=${git.build.user.name}
 git.build.user.email=${git.build.user.email}
 git.build.time=${git.build.time}
 
-git.commit.id=${git.commit.id}
+git.commit.id.full=${git.commit.id.full}
 git.commit.id.abbrev=${git.commit.id.abbrev}
 git.commit.user.name=${git.commit.user.name}
 git.commit.user.email=${git.commit.user.email}