[FIXED JENKINS-27097] use ISO-8601 in changelog

Use an explicit format string (to mimic raw format) to enforce ISO-8601 date format. Side benefit is this format string should not be impacted if a future/exotic git CLI do introduce some subtle changes in format=raw output.
jenkinsci · Feb 24, 2015 · de49c9b · de49c9b · MarkEWaite · Mar 3, 2015
1 parent 130748a
commit de49c9b
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 3 deletions.
diff --git a/src/main/java/org/jenkinsci/plugins/gitclient/CliGitAPIImpl.java b/src/main/java/org/jenkinsci/plugins/gitclient/CliGitAPIImpl.java
@@ -699,7 +699,11 @@ public void prune(RemoteConfig repository) throws GitException, InterruptedExcep
      */
     public ChangelogCommand changelog() {
         return new ChangelogCommand() {
+
+            /** Equivalent to the git-log raw format but using ISO 8601 date format - also prevent to depend on git CLI future changes */
+            public static final String RAW = "commit %H%ntree %T%nparent %P%nauthor %aN <%aE> %ai%ncommitter %cN <%cE> %ci%n%n%w(76,4,4)%s%n%n%b";
             final List<String> revs = new ArrayList<String>();
+
             Integer n = null;
             Writer out = null;
 
@@ -736,7 +740,8 @@ public void abort() {
             }
 
             public void execute() throws GitException, InterruptedException {
-                ArgumentListBuilder args = new ArgumentListBuilder(gitExe, "whatchanged", "--no-abbrev", "-M", "--pretty=raw");
+                ArgumentListBuilder args = new ArgumentListBuilder(gitExe, "whatchanged", "--no-abbrev", "-M");
+                args.add("--format="+RAW);
                 if (n!=null)
                     args.add("-n").add(n);
                 for (String rev : this.revs)

diff --git a/src/main/java/org/jenkinsci/plugins/gitclient/JGitAPIImpl.java b/src/main/java/org/jenkinsci/plugins/gitclient/JGitAPIImpl.java
@@ -43,6 +43,7 @@
 
 import javax.annotation.Nullable;
 
+import org.apache.commons.lang.time.FastDateFormat;
 import org.eclipse.jgit.api.AddNoteCommand;
 import org.eclipse.jgit.api.CommitCommand;
 import org.eclipse.jgit.api.CreateBranchCommand.SetupUpstreamMode;
@@ -1158,6 +1159,8 @@ private String statusOf(DiffEntry d) {
             }
         }
 
+        public static final String ISO_8601 = "yyyy-MM-dd'T'HH:mm:ssZ";
+
         /**
          * Formats a commit into the raw format.
          *
@@ -1176,8 +1179,11 @@ void format(RevCommit commit, @Nullable RevCommit parent, PrintWriter pw) throws
             pw.printf("tree %s\n", commit.getTree().name());
             for (RevCommit p : commit.getParents())
                 pw.printf("parent %s\n",p.name());
-            pw.printf("author %s\n", commit.getAuthorIdent().toExternalString());
-            pw.printf("committer %s\n", commit.getCommitterIdent().toExternalString());
+            FastDateFormat iso = FastDateFormat.getInstance(ISO_8601);
+            PersonIdent a = commit.getAuthorIdent();
+            pw.printf("author %s <%s> %s\n", a.getName(), a.getEmailAddress(), iso.format(a.getWhen()));
+            PersonIdent c = commit.getCommitterIdent();
+            pw.printf("committer %s <%s> %s\n", c.getName(), c.getEmailAddress(), iso.format(c.getWhen()));
 
             // indent commit messages by 4 chars
             String msg = commit.getFullMessage();