Skip to content

Commit 389edc6

Browse files
committed
rename "git.files.dirty" to "git.dirty" (safe, was never released previously)
1 parent 7f06d46 commit 389edc6

File tree

5 files changed

+12
-9
lines changed

5 files changed

+12
-9
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -258,6 +258,7 @@ Now you just have to include such a properties file in your project under `/src/
258258

259259
```
260260
git.branch=${git.branch}
261+
git.dirty=${git.dirty}
261262
git.commit.tags=${git.tags}
262263
263264
git.commit.id.describe=${git.commit.id.describe}
@@ -290,6 +291,7 @@ Start out with with adding the above steps to your project, next paste this **gi
290291

291292
<bean name="gitRepositoryInformation" class="pl.project13.maven.example.git.GitRepositoryState">
292293
<property name="branch" value="${git.branch}"/>
294+
<property name="dirty" value="${git.dirty}"/>
293295
<property name="tags" value="${git.tags}"/>
294296
<property name="describe" value="${git.commit.id.describe}"/>
295297
<property name="commitId" value="${git.commit.id}"/>
@@ -321,7 +323,8 @@ import org.codehaus.jackson.annotate.JsonWriteNullProperties;
321323
@JsonWriteNullProperties(true)
322324
public class GitRepositoryState {
323325
String branch; // =${git.branch}
324-
String branch; // =${git.tags} // comma separated tag names
326+
String dirty; // =${git.dirty}
327+
String tags; // =${git.tags} // comma separated tag names
325328
String describe; // =${git.commit.id.describe}
326329
String shortDescribe; // =${git.commit.id.describe-short}
327330
String commitId; // =${git.commit.id}
@@ -374,6 +377,7 @@ In the end *this is what this service would return*:
374377
```json
375378
{
376379
"branch" : "testing-maven-git-plugin",
380+
"dirty" : "false",
377381
"tags" : "v2.1.11,testing",
378382
"describe" : "v2.1.0-2-g2346463",
379383
"describeShort" : "v2.1.0-2",
@@ -439,6 +443,7 @@ You'd have to add such an constructor to your GitRepositoryState bean:
439443
public GitRepositoryState(Properties properties)
440444
{
441445
this.branch = properties.get("git.branch").toString();
446+
this.dirty = properties.get("git.dirty").toString();
442447
this.tags = properties.get("git.tags").toString();
443448
this.describe = properties.get("git.commit.id.describe").toString();
444449
this.describeShort = properties.get("git.commit.id.describe-short").toString();
@@ -612,5 +617,3 @@ The best way to ask for features / improvements is [via the Issues section on gi
612617
and maybe someone else has some idea or would like to upvote your issue.
613618

614619
In all other cases, feel free to contact me by sending an email to `konrad.malawski@java.pl`, I'll definitely write back. :-)
615-
616-
[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/ktoso/maven-git-commit-id-plugin/trend.png)](https://bitdeli.com/free "Bitdeli Badge")

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,9 +58,9 @@ public class GitCommitIdMojo extends AbstractMojo {
5858

5959
// these properties will be exposed to maven
6060
public static final String BRANCH = "branch";
61+
public static final String DIRTY = "dirty";
6162
public static final String COMMIT_ID = "commit.id";
6263
public static final String COMMIT_ID_ABBREV = "commit.id.abbrev";
63-
public static final String FILES_DIRTY = "commit.files.dirty";
6464
public static final String COMMIT_DESCRIBE = "commit.id.describe";
6565
public static final String COMMIT_SHORT_DESCRIBE = "commit.id.describe-short";
6666
public static final String BUILD_AUTHOR_NAME = "build.user.name";

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,8 +90,8 @@ public void loadGitData(@NotNull Properties properties) throws IOException, Mojo
9090
put(properties, GitCommitIdMojo.COMMIT_ID, getCommitId());
9191
// git.commit.id.abbrev
9292
put(properties, GitCommitIdMojo.COMMIT_ID_ABBREV, getAbbrevCommitId());
93-
// git.files.dirty
94-
put(properties, GitCommitIdMojo.FILES_DIRTY, Boolean.toString(isDirty()));
93+
// git.dirty
94+
put(properties, GitCommitIdMojo.DIRTY, Boolean.toString(isDirty()));
9595
// git.commit.author.name
9696
put(properties, GitCommitIdMojo.COMMIT_AUTHOR_NAME, getCommitAuthorName());
9797
// git.commit.author.email

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ public void testDetectCleanWorkingDirectory() throws Exception {
6666

6767
Properties properties = mojo.getProperties();
6868

69-
assertThat(properties.get("git.commit.files.dirty")).isEqualTo("false");
69+
assertThat(properties.get("git.dirty")).isEqualTo("false");
7070
}
7171

7272
@Test
@@ -98,6 +98,6 @@ public void testDetectDirtyWorkingDirectory() throws Exception {
9898

9999
Properties properties = mojo.getProperties();
100100

101-
assertThat(properties.get("git.commit.files.dirty")).isEqualTo("true");
101+
assertThat(properties.get("git.dirty")).isEqualTo("true");
102102
}
103103
}

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,9 +80,9 @@ public void shouldIncludeExpectedProperties() throws Exception {
8080
Properties properties = mojo.getProperties();
8181

8282
assertThat(properties).satisfies(new ContainsKeyCondition("git.branch"));
83+
assertThat(properties).satisfies(new ContainsKeyCondition("git.dirty"));
8384
assertThat(properties).satisfies(new ContainsKeyCondition("git.commit.id"));
8485
assertThat(properties).satisfies(new ContainsKeyCondition("git.commit.id.abbrev"));
85-
assertThat(properties).satisfies(new ContainsKeyCondition("git.commit.files.dirty"));
8686
assertThat(properties).satisfies(new ContainsKeyCondition("git.build.user.name"));
8787
assertThat(properties).satisfies(new ContainsKeyCondition("git.build.user.email"));
8888
assertThat(properties).satisfies(new ContainsKeyCondition("git.commit.user.name"));

0 commit comments

Comments
 (0)