Document jreleaser/jreleaser#883

jreleaser · Aug 11, 2022 · 5299ca1 · 5299ca1
1 parent 4a21e4c
commit 5299ca1
Showing 1 changed file with 162 additions and 2 deletions.
diff --git a/docs/modules/configuration/pages/project.adoc b/docs/modules/configuration/pages/project.adoc
@@ -169,6 +169,34 @@ project:
     extraProperties:
       # Key will be capitalized and prefixed with `java`, i.e, `javaFoo`.
       foo: bar
+
+  # A list of screeenshots.
+  # icon:dot-circle[]
+  screenshots:
+      # Publicly available URL. PNG format is preferred.
+      # icon:exclamation-triangle[]
+    - url: pass:[https://acme.com/app.png]
+      # The type of image.
+      # Valid values are [`SOURCE`, `THUMBNAIL`].
+      # Defaults to `SOURCE`.
+      # icon:dot-circle[]
+      type: THUMBNAIL
+      # Marks this screenshot as the primary one.
+      # Only a single screenshot may be set as primary.
+      # icon:dot-circle[]
+      primary: true
+      # A description of the image.
+      # Should be no more than 100 characters long.
+      # icon:dot-circle[]
+      caption: App in action
+      # Image width in pixels.
+      # Required if type = `THUMBNAIL`.
+      # icon:dot-circle[]
+      width: 250
+      # Image height in pixels.
+      # Required if type = `THUMBNAIL`.
+      # icon:dot-circle[]
+      height: 250
 ----
 --
 TOML::
@@ -324,6 +352,34 @@ TOML::
   # icon:dot-circle[]
   java.extraProperties.foo = "bar"
   # Key will be capitalized and prefixed with `java`, i.e, `javaFoo`.
+
+  # A list of screeenshots.
+  # icon:dot-circle[]
+pass:[[][project.screenshots]]
+  # Publicly available URL. PNG format is preferred.
+  # icon:exclamation-triangle[]
+  url = "pass:[https://acme.com/app.png]"
+  # The type of image.
+  # Valid values are [`SOURCE`, `THUMBNAIL`].
+  # Defaults to `SOURCE`.
+  # icon:dot-circle[]
+  type = "THUMBNAIL"
+  # Marks this screenshot as the primary one.
+  # Only a single screenshot may be set as primary.
+  # icon:dot-circle[]
+  primary = true
+  # A description of the image.
+  # Should be no more than 100 characters long.
+  # icon:dot-circle[]
+  caption = "App in action"
+  # Image width in pixels.
+  # Required if type = `THUMBNAIL`.
+  # icon:dot-circle[]
+  width = 250
+  # Image height in pixels.
+  # Required if type = `THUMBNAIL`.
+  # icon:dot-circle[]
+  height = 250
 ----
 --
 JSON::
@@ -493,7 +549,37 @@ JSON::
         // Key will be capitalized and prefixed with `java`, i.e, `javaFoo`.
         "foo": "bar"
       }
-    }
+    },
+    // A list of screeenshots.
+    // icon:dot-circle[]
+    screenshots:[
+      {
+        // Publicly available URL. PNG format is preferred.
+        // icon:exclamation-triangle[]
+        "url": "pass:[https://acme.com/app.png]",
+        // The type of image.
+        // Valid values are [`SOURCE`, `THUMBNAIL`].
+        // Defaults to `SOURCE`.
+        // icon:dot-circle[]
+        "type": "THUMBNAIL",
+        // Marks this screenshot as the primary one.
+        // Only a single screenshot may be set as primary.
+        // icon:dot-circle[]
+        "primary": true,
+        // A description of the image.
+        // Should be no more than 100 characters long.
+        // icon:dot-circle[]
+        "caption": "App in action",
+        // Image width in pixels.
+        // Required if type = `THUMBNAIL`.
+        // icon:dot-circle[]
+        "width": 250,
+        // Image height in pixels.
+        // Required if type = `THUMBNAIL`.
+        // icon:dot-circle[]
+        "height": 250
+      }
+    ]
   }
 }
 ----
@@ -759,7 +845,52 @@ Maven::
         -->
         <foo>bar</foo>
       </extraProperties>
-    </java>  
+    </java>
+
+    <!--
+      A list of screeenshots.
+      icon:dot-circle[]
+    -->
+    <screenshots>
+      <screenshot>
+        <!--
+          Publicly available URL. PNG format is preferred.
+          icon:exclamation-triangle[]
+        -->
+        <url>pass:[https://acme.com/app.png]</url>
+        <!--
+          The type of image.
+          Valid values are [`SOURCE`, `THUMBNAIL`].
+          Defaults to `SOURCE`.
+          icon:dot-circle[]
+        -->
+        <type>THUMBNAIL</type>
+        <!--
+          Marks this screenshot as the primary one.
+          Only a single screenshot may be set as primary.
+          icon:dot-circle[]
+        -->
+        <primary>true</primary>
+        <!--
+          A description of the image.
+          Should be no more than 100 characters long.
+          icon:dot-circle[]
+        -->
+        <caption>App in action</caption>
+        <!--
+          Image width in pixels.
+          Required if type = `THUMBNAIL`.
+          icon:dot-circle[]
+        -->
+        <width>250</width>
+        <!--
+          Image height in pixels.
+          Required if type = `THUMBNAIL`.
+          icon:dot-circle[]
+        -->
+        <height>250</height>
+      </screenshot>
+    </screenshots>
   </project>
 </jreleaser>
 ----
@@ -930,6 +1061,35 @@ jreleaser {
       // icon:dot-circle[]
       extraProperties.put('foo', 'bar')
     }
+
+    // A list of screeenshots.
+    // icon:dot-circle[]
+    screenshot {
+      // Publicly available URL. PNG format is preferred.
+      // icon:exclamation-triangle[]
+      url = 'pass:[https://acme.com/app.png]'
+      // The type of image.
+      // Valid values are [`SOURCE`, `THUMBNAIL`].
+      // Defaults to `SOURCE`.
+      // icon:dot-circle[]
+      screenshotType = THUMBNAIL
+      // Marks this screenshot as the primary one.
+      // Only a single screenshot may be set as primary.
+      // icon:dot-circle[]
+      primary = true
+      // A description of the image.
+      // Should be no more than 100 characters long.
+      // icon:dot-circle[]
+      caption = 'App in action'
+      // Image width in pixels.
+      // Required if type = `THUMBNAIL`.
+      // icon:dot-circle[]
+      width = 250
+      // Image height in pixels.
+      // Required if type = `THUMBNAIL`.
+      // icon:dot-circle[]
+      height = 250
+    }
   }
 }
 ----