[CI] Publish Documentation for 5319d05

jreleaser · Jun 7, 2024 · 0106b47 · 0106b47
1 parent 18e1fdd
commit 0106b47
Show file tree

Hide file tree

Showing 8 changed files with 1,205 additions and 415 deletions.
diff --git a/guide/early-access/reference/assemble/java-archive.html b/guide/early-access/reference/assemble/java-archive.html
@@ -982,6 +982,30 @@ <h2 id="_configuration"><a class="anchor" href="#_configuration"></a>Configurati
         # <span class="icon"><i class="fa fa-dot-circle"></i></span>
         options: [-Xmx2048m]
 
+        # Environment variables used in launch scripts.
+        # <span class="icon"><i class="fa fa-dot-circle"></i></span>
+        environmentVariables:
+          # Included in all scripts
+          # <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
+          universal:
+            KEY: value
+          # Included in all non Windows scripts
+          # <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
+          unix:
+            KEY: value
+          # Included in all non Windows (except OSX) scripts
+          # <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
+          linux:
+            KEY: value
+          # Included only in OSX scripts
+          # <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
+          osx:
+            KEY: value
+          # Included in Windows scripts
+          # <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
+          windows:
+            KEY: value
+
 
 
       # Directory with file templates used to prepare the assembler.
@@ -1218,6 +1242,28 @@ <h2 id="_configuration"><a class="anchor" href="#_configuration"></a>Configurati
   # <span class="icon"><i class="fa fa-dot-circle"></i></span>
   java.options = ["-Xmx2048m"]
 
+  # Environment variables used in launch scripts.
+
+  # Included in all scripts
+  # <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
+  java.environmentVariables.universal.KEY = "value"
+
+  # Included in all non Windows scripts
+  # <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
+  java.environmentVariables.unix.KEY = "value"
+
+  # Included in all non Windows (except OSX) scripts
+  # <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
+  java.environmentVariables.linux.KEY = "value"
+
+  # Included only in OSX scripts
+  # <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
+  java.environmentVariables.osx.KEY = "value"
+
+  # Included in Windows scripts
+  # <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
+  java.environmentVariables.windows.KEY = "value"
+
 
   # Directory with file templates used to prepare the assembler.
   # Defaults to `src/jreleaser/assemblers/#{distribution.name}/javaArchive`.
@@ -1467,6 +1513,36 @@ <h2 id="_configuration"><a class="anchor" href="#_configuration"></a>Configurati
           // <span class="icon"><i class="fa fa-dot-circle"></i></span>
           "options": ["-Xmx2048m"],
 
+          // Environment variables used in launch scripts.
+          // <span class="icon"><i class="fa fa-dot-circle"></i></span>
+          "environmentVariables": {
+            // Included in all scripts
+            // <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
+            "universal": {
+              "KEY": "value"
+            },
+            // Included in all non Windows scripts
+            // <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
+            "unix": {
+              "KEY": "value"
+            },
+            // Included in all non Windows (except OSX) scripts
+            // <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
+            "linux": {
+              "KEY": "value"
+            },
+            // Included only in OSX scripts
+            // <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
+            "osx": {
+              "KEY": "value"
+            },
+            // Included in Windows scripts
+            // <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
+            "windows": {
+              "KEY": "value"
+            }
+          },
+
         },
         // Directory with file templates used to prepare the assembler.
         // Defaults to `src/jreleaser/assemblers/#$#{distribution.name}/javaArchive`.
@@ -1794,6 +1870,48 @@ <h2 id="_configuration"><a class="anchor" href="#_configuration"></a>Configurati
           --&gt;
           &lt;options&gt;-Xmx2048m&lt;/options&gt;
 
+          &lt;!--
+            Environment variables used in launch scripts.
+            <span class="icon"><i class="fa fa-dot-circle"></i></span>
+          --&gt;
+          &lt;environmentVariables&gt;
+            &lt;!--
+              Included in all scripts
+              <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
+            --&gt;
+            &lt;universal&gt;
+              &lt;KEY&gt;value&lt;/KEY&gt;
+            &lt;/universal&gt;
+            &lt;!--
+              Included in all non Windows scripts
+              <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
+            --&gt;
+            &lt;unix&gt;
+              &lt;KEY&gt;value&lt;/KEY&gt;
+            &lt;/unix&gt;
+            &lt;!--
+              Included in all non Windows (except OSX) scripts
+              <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
+            --&gt;
+            &lt;linux&gt;
+              &lt;KEY&gt;value&lt;/KEY&gt;
+            &lt;/linux&gt;
+            &lt;!--
+              Included only in OSX scripts
+              <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
+            --&gt;
+            &lt;osx&gt;
+              &lt;KEY&gt;value&lt;/KEY&gt;
+            &lt;/osx&gt;
+            &lt;!--
+              Included in Windows scripts
+              <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
+            --&gt;
+            &lt;windows&gt;
+              &lt;KEY&gt;value&lt;/KEY&gt;
+            &lt;/windows&gt;
+          &lt;/environmentVariables&gt;
+
         &lt;/java&gt;
 
         &lt;!--
@@ -2128,6 +2246,26 @@ <h2 id="_configuration"><a class="anchor" href="#_configuration"></a>Configurati
           // <span class="icon"><i class="fa fa-dot-circle"></i></span>
           options = ['-Xmx2048m']
 
+          // Environment variables used in launch scripts.
+          // <span class="icon"><i class="fa fa-dot-circle"></i></span>
+          environmentVariables {
+            // Included in all scripts
+            // <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
+            universal('KEY', 'value')
+            // Included in all non Windows scripts
+            // <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
+            unix('KEY', 'value')
+            // Included in all non Windows (except OSX) scripts
+            // <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
+            linux('KEY', 'value')
+            // Included only in OSX scripts
+            // <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
+            osx('KEY', 'value')
+            // Included in Windows scripts
+            // <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
+            windows('KEY', 'value')
+          }
+
         }
 
         // Directory with file templates used to prepare the assembler.

diff --git a/guide/early-access/reference/assemble/jlink.html b/guide/early-access/reference/assemble/jlink.html
@@ -1091,6 +1091,30 @@ <h2 id="_configuration"><a class="anchor" href="#_configuration"></a>Configurati
         # <span class="icon"><i class="fa fa-dot-circle"></i></span>
         options: [-Xmx2048m]
 
+        # Environment variables used in launch scripts.
+        # <span class="icon"><i class="fa fa-dot-circle"></i></span>
+        environmentVariables:
+          # Included in all scripts
+          # <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
+          universal:
+            KEY: value
+          # Included in all non Windows scripts
+          # <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
+          unix:
+            KEY: value
+          # Included in all non Windows (except OSX) scripts
+          # <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
+          linux:
+            KEY: value
+          # Included only in OSX scripts
+          # <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
+          osx:
+            KEY: value
+          # Included in Windows scripts
+          # <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
+          windows:
+            KEY: value
+
         # Maven coordinates: groupId.
         # If left undefined, will use `#{project.java.groupId}`.
         # <span class="icon"><i class="fa fa-dot-circle"></i></span>
@@ -1447,6 +1471,28 @@ <h2 id="_configuration"><a class="anchor" href="#_configuration"></a>Configurati
   # <span class="icon"><i class="fa fa-dot-circle"></i></span>
   java.options = ["-Xmx2048m"]
 
+  # Environment variables used in launch scripts.
+
+  # Included in all scripts
+  # <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
+  java.environmentVariables.universal.KEY = "value"
+
+  # Included in all non Windows scripts
+  # <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
+  java.environmentVariables.unix.KEY = "value"
+
+  # Included in all non Windows (except OSX) scripts
+  # <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
+  java.environmentVariables.linux.KEY = "value"
+
+  # Included only in OSX scripts
+  # <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
+  java.environmentVariables.osx.KEY = "value"
+
+  # Included in Windows scripts
+  # <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
+  java.environmentVariables.windows.KEY = "value"
+
   # Maven coordinates: groupId.
   # If left undefined, will use `#{project.java.groupId}`.
   # <span class="icon"><i class="fa fa-dot-circle"></i></span>
@@ -1833,6 +1879,36 @@ <h2 id="_configuration"><a class="anchor" href="#_configuration"></a>Configurati
           // <span class="icon"><i class="fa fa-dot-circle"></i></span>
           "options": ["-Xmx2048m"],
 
+          // Environment variables used in launch scripts.
+          // <span class="icon"><i class="fa fa-dot-circle"></i></span>
+          "environmentVariables": {
+            // Included in all scripts
+            // <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
+            "universal": {
+              "KEY": "value"
+            },
+            // Included in all non Windows scripts
+            // <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
+            "unix": {
+              "KEY": "value"
+            },
+            // Included in all non Windows (except OSX) scripts
+            // <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
+            "linux": {
+              "KEY": "value"
+            },
+            // Included only in OSX scripts
+            // <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
+            "osx": {
+              "KEY": "value"
+            },
+            // Included in Windows scripts
+            // <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
+            "windows": {
+              "KEY": "value"
+            }
+          },
+
           // Maven coordinates: groupId.
           // If left undefined, will use `#{project.java.groupId}`.
           // <span class="icon"><i class="fa fa-dot-circle"></i></span>
@@ -2328,6 +2404,48 @@ <h2 id="_configuration"><a class="anchor" href="#_configuration"></a>Configurati
           --&gt;
           &lt;options&gt;-Xmx2048m&lt;/options&gt;
 
+          &lt;!--
+            Environment variables used in launch scripts.
+            <span class="icon"><i class="fa fa-dot-circle"></i></span>
+          --&gt;
+          &lt;environmentVariables&gt;
+            &lt;!--
+              Included in all scripts
+              <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
+            --&gt;
+            &lt;universal&gt;
+              &lt;KEY&gt;value&lt;/KEY&gt;
+            &lt;/universal&gt;
+            &lt;!--
+              Included in all non Windows scripts
+              <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
+            --&gt;
+            &lt;unix&gt;
+              &lt;KEY&gt;value&lt;/KEY&gt;
+            &lt;/unix&gt;
+            &lt;!--
+              Included in all non Windows (except OSX) scripts
+              <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
+            --&gt;
+            &lt;linux&gt;
+              &lt;KEY&gt;value&lt;/KEY&gt;
+            &lt;/linux&gt;
+            &lt;!--
+              Included only in OSX scripts
+              <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
+            --&gt;
+            &lt;osx&gt;
+              &lt;KEY&gt;value&lt;/KEY&gt;
+            &lt;/osx&gt;
+            &lt;!--
+              Included in Windows scripts
+              <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
+            --&gt;
+            &lt;windows&gt;
+              &lt;KEY&gt;value&lt;/KEY&gt;
+            &lt;/windows&gt;
+          &lt;/environmentVariables&gt;
+
           &lt;!--
             Maven coordinates&gt;groupId.
             If left undefined, will use `#{project.java.groupId}`.
@@ -2818,6 +2936,26 @@ <h2 id="_configuration"><a class="anchor" href="#_configuration"></a>Configurati
           // <span class="icon"><i class="fa fa-dot-circle"></i></span>
           options = ['-Xmx2048m']
 
+          // Environment variables used in launch scripts.
+          // <span class="icon"><i class="fa fa-dot-circle"></i></span>
+          environmentVariables {
+            // Included in all scripts
+            // <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
+            universal('KEY', 'value')
+            // Included in all non Windows scripts
+            // <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
+            unix('KEY', 'value')
+            // Included in all non Windows (except OSX) scripts
+            // <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
+            linux('KEY', 'value')
+            // Included only in OSX scripts
+            // <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
+            osx('KEY', 'value')
+            // Included in Windows scripts
+            // <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
+            windows('KEY', 'value')
+          }
+
           // Maven coordinates = groupId.
           // If left undefined, will use `#{project.java.groupId}`.
           // <span class="icon"><i class="fa fa-dot-circle"></i></span>