Document jreleaser/jreleaser#1670

jreleaser · Jun 10, 2024 · 1426bfd · 1426bfd
1 parent 5319d05
commit 1426bfd
Show file tree

Hide file tree

Showing 7 changed files with 234 additions and 13 deletions.
diff --git a/docs/modules/reference/pages/name-templates.adoc b/docs/modules/reference/pages/name-templates.adoc
@@ -637,7 +637,16 @@ The following names are related to xref:reference:distributions.adoc[]
 | distributionJavaMainClass     | the main class launched by the executable script launcher
 | distributionJavaMainJar       | the main jar launched by the executable script launcher
 | distributionJavaMainModule    | the module used by the executable script launcher
-| distributionJavaOptions       | the jvm custom settings used by the executable script launcher
+| distributionJavaJvmOptionsUniversal | JVM custom settings used by the executable script launcher
+| distributionJavaJvmOptionsUnix      | JVM custom settings used by the executable script launcher
+| distributionJavaJvmOptionsLinux     | JVM custom settings used by the executable script launcher
+| distributionJavaJvmOptionsOsx       | JVM custom settings used by the executable script launcher
+| distributionJavaJvmOptionsWindows   | JVM custom settings used by the executable script launcher
+| distributionJavaEnvironmentVariablesUniversal | Environment variables used by the executable script launcher
+| distributionJavaEnvironmentVariablesUnix      | Environment variables used by the executable script launcher
+| distributionJavaEnvironmentVariablesLinux     | Environment variables used by the executable script launcher
+| distributionJavaEnvironmentVariablesOsx       | Environment variables used by the executable script launcher
+| distributionJavaEnvironmentVariablesWindows   | Environment variables used by the executable script launcher
 |===
 
 Additionally, every key/value from `distribution.<name>.extraProperties` is mapped with `distribution` as key prefix

diff --git a/docs/modules/reference/pages/project.adoc b/docs/modules/reference/pages/project.adoc
@@ -163,7 +163,27 @@ project:
 
     # Options to pass to the Java runtime
     # icon:dot-circle[]
-    options: [-Xmx2048m]
+    jvmOptions:
+      # Included in all scripts
+      # icon:dot-circle[] icon:file-alt[]
+      universal:
+        - -Dprop=value
+      # Included in all non Windows scripts
+      # icon:dot-circle[] icon:file-alt[]
+      unix:
+        - -Dprop=value
+      # Included in all non Windows (except OSX) scripts
+      # icon:dot-circle[] icon:file-alt[]
+      linux:
+        - -Dprop=value
+      # Included only in OSX scripts
+      # icon:dot-circle[] icon:file-alt[]
+      osx:
+        - -Dprop=value
+      # Included in Windows scripts
+      # icon:dot-circle[] icon:file-alt[]
+      windows:
+        - -Dprop=value
 
     # Identifies the project as being member of a multi-project build.
     # Defaults to `false`.
@@ -400,8 +420,26 @@ TOML::
   java.mainClass = "com.acme.Main"
 
   # Options to pass to the Java runtime
-  # icon:dot-circle[]
-  java.options = ["-Xmx2048m"]
+
+  # Included in all scripts
+  # icon:dot-circle[] icon:file-alt[]
+  java.jvmOptions.universal = ["-Dprop=value"]
+
+  # Included in all non Windows scripts
+  # icon:dot-circle[] icon:file-alt[]
+  java.jvmOptions.unix = ["-Dprop=value"]
+
+  # Included in all non Windows (except OSX) scripts
+  # icon:dot-circle[] icon:file-alt[]
+  java.jvmOptions.linux = ["-Dprop=value"]
+
+  # Included only in OSX scripts
+  # icon:dot-circle[] icon:file-alt[]
+  java.jvmOptions.osx = ["-Dprop=value"]
+
+  # Included in Windows scripts
+  # icon:dot-circle[] icon:file-alt[]
+  java.jvmOptions.windows = ["-Dprop=value"]
 
   # Identifies the project as being member of a multi-project build.
   # Defaults to `false`.
@@ -648,7 +686,33 @@ JSON::
 
       // Options to pass to the Java runtime
       // icon:dot-circle[]
-      "options": ["-Xmx2048m"],
+      "jvmOptions": {
+        // Included in all scripts
+        // icon:dot-circle[] icon:file-alt[]
+        "universal": [
+          "-Dprop=value"
+        ],
+        // Included in all non Windows scripts
+        // icon:dot-circle[] icon:file-alt[]
+        "unix": [
+          "-Dprop=value"
+        ],
+        // Included in all non Windows (except OSX) scripts
+        // icon:dot-circle[] icon:file-alt[]
+        "linux": [
+          "-Dprop=value"
+        ],
+        // Included only in OSX scripts
+        // icon:dot-circle[] icon:file-alt[]
+        "osx": [
+          "-Dprop=value"
+        ],
+        // Included in Windows scripts
+        // icon:dot-circle[] icon:file-alt[]
+        "windows": [
+          "-Dprop=value"
+        ]
+      },
 
       // Identifies the project as being member of a multi-project build.
       // Defaults to `false`.
@@ -1008,7 +1072,33 @@ Maven::
         Options to pass to the Java runtime
         icon:dot-circle[]
       -->
-      <options>-Xmx2048m</options>
+      <jvmOptions>
+        <!--
+          Included in all scripts
+          icon:dot-circle[] icon:file-alt[]
+        -->
+        <universal>-Dprop=value</universal>
+        <!--
+          Included in all non Windows scripts
+          icon:dot-circle[] icon:file-alt[]
+        -->
+        <unix>-Dprop=value</unix>
+        <!--
+          Included in all non Windows (except OSX) scripts
+          icon:dot-circle[] icon:file-alt[]
+        -->
+        <linux>-Dprop=value</linux>
+        <!--
+          Included only in OSX scripts
+          icon:dot-circle[] icon:file-alt[]
+        -->
+        <osx>-Dprop=value</osx>
+        <!--
+          Included in Windows scripts
+          icon:dot-circle[] icon:file-alt[]
+        -->
+        <windows>-Dprop=value</windows>
+      </jvmOptions>
 
       <!--
         Identifies the project as being member of a multi-project build.
@@ -1324,7 +1414,23 @@ jreleaser {
 
       // Options to pass to the Java runtime
       // icon:dot-circle[]
-      options = ['-Xmx2048m']
+      jvmOptions {
+        // Included in all scripts
+        // icon:dot-circle[] icon:file-alt[]
+        universal('-Dprop=value')
+        // Included in all non Windows scripts
+        // icon:dot-circle[] icon:file-alt[]
+        unix('-Dprop=value')
+        // Included in all non Windows (except OSX) scripts
+        // icon:dot-circle[] icon:file-alt[]
+        linux('-Dprop=value')
+        // Included only in OSX scripts
+        // icon:dot-circle[] icon:file-alt[]
+        osx('-Dprop=value')
+        // Included in Windows scripts
+        // icon:dot-circle[] icon:file-alt[]
+        windows('-Dprop=value')
+      }
 
       // Identifies the project as being member of a multi-project build.
       // Defaults to `false`.

diff --git a/docs/modules/reference/partials/assemble/gradle/common-java.adoc b/docs/modules/reference/partials/assemble/gradle/common-java.adoc
@@ -27,7 +27,23 @@
 
           // Options to pass to the Java runtime
           // icon:dot-circle[]
-          options = ['-Xmx2048m']
+          jvmOptions {
+            // Included in all scripts
+            // icon:dot-circle[] icon:file-alt[]
+            universal('-Dprop=value')
+            // Included in all non Windows scripts
+            // icon:dot-circle[] icon:file-alt[]
+            unix('-Dprop=value')
+            // Included in all non Windows (except OSX) scripts
+            // icon:dot-circle[] icon:file-alt[]
+            linux('-Dprop=value')
+            // Included only in OSX scripts
+            // icon:dot-circle[] icon:file-alt[]
+            osx('-Dprop=value')
+            // Included in Windows scripts
+            // icon:dot-circle[] icon:file-alt[]
+            windows('-Dprop=value')
+          }
 
           // Environment variables used in launch scripts.
           // icon:dot-circle[]

diff --git a/docs/modules/reference/partials/assemble/json/common-java.adoc b/docs/modules/reference/partials/assemble/json/common-java.adoc
@@ -29,7 +29,33 @@
 
           // Options to pass to the Java runtime
           // icon:dot-circle[]
-          "options": ["-Xmx2048m"],
+          "jvmOptions": {
+            // Included in all scripts
+            // icon:dot-circle[] icon:file-alt[]
+            "universal": [
+              "-Dprop=value"
+            ],
+            // Included in all non Windows scripts
+            // icon:dot-circle[] icon:file-alt[]
+            "unix": [
+              "-Dprop=value"
+            ],
+            // Included in all non Windows (except OSX) scripts
+            // icon:dot-circle[] icon:file-alt[]
+            "linux": [
+              "-Dprop=value"
+            ],
+            // Included only in OSX scripts
+            // icon:dot-circle[] icon:file-alt[]
+            "osx": [
+              "-Dprop=value"
+            ],
+            // Included in Windows scripts
+            // icon:dot-circle[] icon:file-alt[]
+            "windows": [
+              "-Dprop=value"
+            ]
+          },
 
           // Environment variables used in launch scripts.
           // icon:dot-circle[]

diff --git a/docs/modules/reference/partials/assemble/maven/common-java.adoc b/docs/modules/reference/partials/assemble/maven/common-java.adoc
@@ -43,7 +43,33 @@
             Options to pass to the Java runtime
             icon:dot-circle[]
           -->
-          <options>-Xmx2048m</options>
+          <jvmOptions>
+            <!--
+              Included in all scripts
+              icon:dot-circle[] icon:file-alt[]
+            -->
+            <universal>-Dprop=value</universal>
+            <!--
+              Included in all non Windows scripts
+              icon:dot-circle[] icon:file-alt[]
+            -->
+            <unix>-Dprop=value</unix>
+            <!--
+              Included in all non Windows (except OSX) scripts
+              icon:dot-circle[] icon:file-alt[]
+            -->
+            <linux>-Dprop=value</linux>
+            <!--
+              Included only in OSX scripts
+              icon:dot-circle[] icon:file-alt[]
+            -->
+            <osx>-Dprop=value</osx>
+            <!--
+              Included in Windows scripts
+              icon:dot-circle[] icon:file-alt[]
+            -->
+            <windows>-Dprop=value</windows>
+          </jvmOptions>
 
           <!--
             Environment variables used in launch scripts.

diff --git a/docs/modules/reference/partials/assemble/toml/common-java.adoc b/docs/modules/reference/partials/assemble/toml/common-java.adoc
@@ -21,8 +21,26 @@
   java.mainClass = "com.acme.Main"
 
   # Options to pass to the Java runtime
-  # icon:dot-circle[]
-  java.options = ["-Xmx2048m"]
+
+  # Included in all scripts
+  # icon:dot-circle[] icon:file-alt[]
+  java.jvmOptions.universal = ["-Dprop=value"]
+
+  # Included in all non Windows scripts
+  # icon:dot-circle[] icon:file-alt[]
+  java.jvmOptions.unix = ["-Dprop=value"]
+
+  # Included in all non Windows (except OSX) scripts
+  # icon:dot-circle[] icon:file-alt[]
+  java.jvmOptions.linux = ["-Dprop=value"]
+
+  # Included only in OSX scripts
+  # icon:dot-circle[] icon:file-alt[]
+  java.jvmOptions.osx = ["-Dprop=value"]
+
+  # Included in Windows scripts
+  # icon:dot-circle[] icon:file-alt[]
+  java.jvmOptions.windows = ["-Dprop=value"]
 
   # Environment variables used in launch scripts.
 

diff --git a/docs/modules/reference/partials/assemble/yaml/common-java.adoc b/docs/modules/reference/partials/assemble/yaml/common-java.adoc
@@ -25,7 +25,27 @@
 
         # Options to pass to the Java runtime
         # icon:dot-circle[]
-        options: [-Xmx2048m]
+        jvmOptions:
+          # Included in all scripts
+          # icon:dot-circle[] icon:file-alt[]
+          universal:
+            - -Dprop=value
+          # Included in all non Windows scripts
+          # icon:dot-circle[] icon:file-alt[]
+          unix:
+            - -Dprop=value
+          # Included in all non Windows (except OSX) scripts
+          # icon:dot-circle[] icon:file-alt[]
+          linux:
+            - -Dprop=value
+          # Included only in OSX scripts
+          # icon:dot-circle[] icon:file-alt[]
+          osx:
+            - -Dprop=value
+          # Included in Windows scripts
+          # icon:dot-circle[] icon:file-alt[]
+          windows:
+            - -Dprop=value
 
         # Environment variables used in launch scripts.
         # icon:dot-circle[]