feat: add commit.timestamp.year.2digit placeholder

Author: qoomon

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 7.1.0
+
+##### Features
+* New Placeholder `${commit.timestamp.year.2digit}`
+
+
 ## 5.0.0
 
 ##### Features

README.md

@@ -29,7 +29,7 @@ This extension can virtually set project version and properties, based on curren
 
 ```groovy
 plugins {
-    id 'me.qoomon.git-versioning' version '5.0.0'
+    id 'me.qoomon.git-versioning' version '5.1.0'
 }
 
 version = '0.0.0-SNAPSHOT'
@@ -42,7 +42,7 @@ gitVersioning.apply {
 
 ```kotlin
 plugins {
-    id("me.qoomon.git-versioning") version "5.0.0"
+    id("me.qoomon.git-versioning") version "5.1.0"
 }
 
 
@@ -153,23 +153,16 @@ e.g `${dirty:-SNAPSHOT}` resolves to `-SNAPSHOT` instead of `-DIRTY`
 
 ###### Placeholders
 
-- `${env.VARIABLE}`
-    - Value of environment variable `VARIABLE`
-- `${property.name}`
-    - Value of commandline property `-Pname=value`
-      <br><br>
-
-- `${version}`
-    - project `version` (probably set in `build.gradle`)
-    - e.g. '1.0.0-SNAPSHOT'
-- `${version.release}`
-    - like `${version}` without `-SNAPSHOT` postfix
-    - e.g. '1.0.0'
-      <br><br>
-
-- `${ref}` `${ref.slug}`
-    - HEAD ref name (branch or tag name or commit hash)
-- `Ref Pattern Groups`
+- `${env.VARIABLE}` Value of environment variable `VARIABLE`
+- `${property.name}` Value of commandline property `-Pname=value`
+  <br><br>
+
+- `${version}` `<version>` set in `pom.xml` e.g. '1.0.0-SNAPSHOT'
+- `${version.release}` like `${version}` without `-SNAPSHOT` postfix e.g. '1.0.0'
+  <br><br>
+
+- `${ref}` `${ref.slug}` ref name (branch or tag name or commit hash)
+- Ref Pattern Groups
     - Content of regex groups in branch/tag `pattern` can be addressed like this:
     - `${ref.GROUP_NAME}` `${ref.GROUP_NAME.slug}`
     - `${ref.GROUP_INDEX}` `${ref.GROUP_INDEX.slug}`
@@ -189,76 +182,52 @@ e.g `${dirty:-SNAPSHOT}` resolves to `-SNAPSHOT` instead of `-DIRTY`
         ```
         <br>
 
-- `${commit}`
-    - The `HEAD` commit hash
-    - e.g. '0fc20459a8eceb2c4abb9bf0af45a6e8af17b94b'
-- `${commit.short}`
-    - The short `HEAD` commit hash (7 characters)
-    - e.g. '0fc2045'
-- `${commit.timestamp}`
-    - The `HEAD` commit timestamp (epoch seconds)
-    - e.g. '1560694278'
-- `${commit.timestamp.year}`
-    - The `HEAD` commit year
-    - e.g. '2021'
-- `${commit.timestamp.month}`
-    - The `HEAD` commit month of year
-    - e.g. '01'
-- `${commit.timestamp.day}`
-    - The `HEAD` commit day of month
-    - e.g. '01'
-- `${commit.timestamp.hour}`
-    - The `HEAD` commit hour of day (24h)
-    - e.g. '01'
-- `${commit.timestamp.minute}`
-    - The `HEAD` commit minute of hour
-    - e.g. '01'
-- `${commit.timestamp.second}`
-    - The `HEAD` commit second of minute
-    - e.g. '01'
-- `${commit.timestamp.datetime}`
-    - The `HEAD` commit timestamp formatted as `yyyyMMdd.HHmmss`
-    - e.g. '20190616.161442'
-      <br><br>
-
-- `${describe}`
-    - Will resolve to `git describe` output
-    - ⚠️ Can lead to performance issue on projects with a lot of tags
-- `${describe.distance}`
-    - The distance count to last matching tag
-- `${describe.tag}`
-    - The matching tag of `git describe`
- - Describe Tag Pattern Groups
-     - Content of regex groups in `describeTagPattern` can be addressed like this:
-     - `${describe.tag.GROUP_NAME}` `${describe.tag.GROUP_NAME.slug}`
-     - `${describe.tag.GROUP_INDEX}` `${describe.tag.GROUP_INDEX.slug}`
-     - Named Group Example
-
-         **groovy**
-         ```groovy
-         branch('main') {
-             describeTagPattern = 'v(?<version>.*)'
-             version = '${ref.feature}-SNAPSHOT'
-         }
-         ```
-         **kotlin**
-         ```kotlin
-         branch("main") {
-             describeTagPattern = "v(?<version>.*)"
-             version = "\${describe.tag.version}-SNAPSHOT"
-         }
-         ```
-         <br> 
-
-- `${dirty}`
-    - If repository has untracked files or uncommitted changes this placeholder will resolve to `-DIRTY`, otherwise it will resolve to an empty string.
+- `${commit}` commit hash '0fc20459a8eceb2c4abb9bf0af45a6e8af17b94b'
+- `${commit.short}` commit hash (7 characters) e.g. '0fc2045'
+- `${commit.timestamp}` commit timestamp (epoch seconds) e.g. '1560694278'
+- `${commit.timestamp.year}` commit year e.g. '2021'
+- `${commit.timestamp.year.2digit}` 2-digit commit year.g. '21'
+- `${commit.timestamp.month}` commit month of year e.g. '12'
+- `${commit.timestamp.day}` commit day of month e.g. '23'
+- `${commit.timestamp.hour}` commit hour of day (24h)e.g. '13'
+- `${commit.timestamp.minute}` commit minute of hour e.g. '59'
+- `${commit.timestamp.second}` commit second of minute e.g. '30'
+- `${commit.timestamp.datetime}` commit timestamp formatted as `yyyyMMdd.HHmmss`e.g. '20190616.161442'
+  <br><br>
+
+- `${describe}` Will resolve to `git describe` output
+    - ⚠️ `${describe....}` placeholders can lead to performance issue on projects with a lot of tags
+- `${describe.distance}` The distance count to last matching tag
+- `${describe.tag}` The matching tag of `git describe`
+- Describe Tag Pattern Groups
+  - Content of regex groups in `describeTagPattern` can be addressed like this:
+  - `${describe.tag.GROUP_NAME}` `${describe.tag.GROUP_NAME.slug}`
+  - `${describe.tag.GROUP_INDEX}` `${describe.tag.GROUP_INDEX.slug}`
+  - Named Group Example
+
+      **groovy**
+      ```groovy
+      branch('main') {
+          describeTagPattern = 'v(?<version>.*)'
+          version = '${ref.feature}-SNAPSHOT'
+      }
+      ```
+      **kotlin**
+      ```kotlin
+      branch("main") {
+          describeTagPattern = "v(?<version>.*)"
+          version = "\${describe.tag.version}-SNAPSHOT"
+      }
+      ```
+      <br> 
+
+- `${dirty}` If repository has untracked files or uncommitted changes this placeholder will resolve to `-DIRTY`, otherwise it will resolve to an empty string.
     - ⚠️ Can lead to performance issue on very large projects
-- `${dirty.snapshot}`
-    - Like `${dirty}`, but will resolve to `-SNAPSHOT`
-      <br><br>
+- `${dirty.snapshot}` Like `${dirty}`, but will resolve to `-SNAPSHOT`
+  <br><br>
+
+- `${value}` Original value of matching property (Only available within property format)
 
-- `${value}` - Only available within property format
-    - Original value of matching property
 
 ### Parameters & Environment Variables
 

build.gradle

@@ -12,7 +12,7 @@ plugins {
 }
 
 group 'me.qoomon'
-version '5.0.0'
+version '5.1.0'
 
 sourceCompatibility = JavaVersion.VERSION_1_8
 targetCompatibility = JavaVersion.VERSION_1_8

src/main/java/me/qoomon/gradle/gitversioning/GitVersioningPluginExtension.java

@@ -467,6 +467,7 @@ private Map<String, Supplier<String>> generateGlobalFormatPlaceholderMap(GitSitu
         final Lazy<ZonedDateTime> headCommitDateTime = Lazy.by(gitSituation::getTimestamp);
         placeholderMap.put("commit.timestamp", Lazy.by(() -> String.valueOf(headCommitDateTime.get().toEpochSecond())));
         placeholderMap.put("commit.timestamp.year", Lazy.by(() -> String.valueOf(headCommitDateTime.get().getYear())));
+        placeholderMap.put("commit.timestamp.year.2digit", Lazy.by(() -> String.valueOf(headCommitDateTime.get().getYear() % 100)));
         placeholderMap.put("commit.timestamp.month", Lazy.by(() -> leftPad(String.valueOf(headCommitDateTime.get().getMonthValue()), 2, "0")));
         placeholderMap.put("commit.timestamp.day", Lazy.by(() -> leftPad(String.valueOf(headCommitDateTime.get().getDayOfMonth()), 2, "0")));
         placeholderMap.put("commit.timestamp.hour", Lazy.by(() -> leftPad(String.valueOf(headCommitDateTime.get().getHour()), 2, "0")));