Document jreleaser/jreleaser#1671

jreleaser · Jun 7, 2024 · 5319d05 · 5319d05
1 parent ae2e639
commit 5319d05
Show file tree

Hide file tree

Showing 6 changed files with 276 additions and 0 deletions.
diff --git a/docs/modules/reference/pages/project.adoc b/docs/modules/reference/pages/project.adoc
@@ -170,6 +170,30 @@ project:
     # icon:dot-circle[]
     multiProject: false
 
+    # Environment variables used in launch scripts.
+    # icon:dot-circle[]
+    environmentVariables:
+      # Included in all scripts
+      # icon:dot-circle[] icon:file-alt[]
+      universal:
+        KEY: value
+      # Included in all non Windows scripts
+      # icon:dot-circle[] icon:file-alt[]
+      unix:
+        KEY: value
+      # Included in all non Windows (except OSX) scripts
+      # icon:dot-circle[] icon:file-alt[]
+      linux:
+        KEY: value
+      # Included only in OSX scripts
+      # icon:dot-circle[] icon:file-alt[]
+      osx:
+        KEY: value
+      # Included in Windows scripts
+      # icon:dot-circle[] icon:file-alt[]
+      windows:
+        KEY: value
+
     # Additional properties used when evaluating templates.
     # icon:dot-circle[]
     extraProperties:
@@ -384,6 +408,28 @@ TOML::
   # icon:dot-circle[]
   java.multiProject = false
 
+  # Environment variables used in launch scripts.
+
+  # Included in all scripts
+  # icon:dot-circle[] icon:file-alt[]
+  java.environmentVariables.universal.KEY = "value"
+
+  # Included in all non Windows scripts
+  # icon:dot-circle[] icon:file-alt[]
+  java.environmentVariables.unix.KEY = "value"
+
+  # Included in all non Windows (except OSX) scripts
+  # icon:dot-circle[] icon:file-alt[]
+  java.environmentVariables.linux.KEY = "value"
+
+  # Included only in OSX scripts
+  # icon:dot-circle[] icon:file-alt[]
+  java.environmentVariables.osx.KEY = "value"
+
+  # Included in Windows scripts
+  # icon:dot-circle[] icon:file-alt[]
+  java.environmentVariables.windows.KEY = "value"
+
   # Additional properties used when evaluating templates.
   # icon:dot-circle[]
   java.extraProperties.foo = "bar"
@@ -609,6 +655,36 @@ JSON::
       // icon:dot-circle[]
       "multiProject": false,
 
+      // Environment variables used in launch scripts.
+      // icon:dot-circle[]
+      "environmentVariables": {
+        // Included in all scripts
+        // icon:dot-circle[] icon:file-alt[]
+        "universal": {
+          "KEY": "value"
+        },
+        // Included in all non Windows scripts
+        // icon:dot-circle[] icon:file-alt[]
+        "unix": {
+          "KEY": "value"
+        },
+        // Included in all non Windows (except OSX) scripts
+        // icon:dot-circle[] icon:file-alt[]
+        "linux": {
+          "KEY": "value"
+        },
+        // Included only in OSX scripts
+        // icon:dot-circle[] icon:file-alt[]
+        "osx": {
+          "KEY": "value"
+        },
+        // Included in Windows scripts
+        // icon:dot-circle[] icon:file-alt[]
+        "windows": {
+          "KEY": "value"
+        }
+      },
+
       // Additional properties used when evaluating templates.
       // icon:dot-circle[]
       "extraProperties": {
@@ -941,6 +1017,48 @@ Maven::
       -->
       <multiProject>false</multiProject>
 
+      <!--
+        Environment variables used in launch scripts.
+        icon:dot-circle[]
+      -->
+      <environmentVariables>
+        <!--
+          Included in all scripts
+          icon:dot-circle[] icon:file-alt[]
+        -->
+        <universal>
+          <KEY>value</KEY>
+        </universal>
+        <!--
+          Included in all non Windows scripts
+          icon:dot-circle[] icon:file-alt[]
+        -->
+        <unix>
+          <KEY>value</KEY>
+        </unix>
+        <!--
+          Included in all non Windows (except OSX) scripts
+          icon:dot-circle[] icon:file-alt[]
+        -->
+        <linux>
+          <KEY>value</KEY>
+        </linux>
+        <!--
+          Included only in OSX scripts
+          icon:dot-circle[] icon:file-alt[]
+        -->
+        <osx>
+          <KEY>value</KEY>
+        </osx>
+        <!--
+          Included in Windows scripts
+          icon:dot-circle[] icon:file-alt[]
+        -->
+        <windows>
+          <KEY>value</KEY>
+        </windows>
+      </environmentVariables>
+
       <!--
         Additional properties used when evaluating templates.
         icon:dot-circle[]
@@ -1214,6 +1332,26 @@ jreleaser {
       // icon:dot-circle[]
       multiProject = false
 
+      // Environment variables used in launch scripts.
+      // icon:dot-circle[]
+      environmentVariables {
+        // Included in all scripts
+        // icon:dot-circle[] icon:file-alt[]
+        universal('KEY', 'value')
+        // Included in all non Windows scripts
+        // icon:dot-circle[] icon:file-alt[]
+        unix('KEY', 'value')
+        // Included in all non Windows (except OSX) scripts
+        // icon:dot-circle[] icon:file-alt[]
+        linux('KEY', 'value')
+        // Included only in OSX scripts
+        // icon:dot-circle[] icon:file-alt[]
+        osx('KEY', 'value')
+        // Included in Windows scripts
+        // icon:dot-circle[] icon:file-alt[]
+        windows('KEY', 'value')
+      }
+
       // Additional properties used when evaluating templates.
       // Key will be capitalized and prefixed with `java`, i.e, `javaFoo`.
       // icon:dot-circle[]

diff --git a/docs/modules/reference/partials/assemble/gradle/common-java.adoc b/docs/modules/reference/partials/assemble/gradle/common-java.adoc
@@ -29,6 +29,26 @@
           // icon:dot-circle[]
           options = ['-Xmx2048m']
 
+          // Environment variables used in launch scripts.
+          // icon:dot-circle[]
+          environmentVariables {
+            // Included in all scripts
+            // icon:dot-circle[] icon:file-alt[]
+            universal('KEY', 'value')
+            // Included in all non Windows scripts
+            // icon:dot-circle[] icon:file-alt[]
+            unix('KEY', 'value')
+            // Included in all non Windows (except OSX) scripts
+            // icon:dot-circle[] icon:file-alt[]
+            linux('KEY', 'value')
+            // Included only in OSX scripts
+            // icon:dot-circle[] icon:file-alt[]
+            osx('KEY', 'value')
+            // Included in Windows scripts
+            // icon:dot-circle[] icon:file-alt[]
+            windows('KEY', 'value')
+          }
+
 ifdef::java-assembler[]
           // Maven coordinates = groupId.
           // If left undefined, will use `#{project.java.groupId}`.

diff --git a/docs/modules/reference/partials/assemble/json/common-java.adoc b/docs/modules/reference/partials/assemble/json/common-java.adoc
@@ -31,6 +31,36 @@
           // icon:dot-circle[]
           "options": ["-Xmx2048m"],
 
+          // Environment variables used in launch scripts.
+          // icon:dot-circle[]
+          "environmentVariables": {
+            // Included in all scripts
+            // icon:dot-circle[] icon:file-alt[]
+            "universal": {
+              "KEY": "value"
+            },
+            // Included in all non Windows scripts
+            // icon:dot-circle[] icon:file-alt[]
+            "unix": {
+              "KEY": "value"
+            },
+            // Included in all non Windows (except OSX) scripts
+            // icon:dot-circle[] icon:file-alt[]
+            "linux": {
+              "KEY": "value"
+            },
+            // Included only in OSX scripts
+            // icon:dot-circle[] icon:file-alt[]
+            "osx": {
+              "KEY": "value"
+            },
+            // Included in Windows scripts
+            // icon:dot-circle[] icon:file-alt[]
+            "windows": {
+              "KEY": "value"
+            }
+          },
+
 ifdef::java-assembler[]
           // Maven coordinates: groupId.
           // If left undefined, will use `#{project.java.groupId}`.

diff --git a/docs/modules/reference/partials/assemble/maven/common-java.adoc b/docs/modules/reference/partials/assemble/maven/common-java.adoc
@@ -45,6 +45,48 @@
           -->
           <options>-Xmx2048m</options>
 
+          <!--
+            Environment variables used in launch scripts.
+            icon:dot-circle[]
+          -->
+          <environmentVariables>
+            <!--
+              Included in all scripts
+              icon:dot-circle[] icon:file-alt[]
+            -->
+            <universal>
+              <KEY>value</KEY>
+            </universal>
+            <!--
+              Included in all non Windows scripts
+              icon:dot-circle[] icon:file-alt[]
+            -->
+            <unix>
+              <KEY>value</KEY>
+            </unix>
+            <!--
+              Included in all non Windows (except OSX) scripts
+              icon:dot-circle[] icon:file-alt[]
+            -->
+            <linux>
+              <KEY>value</KEY>
+            </linux>
+            <!--
+              Included only in OSX scripts
+              icon:dot-circle[] icon:file-alt[]
+            -->
+            <osx>
+              <KEY>value</KEY>
+            </osx>
+            <!--
+              Included in Windows scripts
+              icon:dot-circle[] icon:file-alt[]
+            -->
+            <windows>
+              <KEY>value</KEY>
+            </windows>
+          </environmentVariables>
+
 ifdef::java-assembler[]
           <!--
             Maven coordinates>groupId.

diff --git a/docs/modules/reference/partials/assemble/toml/common-java.adoc b/docs/modules/reference/partials/assemble/toml/common-java.adoc
@@ -24,6 +24,28 @@
   # icon:dot-circle[]
   java.options = ["-Xmx2048m"]
 
+  # Environment variables used in launch scripts.
+
+  # Included in all scripts
+  # icon:dot-circle[] icon:file-alt[]
+  java.environmentVariables.universal.KEY = "value"
+
+  # Included in all non Windows scripts
+  # icon:dot-circle[] icon:file-alt[]
+  java.environmentVariables.unix.KEY = "value"
+
+  # Included in all non Windows (except OSX) scripts
+  # icon:dot-circle[] icon:file-alt[]
+  java.environmentVariables.linux.KEY = "value"
+
+  # Included only in OSX scripts
+  # icon:dot-circle[] icon:file-alt[]
+  java.environmentVariables.osx.KEY = "value"
+
+  # Included in Windows scripts
+  # icon:dot-circle[] icon:file-alt[]
+  java.environmentVariables.windows.KEY = "value"
+
 ifdef::java-assembler[]
   # Maven coordinates: groupId.
   # If left undefined, will use `#{project.java.groupId}`.

diff --git a/docs/modules/reference/partials/assemble/yaml/common-java.adoc b/docs/modules/reference/partials/assemble/yaml/common-java.adoc
@@ -27,6 +27,30 @@
         # icon:dot-circle[]
         options: [-Xmx2048m]
 
+        # Environment variables used in launch scripts.
+        # icon:dot-circle[]
+        environmentVariables:
+          # Included in all scripts
+          # icon:dot-circle[] icon:file-alt[]
+          universal:
+            KEY: value
+          # Included in all non Windows scripts
+          # icon:dot-circle[] icon:file-alt[]
+          unix:
+            KEY: value
+          # Included in all non Windows (except OSX) scripts
+          # icon:dot-circle[] icon:file-alt[]
+          linux:
+            KEY: value
+          # Included only in OSX scripts
+          # icon:dot-circle[] icon:file-alt[]
+          osx:
+            KEY: value
+          # Included in Windows scripts
+          # icon:dot-circle[] icon:file-alt[]
+          windows:
+            KEY: value
+
 ifdef::java-assembler[]
         # Maven coordinates: groupId.
         # If left undefined, will use `#{project.java.groupId}`.