#674: breaking: change dateFormat from RFC 822 time to ISO 8601

git-commit-id · Feb 14, 2024 · ae09253 · ae09253
1 parent 5eecbc8
commit ae09253
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 9 deletions.
diff --git a/pom.xml b/pom.xml
@@ -397,7 +397,7 @@
                             <dotGitDirectory>${project.basedir}/.git</dotGitDirectory>
                             <generateGitPropertiesFile>true</generateGitPropertiesFile>
                             <generateGitPropertiesFilename>target/testing.properties</generateGitPropertiesFilename>
-                            <dateFormat>yyyy-MM-dd'T'HH:mm:ssZ</dateFormat>
+                            <dateFormat>yyyy-MM-dd'T'HH:mm:ssXXX</dateFormat>
                             <dateFormatTimeZone>GMT-08:00</dateFormatTimeZone>
                             <useNativeGit>false</useNativeGit>
                             <abbrevLength>7</abbrevLength>

diff --git a/src/main/java/pl/project13/maven/git/GitCommitIdMojo.java b/src/main/java/pl/project13/maven/git/GitCommitIdMojo.java
@@ -498,20 +498,28 @@ public class GitCommitIdMojo extends AbstractMojo {
    * represents dates or times exported by this plugin (e.g. {@code git.commit.time}, {@code
    * git.build.time}). It should be a valid {@link SimpleDateFormat} string.
    *
-   * <p>The current dateFormat is set to match maven's default {@code yyyy-MM-dd'T'HH:mm:ssZ}.
-   * Please note that in previous versions (2.2.0 - 2.2.2) the default dateFormat was set to: {@code
-   * dd.MM.yyyy '@' HH:mm:ss z}. However the {@code RFC 822 time zone} seems to give a more reliable
-   * option in parsing the date and it's being used in maven as default.
+   * <p>The current dateFormat will be formatted as ISO 8601
+   * {@code yyyy-MM-dd'T'HH:mm:ssXXX} and therefore can be used as input to maven's
+   * <a href="https://maven.apache.org/guides/mini/guide-reproducible-builds.html">
+   * reproducible build</a> feature.
+   *
+   * Please note that in previous versions
+   * (2.2.2 - 7.0.1) the default format was set to {@code yyyy-MM-dd'T'HH:mm:ssZ}
+   * which produces a {@code RFC 822 time zone}. While such format gives reliable
+   * options in parsing the date, it does not comply with the requirements of
+   * the reproducible build feature.
+   * (2.2.0 - 2.2.2) the default dateFormat was set to: {@code
+   * dd.MM.yyyy '@' HH:mm:ss z}.
    *
    * <p>Example:
    *
    * <pre>{@code
-   * <dateFormat>yyyy-MM-dd'T'HH:mm:ssZ</dateFormat>
+   * <dateFormat>yyyy-MM-dd'T'HH:mm:ssXXX</dateFormat>
    * }</pre>
    *
    * @since 2.2.0
    */
-  @Parameter(defaultValue = "yyyy-MM-dd'T'HH:mm:ssZ")
+  @Parameter(defaultValue = "yyyy-MM-dd'T'HH:mm:ssXXX")
   String dateFormat;
 
   /**

diff --git a/src/test/java/pl/project13/maven/git/NativeAndJGitProviderTest.java b/src/test/java/pl/project13/maven/git/NativeAndJGitProviderTest.java
@@ -56,8 +56,8 @@ public class NativeAndJGitProviderTest extends GitIntegrationTest {
         "git.local.branch.behind",
       };
 
-  private static final String DEFAULT_FORMAT_STRING = "yyyy-MM-dd'T'HH:mm:ssZ";
-  private static final String ISO8601_FORMAT_STRING = "yyyy-MM-dd'T'HH:mm:ssZZ";
+  private static final String DEFAULT_FORMAT_STRING = "yyyy-MM-dd'T'HH:mm:ssXXX";
+  private static final String ISO8601_FORMAT_STRING = "yyyy-MM-dd'T'HH:mm:ssXXX";
 
   @Test
   public void testCompareBasic() throws Exception {