Document jreleaser/jreleaser#901

jreleaser · Aug 15, 2022 · b62bacc · b62bacc
1 parent e9633cc
commit b62bacc
Show file tree

Hide file tree

Showing 3 changed files with 270 additions and 5 deletions.
diff --git a/docs/modules/configuration/pages/name-templates.adoc b/docs/modules/configuration/pages/name-templates.adoc
@@ -1101,6 +1101,7 @@ The following names are related to xref:configuration:packagers/appimage.adoc[]
 | appImageReleases                     | list of releases
 | appImageUrls                         | list of links
 | appImageScreenshots                  | list of screenshots
+| appImageIcons                        | list of icons
 | appImageDistributionUrl              | the URL required to download the artifact
 | appImageDistributionArtifactFile     | the name of the artifact file
 | appImageDistributionArtifactFileName | the name of the artifact file without extension

diff --git a/docs/modules/configuration/pages/packagers/appimage.adoc b/docs/modules/configuration/pages/packagers/appimage.adoc
@@ -97,6 +97,29 @@ include::partial$packagers/yaml/tap.adoc[]
         extraProperties:
           # Key will be capitalized and prefixed with `screenshot`, i.e, `screenshotFoo`.
           foo: bar
+
+    # A list of icons.
+    # If undefined, defaults to `${project.icons}`.
+    # icon:dot-circle[]
+    icons:
+        # Publicly available URL. PNG format is preferred.
+        # icon:exclamation-triangle[] icon:file-alt[]
+      - url: pass:[https://acme.com/app.png]
+        # Marks this icon as the primary one.
+        # Only a single icon may be set as primary.
+        # icon:dot-circle[]
+        primary: true
+        # Image width in pixels.
+        # icon:exclamation-triangle[]
+        width: 250
+        # Image height in pixels.
+        # icon:exclamation-triangle[]
+        height: 250
+        # Additional properties used when evaluating templates.
+        # icon:dot-circle[] icon:file-alt[]
+        extraProperties:
+          # Key will be capitalized and prefixed with `icon`, i.e, `iconFoo`.
+          foo: bar
 ----
 --
 TOML::
@@ -166,6 +189,28 @@ include::partial$packagers/toml/tap.adoc[]
     # icon:dot-circle[] icon:file-alt[]
     extraProperties.foo = "bar"
     # Key will be capitalized and prefixed with `screenshot`, i.e, `screenshotFoo`.
+
+  # A list of icons.
+  # If undefined, defaults to `${project.icons}`.
+  # icon:dot-circle[]
+  pass:[[][packagers.{tool_id}.icons]]
+    # Publicly available URL. PNG format is preferred.
+    # icon:exclamation-triangle[] icon:file-alt[]
+    url = "pass:[https://acme.com/app.png]"
+    # Marks this icon as the primary one.
+    # Only a single icon may be set as primary.
+    # icon:dot-circle[]
+    primary = true
+    # Image width in pixels.
+    # icon:exclamation-triangle[]
+    width = 250
+    # Image height in pixels.
+    # icon:exclamation-triangle[]
+    height = 250
+    # Additional properties used when evaluating templates.
+    # icon:dot-circle[] icon:file-alt[]
+    extraProperties.foo = "bar"
+    # Key will be capitalized and prefixed with `icon`, i.e, `iconFoo`.
 ----
 --
 JSON::
@@ -241,6 +286,32 @@ include::partial$packagers/json/tap.adoc[]
             "foo": "bar"
           }
         }
+      ],
+      // A list of icons.
+      // If undefined, defaults to `${project.icons}`.
+      // icon:dot-circle[]
+      icons: [
+        {
+          // Publicly available URL. PNG format is preferred.
+          // icon:exclamation-triangle[] icon:file-alt[]
+          "url": "pass:[https://acme.com/app.png]",
+          // Marks this icon as the primary one.
+          // Only a single icon may be set as primary.
+          // icon:dot-circle[]
+          "primary": true,
+          // Image width in pixels.
+          // icon:exclamation-triangle[]
+          "width": 250,
+          // Image height in pixels.
+          // icon:exclamation-triangle[]
+          "height": 250,
+          // Additional properties used when evaluating templates.
+          // icon:dot-circle[] icon:file-alt[]
+          "extraProperties": {
+            // Key will be capitalized and prefixed with `icon`, i.e, `iconFoo`.
+            "foo": "bar"
+          }
+        }
       ]
 include::partial$packagers/json/common-footer.adoc[]
 ----
@@ -345,6 +416,47 @@ include::partial$packagers/maven/tap.adoc[]
           </extraProperties>
         </screenshot>
       </screenshots>
+
+      <!--
+        A list of icons.
+        If undefined, defaults to `${project.icons}`.
+        icon:dot-circle[]
+      -->
+      <icons>
+        <icon>
+          <!--
+            Publicly available URL. PNG format is preferred.
+            icon:exclamation-triangle[] icon:file-alt[]
+          -->
+          <url>pass:[https://acme.com/app.png]</url>
+          <!--
+            Marks this icon as the primary one.
+            Only a single icon may be set as primary.
+            icon:dot-circle[]
+          -->
+          <primary>true</primary>>
+          <!--
+            Image width in pixels.
+            icon:exclamation-triangle[]
+          -->
+          <width>250</width>
+          <!--
+            Image height in pixels.
+            icon:exclamation-triangle[]
+          -->
+          <height>250</height>
+          <!--
+            Additional properties used when evaluating templates.
+            icon:dot-circle[] icon:file-alt[]
+          -->
+          <extraProperties>
+            <!--
+              Key will be capitalized and prefixed with `icon`, i.e, `iconFoo`.
+            -->
+            <foo>bar</foo>
+          </extraProperties>
+        </icon>
+      </icons>
 include::partial$packagers/maven/common-footer.adoc[]
 ----
 --
@@ -416,6 +528,29 @@ include::partial$packagers/gradle/tap.adoc[]
         // icon:dot-circle[] icon:file-alt[]
         extraProperties.put('foo', 'bar')
       }
+
+      // A list of icons.
+      // If undefined, defaults to `${project.icons}`.
+      // icon:dot-circle[]
+      icon {
+        // Publicly available URL. PNG format is preferred.
+        // icon:exclamation-triangle[] icon:file-alt[]
+        url = 'pass:[https://acme.com/app.png]'
+        // Marks this icon as the primary one.
+        // Only a single icon may be set as primary.
+        // icon:dot-circle[]
+        primary = true
+        // Image width in pixels.
+        // icon:exclamation-triangle[]
+        width = 250
+        // Image height in pixels.
+        // icon:exclamation-triangle[]
+        height = 250
+        // Additional properties used when evaluating templates.
+        // Key will be capitalized and prefixed with `icon`, i.e, `icon`.
+        // icon:dot-circle[] icon:file-alt[]
+        extraProperties.put('foo', 'bar')
+      }
 include::partial$packagers/gradle/common-footer.adoc[]
 ----
 --
@@ -434,6 +569,10 @@ artifact to mark it as skipped for packaging with AppImage.
 
 You may add a `skipAppImage` extra property to a target screenshot to mark it as skipped for packaging with AppImage.
 
+== Skip Icons
+
+You may add a `skipAppImage` extra property to a target icon to mark it as skipped for packaging with AppImage.
+
 == Templates
 
 The default location for templates is:
@@ -474,6 +613,4 @@ any of these expressions to skip a template named `README.md.tpl`:
 
 == Icon
 
-You can override the default icon by placing a file named `app.png` inside `${templateDirectory}/icons`. This file is
-expected to be 128 by 128 pixels, iin color. Should you 'd like to use additional icons then place them alongside
-`app.png` and upadte `create-appimage.sh` to include these icons.
+You must define at least one icon. A square (128x128 pixels) image in PNG format is preferred.
diff --git a/docs/modules/configuration/pages/project.adoc b/docs/modules/configuration/pages/project.adoc
@@ -203,12 +203,33 @@ 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
+
+  # A list of icons.
+  # icon:dot-circle[]
+  icons:
+      # Publicly available URL. PNG format is preferred.
+      # icon:exclamation-triangle[] icon:file-alt[]
+    - url: pass:[https://acme.com/app.png]
+      # Marks this icon as the primary one.
+      # Only a single icon may be set as primary.
+      # icon:dot-circle[]
+      primary: true
+      # Image width in pixels.
+      # icon:exclamation-triangle[]
+      width: 250
+      # Image height in pixels.
+      # icon:exclamation-triangle[]
+      height: 250
+      # Additional properties used when evaluating templates.
+      # icon:dot-circle[] icon:file-alt[]
+      extraProperties:
+        # Key will be capitalized and prefixed with `icon`, i.e, `iconFoo`.
+        foo: bar
 ----
 --
 TOML::
@@ -397,11 +418,31 @@ 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`.
+
+  # A list of icons.
+  # icon:dot-circle[]
+pass:[[][project.icons]]
+  # Publicly available URL. PNG format is preferred.
+  # icon:exclamation-triangle[] icon:file-alt[]
+  url = "pass:[https://acme.com/app.png]"
+  # Marks this icon as the primary one.
+  # Only a single icon may be set as primary.
+  # icon:dot-circle[]
+  primary = true
+  # Image width in pixels.
+  # icon:exclamation-triangle[]
+  width = 250
+  # Image height in pixels.
+  # icon:exclamation-triangle[]
+  height = 250
+  # Additional properties used when evaluating templates.
+  # icon:dot-circle[] icon:file-alt[]
+  extraProperties.foo = "bar"
+  # Key will be capitalized and prefixed with `icon`, i.e, `iconFoo`.
 ----
 --
 JSON::
@@ -614,6 +655,31 @@ JSON::
           "foo": "bar"
         }
       }
+    ],
+    // A list of icons.
+    // icon:dot-circle[]
+    icons: [
+      {
+        // Publicly available URL. PNG format is preferred.
+        // icon:exclamation-triangle[] icon:file-alt[]
+        "url": "pass:[https://acme.com/app.png]",
+        // Marks this icon as the primary one.
+        // Only a single icon may be set as primary.
+        // icon:dot-circle[]
+        "primary": true,
+        // Image width in pixels.
+        // icon:exclamation-triangle[]
+        "width": 250,
+        // Image height in pixels.
+        // icon:exclamation-triangle[]
+        "height": 250,
+        // Additional properties used when evaluating templates.
+        // icon:dot-circle[] icon:file-alt[]
+        "extraProperties": {
+          // Key will be capitalized and prefixed with `icon`, i.e, `iconFoo`.
+          "foo": "bar"
+        }
+      }
     ]
   }
 }
@@ -945,6 +1011,45 @@ Maven::
         </extraProperties>
       </screenshot>
     </screenshots>
+    <!--
+      A list of icons.
+      icon:dot-circle[]
+    -->
+    <icons>
+      <icon>
+        <!--
+          Publicly available URL. PNG format is preferred.
+          icon:exclamation-triangle[] icon:file-alt[]
+        -->
+        <url>pass:[https://acme.com/app.png]</url>
+        <!--
+          Marks this icon as the primary one.
+          Only a single icon may be set as primary.
+          icon:dot-circle[]
+        -->
+        <primary>true</primary>
+        <!--
+          Image width in pixels.
+          icon:exclamation-triangle[]
+        -->
+        <width>250</width>
+        <!--
+          Image height in pixels.
+          icon:exclamation-triangle[]
+        -->
+        <height>250</height>
+        <!--
+          Additional properties used when evaluating templates.
+          icon:dot-circle[] icon:file-alt[]
+        -->
+        <extraProperties>
+          <!--
+            Key will be capitalized and prefixed with `icon`, i.e, `iconFoo`.
+          -->
+          <foo>bar</foo>
+        </extraProperties>
+      </icon>
+    </icons>
   </project>
 </jreleaser>
 ----
@@ -1153,6 +1258,28 @@ jreleaser {
       // icon:dot-circle[] icon:file-alt[]
       extraProperties.put('foo', 'bar')
     }
+
+    // A list of icons.
+    // icon:dot-circle[]
+    icon {
+      // Publicly available URL. PNG format is preferred.
+      // icon:exclamation-triangle[] icon:file-alt[]
+      url = 'pass:[https://acme.com/app.png]'
+      // Marks this icon as the primary one.
+      // Only a single icon may be set as primary.
+      // icon:dot-circle[]
+      primary = true
+      // Image width in pixels.
+      // icon:exclamation-triangle[]
+      width = 250
+      // Image height in pixels.
+      // icon:exclamation-triangle[]
+      height = 250
+      // Additional properties used when evaluating templates.
+      // Key will be capitalized and prefixed with `icon`, i.e, `icon`.
+      // icon:dot-circle[] icon:file-alt[]
+      extraProperties.put('foo', 'bar')
+    }
   }
 }
 ----