Document jreleaser/jreleaser#900

jreleaser · Aug 15, 2022 · 6827227 · 6827227
1 parent 6ca5c66
commit 6827227
Show file tree

Hide file tree

Showing 2 changed files with 66 additions and 2 deletions.
diff --git a/docs/modules/configuration/pages/packagers/appimage.adoc b/docs/modules/configuration/pages/packagers/appimage.adoc
@@ -92,6 +92,11 @@ include::partial$packagers/yaml/tap.adoc[]
         # Required if type = `THUMBNAIL`.
         # icon:dot-circle[]
         height: 250
+        # Additional properties used when evaluating templates.
+        # icon:dot-circle[] icon:file-alt[]
+        extraProperties:
+          # Key will be capitalized and prefixed with `screenshot`, i.e, `screenshotFoo`.
+          foo: bar
 ----
 --
 TOML::
@@ -157,6 +162,10 @@ include::partial$packagers/toml/tap.adoc[]
     # Required if type = `THUMBNAIL`.
     # icon:dot-circle[]
     height = 250
+    # Additional properties used when evaluating templates.
+    # icon:dot-circle[] icon:file-alt[]
+    extraProperties.foo = "bar"
+    # Key will be capitalized and prefixed with `screenshot`, i.e, `screenshotFoo`.
 ----
 --
 JSON::
@@ -224,7 +233,13 @@ include::partial$packagers/json/tap.adoc[]
           // Image height in pixels.
           // Required if type = `THUMBNAIL`.
           // icon:dot-circle[]
-          "height": 250
+          "height": 250,
+          // Additional properties used when evaluating templates.
+          // icon:dot-circle[] icon:file-alt[]
+          "extraProperties": {
+            // Key will be capitalized and prefixed with `screenshot`, i.e, `screenshotFoo`.
+            "foo": "bar"
+          }
         }
       ]
 include::partial$packagers/json/common-footer.adoc[]
@@ -318,6 +333,16 @@ include::partial$packagers/maven/tap.adoc[]
             icon:dot-circle[]
           -->
           <height>250</height>
+          <!--
+            Additional properties used when evaluating templates.
+            icon:dot-circle[] icon:file-alt[]
+          -->
+          <extraProperties>
+            <!--
+              Key will be capitalized and prefixed with `screenshot`, i.e, `screenshotFoo`.
+            -->
+            <foo>bar</foo>
+          </extraProperties>
         </screenshot>
       </screenshots>
 include::partial$packagers/maven/common-footer.adoc[]
@@ -386,6 +411,10 @@ include::partial$packagers/gradle/tap.adoc[]
         // Required if type = `THUMBNAIL`.
         // icon:dot-circle[]
         height = 250
+        // Additional properties used when evaluating templates.
+        // Key will be capitalized and prefixed with `screenshot`, i.e, `screenshot`.
+        // icon:dot-circle[] icon:file-alt[]
+        extraProperties.put('foo', 'bar')
       }
 include::partial$packagers/gradle/common-footer.adoc[]
 ----
@@ -401,6 +430,10 @@ include::partial$packagers/downloadUrl.adoc[]
 If there is more than one matching artifact in a given distribution you may add a `skipAppImage` extra property to the target
 artifact to mark it as skipped for packaging with AppImage.
 
+== Skip Screenshots
+
+You may add a `skipAppImage` extra property to a target screenshot to mark it as skipped for packaging with AppImage.
+
 == Templates
 
 The default location for templates is:

diff --git a/docs/modules/configuration/pages/project.adoc b/docs/modules/configuration/pages/project.adoc
@@ -203,6 +203,12 @@ project:
       # Required if type = `THUMBNAIL`.
       # icon:dot-circle[]
       height: 250
+
+      # Additional properties used when evaluating templates.
+      # icon:dot-circle[] icon:file-alt[]
+      extraProperties:
+        # Key will be capitalized and prefixed with `screenshot`, i.e, `screenshotFoo`.
+        foo: bar
 ----
 --
 TOML::
@@ -391,6 +397,11 @@ pass:[[][project.screenshots]]
   # Required if type = `THUMBNAIL`.
   # icon:dot-circle[]
   height = 250
+
+  # Additional properties used when evaluating templates.
+  # icon:dot-circle[] icon:file-alt[]
+  extraProperties.foo = "bar"
+  # Key will be capitalized and prefixed with `screenshot`, i.e, `screenshotFoo`.
 ----
 --
 JSON::
@@ -595,7 +606,13 @@ JSON::
         // Image height in pixels.
         // Required if type = `THUMBNAIL`.
         // icon:dot-circle[]
-        "height": 250
+        "height": 250,
+        // Additional properties used when evaluating templates.
+        // icon:dot-circle[] icon:file-alt[]
+        "extraProperties": {
+          // Key will be capitalized and prefixed with `screenshot`, i.e, `screenshotFoo`.
+          "foo": "bar"
+        }
       }
     ]
   }
@@ -916,6 +933,16 @@ Maven::
           icon:dot-circle[]
         -->
         <height>250</height>
+        <!--
+          Additional properties used when evaluating templates.
+          icon:dot-circle[] icon:file-alt[]
+        -->
+        <extraProperties>
+          <!--
+            Key will be capitalized and prefixed with `screenshot`, i.e, `screenshotFoo`.
+          -->
+          <foo>bar</foo>
+        </extraProperties>
       </screenshot>
     </screenshots>
   </project>
@@ -1121,6 +1148,10 @@ jreleaser {
       // Required if type = `THUMBNAIL`.
       // icon:dot-circle[]
       height = 250
+      // Additional properties used when evaluating templates.
+      // Key will be capitalized and prefixed with `screenshot`, i.e, `screenshot`.
+      // icon:dot-circle[] icon:file-alt[]
+      extraProperties.put('foo', 'bar')
     }
   }
 }