Document jreleaser/jreleaser#1774

jreleaser · Dec 6, 2024 · d60cee2 · d60cee2
1 parent 1b90883
commit d60cee2
Show file tree

Hide file tree

Showing 5 changed files with 1,247 additions and 9 deletions.
diff --git a/docs/modules/reference/nav.adoc b/docs/modules/reference/nav.adoc
@@ -57,6 +57,7 @@
 ** xref:hooks/index.adoc[]
 *** xref:hooks/command.adoc[]
 *** xref:hooks/script.adoc[]
+** xref:matrix.adoc[]
 ** xref:name-templates.adoc[]
 ** xref:packagers/index.adoc[]
 *** xref:packagers/appimage.adoc[]

diff --git a/docs/modules/reference/pages/assemble/archive.adoc b/docs/modules/reference/pages/assemble/archive.adoc
@@ -49,6 +49,24 @@ include::partial$assemble/yaml/common-head.adoc[]
         - ZIP
         - TGZ
 
+      # Includes the default matrix.
+      # icon:dot-circle[]
+      applyDefaultMatrix: false
+
+      # Configures matrix variables.
+      # icon:dot-circle[]
+      matrix:
+        vars:
+          os: [ linux, osx, windows ]
+          arch: [ arm64, amd64 ]
+        rows:
+          - { os: linux, arch: arm64 }
+          - { os: linux, arch: amd64 }
+          - { os: osx, arch: arm64 }
+          - { os: osx, arch: amd64 }
+          - { os: windows, arch: arm64 }
+          - { os: windows, arch: amd64 }
+
 include::partial$assemble/yaml/common-archive-options.adoc[]
 
 include::partial$assemble/yaml/common-assembler.adoc[]
@@ -86,6 +104,21 @@ include::partial$assemble/toml/common-head.adoc[]
   # icon:dot-circle[]
   formats = [ "ZIP", "TGZ"]
 
+  # Includes the default matrix.
+  # icon:dot-circle[]
+  applyDefaultMatrix = false
+
+  # Configures matrix variables.
+  # icon:dot-circle[]
+  matrix.vars.os = [ "linux", "osx", "windows" ]
+  matrix.vars.arch= [ "arm64", "amd64" ]
+  rows = [{ os = "linux", arch = "arm64" },
+          { os = "linux", arch = "amd64" },
+          { os = "osx", arch = "arm64" },
+          { os = "osx", arch = "amd64" },
+          { os = "windows", arch = "arm64" },
+          { os = "windows", arch = "amd64" }]
+
 include::partial$assemble/toml/common-archive-options.adoc[]
 
 include::partial$assemble/toml/common-assembler.adoc[]
@@ -126,6 +159,27 @@ include::partial$assemble/json/common-head.adoc[]
            "TGZ"
         ],
 
+        // Includes the default matrix.
+        // icon:dot-circle[]
+        "applyDefaultMatrix": false,
+
+        // Configures matrix variables.
+        // icon:dot-circle[]
+        "matrix": {
+          "vars": {
+            "os": [ "linux", "osx", "windows" ],
+            "arch": [ "arm64", "amd64" ]
+          },
+          "rows": [
+            { "os": "linux", "arch": "arm64" },
+            { "os": "linux", "arch": "amd64" },
+            { "os": "osx", "arch": "arm64" },
+            { "os": "osx", "arch": "amd64" },
+            { "os": "windows", "arch": "arm64" },
+            { "os": "windows", "arch": "amd64" }
+          ]
+        }
+
 include::partial$assemble/json/common-archive-options.adoc[]
 
 include::partial$assemble/json/common-assembler.adoc[]
@@ -175,6 +229,56 @@ include::partial$assemble/maven/common-head.adoc[]
           <format>TGZ</format>
         </formats>
 
+        <!--
+          Includes the default matrix.
+          icon:dot-circle[]
+        -->
+        <applyDefaultMatrix>false</applyDefaultMatrix>
+
+        <!--
+          Configures matrix variables.
+          icon:dot-circle[]
+        -->
+        <matrix>
+          <vars>
+            <os>
+              <e>linux</e>
+              <e>osx</e>
+              <e>windows</e>
+            </os>
+            <arch>
+              <e>arm64</e>
+              <e>amd64</e>
+            </arch>
+          </vars>
+          <rows>
+            <row>
+              <os>linux</os>
+              <arch>arm64</arch>
+            </row>
+            <row>
+              <os>linux</os>
+              <arch>amd64</arch>
+            </row>
+            <row>
+              <os>osx</os>
+              <arch>arm64</arch>
+            </row>
+            <row>
+              <os>osx</os>
+              <arch>amd64</arch>
+            </row>
+            <row>
+              <os>windows</os>
+              <arch>arm64</arch>
+            </row>
+            <row>
+              <os>windows</os>
+              <arch>amd64</arch>
+            </row>
+          </rows>
+        </matrix>
+
 include::partial$assemble/maven/common-archive-options.adoc[]
 
 include::partial$assemble/maven/common-assembler.adoc[]
@@ -216,6 +320,24 @@ include::partial$assemble/gradle/common-head.adoc[]
             'TGZ'
         ]
 
+       // Includes the default matrix.
+       // icon:dot-circle[]
+       applyDefaultMatrix = false
+
+       // Configures matrix variables.
+       // icon:dot-circle[]
+       matrix {
+         variable('os', ['linux', 'osx', 'windows'])
+         variable('arch', ['arm64', 'amd64'])
+
+         row(os: 'linux', arch: 'arm64')
+         row(os: 'linux', arch: 'amd64')
+         row(os: 'osx', arch: 'arm64')
+         row(os: 'osx', arch: 'amd64')
+         row(os: 'windows', arch: 'arm64')
+         row(os: 'windows', arch: 'amd64')
+       }
+
 include::partial$assemble/gradle/common-archive-options.adoc[]
 
 include::partial$assemble/gradle/common-assembler.adoc[]