Changed: short-describe to describe-short

Refs #111

Author: ktoso

README.md

@@ -280,6 +280,7 @@ import org.codehaus.jackson.annotate.JsonWriteNullProperties;
 public class GitRepositoryState {
   String branch;                  // =${git.branch}
   String describe;                // =${git.commit.id.describe}
+  String shortDescribe;           // =${git.commit.id.describe-short}
   String commitId;                // =${git.commit.id}
   String commitIdAbbrev;          // =${git.commit.id.abbrev}
   String buildUserName;           // =${git.build.user.name}
@@ -331,6 +332,7 @@ In the end *this is what this service would return*:
      {
          "branch" : "testing-maven-git-plugin",
          "describe" : "v2.1.0-2-g2346463",
+         "describeShort" : "v2.1.0-2",
          "commitTime" : "06.01.1970 @ 16:16:26 CET",
          "commitId" : "787e39f61f99110e74deed68ab9093088d64b969",
          "commitIdAbbrev" : "787e39f",
@@ -394,6 +396,7 @@ public GitRepositoryState(Properties properties)
 {
    this.branch = properties.get("git.branch").toString();
    this.describe = properties.get("git.commit.id.describe").toString();
+   this.describeShort = properties.get("git.commit.id.describe-short").toString();
    this.commitId = properties.get("git.commit.id").toString();
    this.buildUserName = properties.get("git.build.user.name").toString();
    this.buildUserEmail = properties.get("git.build.user.email").toString();
@@ -452,6 +455,9 @@ Other outputs may look like:
 
 For more details (on when what output will be returned etc), see <code>man git-describe</code> (or here: [git-describe](http://www.kernel.org/pub/software/scm/git/docs/git-describe.html)). In general, you can assume it's a "best effort" approach, to give you as much info about the repo state as possible.
 
+**describe-short** is also provided, in case you want to display this property to non-techy users, which would panic on the sight of a hash (last part of the describe string) - this property is simply
+*the describe output, with the hash part stripped out*.
+
 git-describe and a small "gotcha" with tags
 -------------------------------------------
 You probably know that git has two kinds of tags:

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

@@ -66,7 +66,7 @@ public class GitCommitIdMojo extends AbstractMojo {
   public static final String COMMIT_ID = "commit.id";
   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.short-describe";
+  public static final String COMMIT_SHORT_DESCRIBE = "commit.id.describe-short";
   public static final String BUILD_AUTHOR_NAME = "build.user.name";
   public static final String BUILD_AUTHOR_EMAIL = "build.user.email";
   public static final String BUILD_TIME = "build.time";

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

@@ -272,7 +272,7 @@ public void shouldGenerateDescribeWithTagOnlyWhenForceLongFormatIsFalse() throws
 
     // then
     assertThat(targetProject.getProperties()).includes(entry("git.commit.id.describe", "v1.0.0"));
-    assertThat(targetProject.getProperties()).includes(entry("git.commit.id.short-describe", "v1.0.0"));
+    assertThat(targetProject.getProperties()).includes(entry("git.commit.id.describe-short", "v1.0.0"));
   }
 
   @Test
@@ -297,7 +297,7 @@ public void shouldGenerateDescribeWithTagAndZeroAndCommitIdWhenForceLongFormatIs
 
     // then
     assertThat(targetProject.getProperties()).includes(entry("git.commit.id.describe", "v1.0.0-0-gde4db35"));
-    assertThat(targetProject.getProperties()).includes(entry("git.commit.id.short-describe", "v1.0.0-0"));
+    assertThat(targetProject.getProperties()).includes(entry("git.commit.id.describe-short", "v1.0.0-0"));
   }
 
   private void alterMojoSettings(String parameterName, Object parameterValue) {