jlengrand/jreleaser.github.io
1
0
Fork 0
mirror of https://github.com/jlengrand/jreleaser.github.io.git synced 2026-03-10 08:31:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

[CI] Publish Documentation for 23a9da81dc

Browse Source
This commit is contained in:
aalmiray
2021-05-08 08:17:55 +00:00
parent 9c08be944f
commit ba4506b6fe
79 changed files with 10804 additions and 4126 deletions
Download Patch File Download Diff File Expand all files Collapse all files

BIN
guide/latest/_images/jreleaser-changelog-config.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 86 KiB

BIN
guide/latest/_images/jreleaser-changelog-render.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 120 KiB

BIN
guide/latest/_images/jreleaser-early-access.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 292 KiB

BIN
guide/latest/_images/jreleaser-workflow.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 109 KiB

After

Width:  |  Height:  |  Size: 179 KiB

102
guide/latest/artifacts.html
View File

@@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>Artifacts :: JReleaser</title>
<title>Artifacts &amp; Globs :: JReleaser</title>
<link rel="canonical" href="https://jreleaser.org/guide/latest/artifacts.html">
<meta name="generator" content="Antora 2.3.4">
<link rel="stylesheet" href="../../_/css/site.css">
@@ -94,7 +94,7 @@
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item is-current-page" data-depth="1">
<a class="nav-link" href="artifacts.html">Artifacts</a>
<a class="nav-link" href="artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
@@ -162,6 +162,15 @@
<li class="nav-item" data-depth="3">
<a class="nav-link" href="configuration/packagers/snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="configuration/upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="configuration/upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
@@ -243,6 +252,12 @@
<li class="nav-item" data-depth="2">
<a class="nav-link" href="continuous-integration/gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="continuous-integration/cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="continuous-integration/drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
@@ -254,43 +269,53 @@
<a class="nav-link" href="tools/index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="tools/cli.html">JReleaser CLI</a>
<a class="nav-link" href="tools/jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="tools/maven.html">JReleaser Maven Plugin</a>
<a class="nav-link" href="tools/jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="tools/gradle.html">JReleaser Gradle Plugin</a>
<a class="nav-link" href="tools/jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="tools/ant.html">JReleaser Ant Tasks</a>
<a class="nav-link" href="tools/jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="tools/tool-provider.html">JReleaser Tool Provider</a>
<a class="nav-link" href="tools/jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="tools/docker.html">JReleaser Docker Image</a>
<a class="nav-link" href="tools/jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="tools/jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="tools/jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Examples</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
@@ -329,7 +354,7 @@
<nav class="breadcrumbs" aria-label="breadcrumbs">
<ul>
<li><a href="index.html">JReleaser</a></li>
<li><a href="artifacts.html">Artifacts</a></li>
<li><a href="artifacts.html">Artifacts &amp; Globs</a></li>
</ul>
</nav>
<div class="edit-this-page"><a href="https://github.com/jreleaser/jreleaser.github.io/edit/main/docs/modules/ROOT/pages/artifacts.adoc">Edit this Page</a></div>
@@ -339,7 +364,7 @@
<div class="toc-menu"></div>
</aside>
<article class="doc">
<h1 class="page">Artifacts</h1>
<h1 class="page">Artifacts &amp; Globs</h1>
<div id="preamble">
<div class="sectionbody">
<div class="paragraph">
@@ -351,10 +376,14 @@
<p>added to a Git <a href="configuration/release/index.html" class="page">release</a>.</p>
</li>
<li>
<p>prepared, packaged, and uploaded using a <a href="configuration/packagers/index.html" class="page">packager</a>.</p>
<p>prepared, packaged, and published using a <a href="configuration/packagers/index.html" class="page">packager</a>.</p>
</li>
</ul>
</div>
<div class="paragraph">
<p>Artifacts refer to a specific file as they have a single <code>path</code> property. Globs on the other hand refer to a collection
of files.</p>
</div>
</div>
</div>
<div class="sect1">
@@ -422,6 +451,41 @@ and <a href="configuration/packagers/index.html" class="page">packagers</a> requ
</li>
</ul>
</div>
<div class="paragraph">
<p>Globs have the following properties:</p>
</div>
<div class="ulist">
<ul>
<li>
<p><code>directory</code>. Defines the starting point when searching for files.</p>
</li>
<li>
<p><code>include</code>. Defines a file name pattern. Matches will be included in the final collection.</p>
</li>
<li>
<p><code>exclude</code>. Defines a file name pattern. Matches will be excluded from the final collection.</p>
</li>
<li>
<p><code>recursive</code>. Whether to search recursively or not.</p>
</li>
</ul>
</div>
<div class="admonitionblock important">
<table>
<tr>
<td class="icon">
<i class="fa icon-important" title="Important"></i>
</td>
<td class="content">
The values of <code>directory</code>, <code>include</code>, and <code>exclude</code> are optional but at least one of them has to be specified.
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>Both <code>include</code> and <code>exclude</code> accept glob or regex patterns by using <code>glob:</code> and <code>regex:</code> prefixes accordingly.
If no prefix is specified then <code>glob:</code> will be used.</p>
</div>
</div>
</div>
<div class="sect1">
@@ -658,16 +722,16 @@ Target JDKs are of type <code>artifact</code>.</p>
│ ├── jreleaser
│ │ └── build
│ │ └── distributions
│ │ └── jreleaser-0.2.0.zip
│ │ └── jreleaser-0.3.0.zip
│ └── jreleaser-tool-provider
│ └── build
│ └── libs
│ └── jreleaser-tool-provider-0.2.0.jar
│ └── jreleaser-tool-provider-0.3.0.jar
└── plugins
└── jreleaser-ant-tasks
└── build
└── distributions
└── jreleaser-ant-tasks-0.2.0.zip</code></pre>
└── jreleaser-ant-tasks-0.3.0.zip</code></pre>
</div>
</div>
</div>

49
guide/latest/configuration/announce/discord.html
View File

@@ -94,7 +94,7 @@
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../../artifacts.html">Artifacts</a>
<a class="nav-link" href="../../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
@@ -162,6 +162,15 @@
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../packagers/snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
@@ -243,6 +252,12 @@
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
@@ -254,43 +269,53 @@
<a class="nav-link" href="../../tools/index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/cli.html">JReleaser CLI</a>
<a class="nav-link" href="../../tools/jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/maven.html">JReleaser Maven Plugin</a>
<a class="nav-link" href="../../tools/jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/gradle.html">JReleaser Gradle Plugin</a>
<a class="nav-link" href="../../tools/jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/ant.html">JReleaser Ant Tasks</a>
<a class="nav-link" href="../../tools/jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/tool-provider.html">JReleaser Tool Provider</a>
<a class="nav-link" href="../../tools/jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/docker.html">JReleaser Docker Image</a>
<a class="nav-link" href="../../tools/jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Examples</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../../examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">

49
guide/latest/configuration/announce/discussions.html
View File

@@ -94,7 +94,7 @@
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../../artifacts.html">Artifacts</a>
<a class="nav-link" href="../../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
@@ -162,6 +162,15 @@
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../packagers/snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
@@ -243,6 +252,12 @@
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
@@ -254,43 +269,53 @@
<a class="nav-link" href="../../tools/index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/cli.html">JReleaser CLI</a>
<a class="nav-link" href="../../tools/jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/maven.html">JReleaser Maven Plugin</a>
<a class="nav-link" href="../../tools/jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/gradle.html">JReleaser Gradle Plugin</a>
<a class="nav-link" href="../../tools/jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/ant.html">JReleaser Ant Tasks</a>
<a class="nav-link" href="../../tools/jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/tool-provider.html">JReleaser Tool Provider</a>
<a class="nav-link" href="../../tools/jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/docker.html">JReleaser Docker Image</a>
<a class="nav-link" href="../../tools/jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Examples</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../../examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">

49
guide/latest/configuration/announce/gitter.html
View File

@@ -94,7 +94,7 @@
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../../artifacts.html">Artifacts</a>
<a class="nav-link" href="../../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
@@ -162,6 +162,15 @@
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../packagers/snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
@@ -243,6 +252,12 @@
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
@@ -254,43 +269,53 @@
<a class="nav-link" href="../../tools/index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/cli.html">JReleaser CLI</a>
<a class="nav-link" href="../../tools/jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/maven.html">JReleaser Maven Plugin</a>
<a class="nav-link" href="../../tools/jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/gradle.html">JReleaser Gradle Plugin</a>
<a class="nav-link" href="../../tools/jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/ant.html">JReleaser Ant Tasks</a>
<a class="nav-link" href="../../tools/jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/tool-provider.html">JReleaser Tool Provider</a>
<a class="nav-link" href="../../tools/jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/docker.html">JReleaser Docker Image</a>
<a class="nav-link" href="../../tools/jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Examples</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../../examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">

49
guide/latest/configuration/announce/index.html
View File

@@ -94,7 +94,7 @@
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../../artifacts.html">Artifacts</a>
<a class="nav-link" href="../../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
@@ -162,6 +162,15 @@
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../packagers/snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
@@ -243,6 +252,12 @@
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
@@ -254,43 +269,53 @@
<a class="nav-link" href="../../tools/index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/cli.html">JReleaser CLI</a>
<a class="nav-link" href="../../tools/jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/maven.html">JReleaser Maven Plugin</a>
<a class="nav-link" href="../../tools/jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/gradle.html">JReleaser Gradle Plugin</a>
<a class="nav-link" href="../../tools/jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/ant.html">JReleaser Ant Tasks</a>
<a class="nav-link" href="../../tools/jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/tool-provider.html">JReleaser Tool Provider</a>
<a class="nav-link" href="../../tools/jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/docker.html">JReleaser Docker Image</a>
<a class="nav-link" href="../../tools/jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Examples</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../../examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">

49
guide/latest/configuration/announce/mail.html
View File

@@ -94,7 +94,7 @@
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../../artifacts.html">Artifacts</a>
<a class="nav-link" href="../../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
@@ -162,6 +162,15 @@
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../packagers/snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
@@ -243,6 +252,12 @@
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
@@ -254,43 +269,53 @@
<a class="nav-link" href="../../tools/index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/cli.html">JReleaser CLI</a>
<a class="nav-link" href="../../tools/jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/maven.html">JReleaser Maven Plugin</a>
<a class="nav-link" href="../../tools/jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/gradle.html">JReleaser Gradle Plugin</a>
<a class="nav-link" href="../../tools/jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/ant.html">JReleaser Ant Tasks</a>
<a class="nav-link" href="../../tools/jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/tool-provider.html">JReleaser Tool Provider</a>
<a class="nav-link" href="../../tools/jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/docker.html">JReleaser Docker Image</a>
<a class="nav-link" href="../../tools/jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Examples</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../../examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">

49
guide/latest/configuration/announce/sdkman.html
View File

@@ -94,7 +94,7 @@
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../../artifacts.html">Artifacts</a>
<a class="nav-link" href="../../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
@@ -162,6 +162,15 @@
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../packagers/snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
@@ -243,6 +252,12 @@
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
@@ -254,43 +269,53 @@
<a class="nav-link" href="../../tools/index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/cli.html">JReleaser CLI</a>
<a class="nav-link" href="../../tools/jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/maven.html">JReleaser Maven Plugin</a>
<a class="nav-link" href="../../tools/jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/gradle.html">JReleaser Gradle Plugin</a>
<a class="nav-link" href="../../tools/jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/ant.html">JReleaser Ant Tasks</a>
<a class="nav-link" href="../../tools/jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/tool-provider.html">JReleaser Tool Provider</a>
<a class="nav-link" href="../../tools/jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/docker.html">JReleaser Docker Image</a>
<a class="nav-link" href="../../tools/jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Examples</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../../examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">

49
guide/latest/configuration/announce/slack.html
View File

@@ -94,7 +94,7 @@
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../../artifacts.html">Artifacts</a>
<a class="nav-link" href="../../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
@@ -162,6 +162,15 @@
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../packagers/snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
@@ -243,6 +252,12 @@
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
@@ -254,43 +269,53 @@
<a class="nav-link" href="../../tools/index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/cli.html">JReleaser CLI</a>
<a class="nav-link" href="../../tools/jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/maven.html">JReleaser Maven Plugin</a>
<a class="nav-link" href="../../tools/jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/gradle.html">JReleaser Gradle Plugin</a>
<a class="nav-link" href="../../tools/jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/ant.html">JReleaser Ant Tasks</a>
<a class="nav-link" href="../../tools/jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/tool-provider.html">JReleaser Tool Provider</a>
<a class="nav-link" href="../../tools/jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/docker.html">JReleaser Docker Image</a>
<a class="nav-link" href="../../tools/jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Examples</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../../examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">

49
guide/latest/configuration/announce/teams.html
View File

@@ -94,7 +94,7 @@
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../../artifacts.html">Artifacts</a>
<a class="nav-link" href="../../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
@@ -162,6 +162,15 @@
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../packagers/snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
@@ -243,6 +252,12 @@
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
@@ -254,43 +269,53 @@
<a class="nav-link" href="../../tools/index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/cli.html">JReleaser CLI</a>
<a class="nav-link" href="../../tools/jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/maven.html">JReleaser Maven Plugin</a>
<a class="nav-link" href="../../tools/jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/gradle.html">JReleaser Gradle Plugin</a>
<a class="nav-link" href="../../tools/jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/ant.html">JReleaser Ant Tasks</a>
<a class="nav-link" href="../../tools/jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/tool-provider.html">JReleaser Tool Provider</a>
<a class="nav-link" href="../../tools/jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/docker.html">JReleaser Docker Image</a>
<a class="nav-link" href="../../tools/jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Examples</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../../examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">

49
guide/latest/configuration/announce/twitter.html
View File

@@ -94,7 +94,7 @@
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../../artifacts.html">Artifacts</a>
<a class="nav-link" href="../../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
@@ -162,6 +162,15 @@
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../packagers/snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
@@ -243,6 +252,12 @@
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
@@ -254,43 +269,53 @@
<a class="nav-link" href="../../tools/index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/cli.html">JReleaser CLI</a>
<a class="nav-link" href="../../tools/jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/maven.html">JReleaser Maven Plugin</a>
<a class="nav-link" href="../../tools/jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/gradle.html">JReleaser Gradle Plugin</a>
<a class="nav-link" href="../../tools/jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/ant.html">JReleaser Ant Tasks</a>
<a class="nav-link" href="../../tools/jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/tool-provider.html">JReleaser Tool Provider</a>
<a class="nav-link" href="../../tools/jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/docker.html">JReleaser Docker Image</a>
<a class="nav-link" href="../../tools/jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Examples</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../../examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">

54
guide/latest/configuration/announce/zulip.html
View File

@@ -94,7 +94,7 @@
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../../artifacts.html">Artifacts</a>
<a class="nav-link" href="../../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
@@ -162,6 +162,15 @@
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../packagers/snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
@@ -243,6 +252,12 @@
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
@@ -254,43 +269,53 @@
<a class="nav-link" href="../../tools/index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/cli.html">JReleaser CLI</a>
<a class="nav-link" href="../../tools/jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/maven.html">JReleaser Maven Plugin</a>
<a class="nav-link" href="../../tools/jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/gradle.html">JReleaser Gradle Plugin</a>
<a class="nav-link" href="../../tools/jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/ant.html">JReleaser Ant Tasks</a>
<a class="nav-link" href="../../tools/jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/tool-provider.html">JReleaser Tool Provider</a>
<a class="nav-link" href="../../tools/jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/docker.html">JReleaser Docker Image</a>
<a class="nav-link" href="../../tools/jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Examples</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../../examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
@@ -531,7 +556,7 @@ this announcer.</p>
// The Zulip account (typically an email address) to use.
// <span class="icon"><i class="fa fa-exclamation-triangle"></i></span>
"account": announce-bot@my.zulipchat.com,
"account": "announce-bot@my.zulipchat.com",
// The Zulip server endpoint.
// <span class="icon"><i class="fa fa-exclamation-triangle"></i></span>
@@ -615,7 +640,8 @@ this announcer.</p>
&lt;!--
The ApiKey associated with the given account.
If left unspecified, the `JRELEASER_ZULIP_API_KEY` environment variable must be defined.
If left unspecified, the `JRELEASER_ZULIP_API_KEY`
environment variable must be defined.
<span class="icon"><i class="fa fa-exclamation-triangle"></i></span> <span class="icon"><i class="fa fa-eye-slash"></i></span>
--&gt;
&lt;apiKey&gt;__DO_NOT_SET_HERE__&lt;/apiKey&gt;

49
guide/latest/configuration/assemble/index.html
View File

@@ -94,7 +94,7 @@
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../../artifacts.html">Artifacts</a>
<a class="nav-link" href="../../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
@@ -162,6 +162,15 @@
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../packagers/snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
@@ -243,6 +252,12 @@
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
@@ -254,43 +269,53 @@
<a class="nav-link" href="../../tools/index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/cli.html">JReleaser CLI</a>
<a class="nav-link" href="../../tools/jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/maven.html">JReleaser Maven Plugin</a>
<a class="nav-link" href="../../tools/jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/gradle.html">JReleaser Gradle Plugin</a>
<a class="nav-link" href="../../tools/jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/ant.html">JReleaser Ant Tasks</a>
<a class="nav-link" href="../../tools/jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/tool-provider.html">JReleaser Tool Provider</a>
<a class="nav-link" href="../../tools/jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/docker.html">JReleaser Docker Image</a>
<a class="nav-link" href="../../tools/jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Examples</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../../examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">

51
guide/latest/configuration/assemble/jlink.html
View File

@@ -94,7 +94,7 @@
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../../artifacts.html">Artifacts</a>
<a class="nav-link" href="../../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
@@ -162,6 +162,15 @@
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../packagers/snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
@@ -243,6 +252,12 @@
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
@@ -254,43 +269,53 @@
<a class="nav-link" href="../../tools/index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/cli.html">JReleaser CLI</a>
<a class="nav-link" href="../../tools/jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/maven.html">JReleaser Maven Plugin</a>
<a class="nav-link" href="../../tools/jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/gradle.html">JReleaser Gradle Plugin</a>
<a class="nav-link" href="../../tools/jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/ant.html">JReleaser Ant Tasks</a>
<a class="nav-link" href="../../tools/jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/tool-provider.html">JReleaser Tool Provider</a>
<a class="nav-link" href="../../tools/jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/docker.html">JReleaser Docker Image</a>
<a class="nav-link" href="../../tools/jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Examples</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../../examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
@@ -366,7 +391,7 @@ same matching major version.
</td>
<td class="content">
You have to install additional JDKs to enable cross-platform images. JReleaser will <strong>not</strong> install these JDKS
for you.
for you. You may configure the <a href="../../tools/jdks-maven.html" class="page">JDKs Maven Plugin</a> or the <a href="../../tools/jdks-gradle.html" class="page">JDKs Gradle Plugin</a> to downloads JDKS.
</td>
</tr>
</table>

52
guide/latest/configuration/assemble/native-image.html
View File

@@ -94,7 +94,7 @@
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../../artifacts.html">Artifacts</a>
<a class="nav-link" href="../../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
@@ -162,6 +162,15 @@
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../packagers/snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
@@ -243,6 +252,12 @@
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
@@ -254,43 +269,53 @@
<a class="nav-link" href="../../tools/index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/cli.html">JReleaser CLI</a>
<a class="nav-link" href="../../tools/jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/maven.html">JReleaser Maven Plugin</a>
<a class="nav-link" href="../../tools/jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/gradle.html">JReleaser Gradle Plugin</a>
<a class="nav-link" href="../../tools/jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/ant.html">JReleaser Ant Tasks</a>
<a class="nav-link" href="../../tools/jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/tool-provider.html">JReleaser Tool Provider</a>
<a class="nav-link" href="../../tools/jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/docker.html">JReleaser Docker Image</a>
<a class="nav-link" href="../../tools/jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Examples</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../../examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
@@ -353,7 +378,8 @@
</td>
<td class="content">
You need a local installation of GraalVM. JReleaser will <strong>not</strong> install GraalVM for you, however it can
install the <code>native-image</code> command if needed.
install the <code>native-image</code> command if needed. You may configure the <a href="../../tools/jdks-maven.html" class="page">JDKs Maven Plugin</a> or the
<a href="../../tools/jdks-gradle.html" class="page">JDKs Gradle Plugin</a> to downloads a GraalVM distribution.
</td>
</tr>
</table>

59
guide/latest/configuration/distributions.html
View File

@@ -94,7 +94,7 @@
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../artifacts.html">Artifacts</a>
<a class="nav-link" href="../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
@@ -162,6 +162,15 @@
<li class="nav-item" data-depth="3">
<a class="nav-link" href="packagers/snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item is-current-page" data-depth="2">
@@ -243,6 +252,12 @@
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
@@ -254,43 +269,53 @@
<a class="nav-link" href="../tools/index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/cli.html">JReleaser CLI</a>
<a class="nav-link" href="../tools/jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/maven.html">JReleaser Maven Plugin</a>
<a class="nav-link" href="../tools/jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/gradle.html">JReleaser Gradle Plugin</a>
<a class="nav-link" href="../tools/jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/ant.html">JReleaser Ant Tasks</a>
<a class="nav-link" href="../tools/jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/tool-provider.html">JReleaser Tool Provider</a>
<a class="nav-link" href="../tools/jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/docker.html">JReleaser Docker Image</a>
<a class="nav-link" href="../tools/jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Examples</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
@@ -410,7 +435,7 @@ distributions:
# The distribution type.
# Used to determine packager templates.
# Supported values are: [JAVA_BINARY].
# Supported values are: [JAVA_BINARY, SINGLE_JAR, JLINK, NATIVE_IMAGE].
# <span class="icon"><i class="fa fa-exclamation-triangle"></i></span>
type: JAVA_BINARY
@@ -491,7 +516,7 @@ distributions:
# The distribution type.
# Used to determine packager templates.
# Supported values are: [JAVA_BINARY].
# Supported values are: [JAVA_BINARY, SINGLE_JAR, JLINK, NATIVE_IMAGE].
# <span class="icon"><i class="fa fa-exclamation-triangle"></i></span>
type = "JAVA_BINARY"
@@ -568,7 +593,7 @@ distributions:
// The distribution type.
// Used to determine packager templates.
// Supported values are: [JAVA_BINARY].
// Supported values are: [JAVA_BINARY, SINGLE_JAR, JLINK, NATIVE_IMAGE].
// <span class="icon"><i class="fa fa-exclamation-triangle"></i></span>
"type": "JAVA_BINARY",
@@ -673,7 +698,7 @@ distributions:
&lt;!--
The distribution type.
Used to determine packager templates.
Supported values are&gt;[JAVA_BINARY].
Supported values are&gt;[JAVA_BINARY, SINGLE_JAR, JLINK, NATIVE_IMAGE].
<span class="icon"><i class="fa fa-exclamation-triangle"></i></span>
--&gt;
&lt;type&gt;JAVA_BINARY&lt;/type&gt;
@@ -798,7 +823,7 @@ distributions:
// The distribution type.
// Used to determine packager templates.
// Supported values are = [JAVA_BINARY].
// Supported values are = [JAVA_BINARY, SINGLE_JAR, JLINK, NATIVE_IMAGE].
// <span class="icon"><i class="fa fa-exclamation-triangle"></i></span>
type = 'JAVA_BINARY'

327
guide/latest/configuration/environment.html
View File

@@ -94,7 +94,7 @@
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../artifacts.html">Artifacts</a>
<a class="nav-link" href="../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
@@ -162,6 +162,15 @@
<li class="nav-item" data-depth="3">
<a class="nav-link" href="packagers/snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
@@ -243,6 +252,12 @@
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
@@ -254,43 +269,53 @@
<a class="nav-link" href="../tools/index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/cli.html">JReleaser CLI</a>
<a class="nav-link" href="../tools/jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/maven.html">JReleaser Maven Plugin</a>
<a class="nav-link" href="../tools/jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/gradle.html">JReleaser Gradle Plugin</a>
<a class="nav-link" href="../tools/jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/ant.html">JReleaser Ant Tasks</a>
<a class="nav-link" href="../tools/jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/tool-provider.html">JReleaser Tool Provider</a>
<a class="nav-link" href="../tools/jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/docker.html">JReleaser Docker Image</a>
<a class="nav-link" href="../tools/jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Examples</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
@@ -576,14 +601,158 @@ environment:
</div>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_maven"><a class="anchor" href="#_maven"></a>Maven</h2>
<div class="sectionbody">
<div class="paragraph">
<p>The following key/values may be defined in the properties file or as environment variables:</p>
<p>JReleaser will honor Maven project properties. These properties can be defined in several ways:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>on the command line by using the <code>-D</code> flag.</p>
</li>
<li>
<p>on a <code>pom.xml</code> by using the <code>&lt;properties&gt;</code> block.</p>
</li>
<li>
<p>on a settings file using the <code>&lt;properties&gt;</code> block inside an active profile.</p>
</li>
</ul>
</div>
<div class="paragraph">
<p>JReleaser should be able to handle properties define in any of these ways.
Precedence is:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>values defined in the model.</p>
</li>
<li>
<p>values defined as Maven properties.</p>
</li>
<li>
<p>values defined in <code>&lt;releaser&gt;&lt;environment&gt;&lt;variables&gt;</code>.</p>
</li>
<li>
<p>environment variables.</p>
</li>
</ul>
</div>
<div class="paragraph">
<p>Keys must either be fully uppercase words separated by underscores (<code>_</code>) or fully lowercase words separated by dots (<code>.</code>).
The uppercase variant has precedence over the lowercase variant. For example, the Github token may be defined in
<code>~/.m2/settings.xml</code> as:</p>
</div>
<div class="listingblock">
<div class="title">settings.xml</div>
<div class="content">
<pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml">&lt;settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
https://maven.apache.org/xsd/settings-1.0.0.xsd"&gt;
&lt;profiles&gt;
&lt;profile&gt;
&lt;id&gt;jreleaser&lt;/id&gt;
&lt;activation&gt;
&lt;activeByDefault&gt;true&lt;/activeByDefault&gt;
&lt;/activation&gt;
&lt;properties&gt;
&lt;JRELEASER_GITHUB_TOKEN&gt;2ee1ce8ff570e0bOVEdrZvie8792058&lt;/JRELEASER_GITHUB_TOKEN&gt;
&lt;/properties&gt;
&lt;/profile&gt;
&lt;/profiles&gt;
&lt;/settings&gt;</code></pre>
</div>
</div>
<div class="paragraph">
<p>Or as</p>
</div>
<div class="listingblock">
<div class="title">settings.xml</div>
<div class="content">
<pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml">&lt;settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
https://maven.apache.org/xsd/settings-1.0.0.xsd"&gt;
&lt;profiles&gt;
&lt;profile&gt;
&lt;id&gt;jreleaser&lt;/id&gt;
&lt;activation&gt;
&lt;activeByDefault&gt;true&lt;/activeByDefault&gt;
&lt;/activation&gt;
&lt;properties&gt;
&lt;jreleaser.github.token&gt;2ee1ce8ff570e0bOVEdrZvie8792058&lt;/jreleaser.github.token&gt;
&lt;/properties&gt;
&lt;/profile&gt;
&lt;/profiles&gt;
&lt;/settings&gt;</code></pre>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_project"><a class="anchor" href="#_project"></a>Project</h2>
<h2 id="_gradle"><a class="anchor" href="#_gradle"></a>Gradle</h2>
<div class="sectionbody">
<div class="paragraph">
<p>JReleaser will honor Gradle project properties. These properties can be defined in several ways:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>on the command line by using the <code>-P</code> flag.</p>
</li>
<li>
<p>on a <code>gradle.properties</code> file adjacent to the project.</p>
</li>
<li>
<p>on a <code>gradle.properties</code> file located at <code>~/.gradle</code>.</p>
</li>
</ul>
</div>
<div class="paragraph">
<p>JReleaser should be able to handle properties define in any of these ways.
Precedence is:
- values defined in the model.
- values defined as Gradle project properties.
- values defined in <code>jreleaser.environment.variables</code>.
- environment variables.</p>
</div>
<div class="paragraph">
<p>Keys must either be fully uppercase words separated by underscores (<code>_</code>) or fully lowercase words separated by dots (<code>.</code>).
The uppercase variant has precedence over the lowercase variant. For example, the Github token may be defined in
<code>/.gradle/gradle.properties</code> as:</p>
</div>
<div class="listingblock">
<div class="title">gradle.properties</div>
<div class="content">
<pre class="highlightjs highlight"><code>JRELEASER_GITHUB_TOKEN = 2ee1ce8ff570e0bOVEdrZvie8792058</code></pre>
</div>
</div>
<div class="paragraph">
<p>Or as:</p>
</div>
<div class="listingblock">
<div class="title">gradle.properties</div>
<div class="content">
<pre class="highlightjs highlight"><code>jreleaser.github.token = 2ee1ce8ff570e0bOVEdrZvie8792058</code></pre>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_keys_values"><a class="anchor" href="#_keys_values"></a>Keys &amp; Values</h2>
<div class="sectionbody">
<div class="paragraph">
<p>The following key/values may be defined as properties or as environment variables:</p>
</div>
<div class="sect2">
<h3 id="_project"><a class="anchor" href="#_project"></a>Project</h3>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 50%;">
@@ -611,10 +780,8 @@ environment:
</tbody>
</table>
</div>
</div>
<div class="sect1">
<h2 id="_release"><a class="anchor" href="#_release"></a>Release</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_release"><a class="anchor" href="#_release"></a>Release</h3>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 50%;">
@@ -641,7 +808,7 @@ environment:
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">JRELEASER_BRANCH</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">the release branch (targetCommitish/ref)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">the release branch</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">JRELEASER_OVERWRITE</p></td>
@@ -660,6 +827,10 @@ environment:
<td class="tableblock halign-left valign-top"><p class="tableblock">release is a prerelease (github/gitea)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">JRELEASER_DRAFT</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">release is a draft (github/gitea)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">JRELEASER_GITHUB_TOKEN</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">a GitHub token with <code>repo</code> scope</p></td>
</tr>
@@ -674,10 +845,8 @@ environment:
</tbody>
</table>
</div>
</div>
<div class="sect1">
<h2 id="_signing"><a class="anchor" href="#_signing"></a>Signing</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_signing"><a class="anchor" href="#_signing"></a>Signing</h3>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 50%;">
@@ -705,10 +874,37 @@ environment:
</tbody>
</table>
</div>
<div class="sect2">
<h3 id="_artifactory"><a class="anchor" href="#_artifactory"></a>Artifactory</h3>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 50%;">
<col style="width: 50%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Key</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">JRELEASER_ARTIFACTORY_${NAME}_USERNAME</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">a username matching the named Artifactory instance</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">JRELEASER_ARTIFACTORY_${NAME}_PASSWORD</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">a password matching the named Artifactory instance</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">JRELEASER_ARTIFACTORY_${NAME}_TOKEN</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">a token matching the named Artifactory instance</p></td>
</tr>
</tbody>
</table>
</div>
<div class="sect1">
<h2 id="_docker"><a class="anchor" href="#_docker"></a>Docker</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_docker"><a class="anchor" href="#_docker"></a>Docker</h3>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 50%;">
@@ -728,10 +924,8 @@ environment:
</tbody>
</table>
</div>
</div>
<div class="sect1">
<h2 id="_homebrew"><a class="anchor" href="#_homebrew"></a>Homebrew</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_homebrew"><a class="anchor" href="#_homebrew"></a>Homebrew</h3>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 50%;">
@@ -759,10 +953,8 @@ environment:
</tbody>
</table>
</div>
</div>
<div class="sect1">
<h2 id="_chocolatey"><a class="anchor" href="#_chocolatey"></a>Chocolatey</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_chocolatey"><a class="anchor" href="#_chocolatey"></a>Chocolatey</h3>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 50%;">
@@ -790,10 +982,8 @@ environment:
</tbody>
</table>
</div>
</div>
<div class="sect1">
<h2 id="_jbang"><a class="anchor" href="#_jbang"></a>Jbang</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_jbang"><a class="anchor" href="#_jbang"></a>Jbang</h3>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 50%;">
@@ -821,10 +1011,8 @@ environment:
</tbody>
</table>
</div>
</div>
<div class="sect1">
<h2 id="_scoop"><a class="anchor" href="#_scoop"></a>Scoop</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_scoop"><a class="anchor" href="#_scoop"></a>Scoop</h3>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 50%;">
@@ -852,10 +1040,8 @@ environment:
</tbody>
</table>
</div>
</div>
<div class="sect1">
<h2 id="_snap"><a class="anchor" href="#_snap"></a>Snap</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_snap"><a class="anchor" href="#_snap"></a>Snap</h3>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 50%;">
@@ -883,10 +1069,8 @@ environment:
</tbody>
</table>
</div>
</div>
<div class="sect1">
<h2 id="_discord"><a class="anchor" href="#_discord"></a>Discord</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_discord"><a class="anchor" href="#_discord"></a>Discord</h3>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 50%;">
@@ -906,10 +1090,8 @@ environment:
</tbody>
</table>
</div>
</div>
<div class="sect1">
<h2 id="_gitter"><a class="anchor" href="#_gitter"></a>Gitter</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_gitter"><a class="anchor" href="#_gitter"></a>Gitter</h3>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 50%;">
@@ -929,10 +1111,8 @@ environment:
</tbody>
</table>
</div>
</div>
<div class="sect1">
<h2 id="_mail"><a class="anchor" href="#_mail"></a>Mail</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_mail"><a class="anchor" href="#_mail"></a>Mail</h3>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 50%;">
@@ -952,10 +1132,8 @@ environment:
</tbody>
</table>
</div>
</div>
<div class="sect1">
<h2 id="_sdkman"><a class="anchor" href="#_sdkman"></a>Sdkman</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_sdkman"><a class="anchor" href="#_sdkman"></a>Sdkman</h3>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 50%;">
@@ -979,10 +1157,8 @@ environment:
</tbody>
</table>
</div>
</div>
<div class="sect1">
<h2 id="_slack"><a class="anchor" href="#_slack"></a>Slack</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_slack"><a class="anchor" href="#_slack"></a>Slack</h3>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 50%;">
@@ -1006,10 +1182,8 @@ environment:
</tbody>
</table>
</div>
</div>
<div class="sect1">
<h2 id="_teams"><a class="anchor" href="#_teams"></a>Teams</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_teams"><a class="anchor" href="#_teams"></a>Teams</h3>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 50%;">
@@ -1029,10 +1203,8 @@ environment:
</tbody>
</table>
</div>
</div>
<div class="sect1">
<h2 id="_twitter"><a class="anchor" href="#_twitter"></a>Twitter</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_twitter"><a class="anchor" href="#_twitter"></a>Twitter</h3>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 50%;">
@@ -1064,10 +1236,8 @@ environment:
</tbody>
</table>
</div>
</div>
<div class="sect1">
<h2 id="_zulip"><a class="anchor" href="#_zulip"></a>Zulip</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_zulip"><a class="anchor" href="#_zulip"></a>Zulip</h3>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 50%;">
@@ -1088,6 +1258,7 @@ environment:
</table>
</div>
</div>
</div>
</article>
</div>
</main>

49
guide/latest/configuration/files.html
View File

@@ -94,7 +94,7 @@
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../artifacts.html">Artifacts</a>
<a class="nav-link" href="../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
@@ -162,6 +162,15 @@
<li class="nav-item" data-depth="3">
<a class="nav-link" href="packagers/snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
@@ -243,6 +252,12 @@
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
@@ -254,43 +269,53 @@
<a class="nav-link" href="../tools/index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/cli.html">JReleaser CLI</a>
<a class="nav-link" href="../tools/jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/maven.html">JReleaser Maven Plugin</a>
<a class="nav-link" href="../tools/jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/gradle.html">JReleaser Gradle Plugin</a>
<a class="nav-link" href="../tools/jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/ant.html">JReleaser Ant Tasks</a>
<a class="nav-link" href="../tools/jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/tool-provider.html">JReleaser Tool Provider</a>
<a class="nav-link" href="../tools/jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/docker.html">JReleaser Docker Image</a>
<a class="nav-link" href="../tools/jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Examples</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">

51
guide/latest/configuration/index.html
View File

@@ -94,7 +94,7 @@
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../artifacts.html">Artifacts</a>
<a class="nav-link" href="../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
@@ -162,6 +162,15 @@
<li class="nav-item" data-depth="3">
<a class="nav-link" href="packagers/snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
@@ -243,6 +252,12 @@
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
@@ -254,43 +269,53 @@
<a class="nav-link" href="../tools/index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/cli.html">JReleaser CLI</a>
<a class="nav-link" href="../tools/jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/maven.html">JReleaser Maven Plugin</a>
<a class="nav-link" href="../tools/jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/gradle.html">JReleaser Gradle Plugin</a>
<a class="nav-link" href="../tools/jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/ant.html">JReleaser Ant Tasks</a>
<a class="nav-link" href="../tools/jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/tool-provider.html">JReleaser Tool Provider</a>
<a class="nav-link" href="../tools/jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/docker.html">JReleaser Docker Image</a>
<a class="nav-link" href="../tools/jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Examples</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
@@ -346,7 +371,7 @@
</div>
<div class="paragraph">
<p>Other configuration formats besides YAML may be supported as well, such as TOML, JSON,
the <a href="../tools/maven.html" class="page">Maven</a> DSL, the <a href="../tools/gradle.html" class="page">Gradle</a> DSL.</p>
the <a href="../tools/jreleaser-maven.html" class="page">Maven</a> DSL, the <a href="../tools/jreleaser-gradle.html" class="page">Gradle</a> DSL.</p>
</div>
</article>
</div>

99
guide/latest/configuration/name-templates.html
View File

@@ -94,7 +94,7 @@
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../artifacts.html">Artifacts</a>
<a class="nav-link" href="../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
@@ -162,6 +162,15 @@
<li class="nav-item" data-depth="3">
<a class="nav-link" href="packagers/snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
@@ -243,6 +252,12 @@
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
@@ -254,43 +269,53 @@
<a class="nav-link" href="../tools/index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/cli.html">JReleaser CLI</a>
<a class="nav-link" href="../tools/jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/maven.html">JReleaser Maven Plugin</a>
<a class="nav-link" href="../tools/jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/gradle.html">JReleaser Gradle Plugin</a>
<a class="nav-link" href="../tools/jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/ant.html">JReleaser Ant Tasks</a>
<a class="nav-link" href="../tools/jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/tool-provider.html">JReleaser Tool Provider</a>
<a class="nav-link" href="../tools/jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/docker.html">JReleaser Docker Image</a>
<a class="nav-link" href="../tools/jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Examples</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
@@ -812,6 +837,44 @@ key, such that</p>
</div>
</div>
<div class="sect1">
<h2 id="_platform"><a class="anchor" href="#_platform"></a>Platform</h2>
<div class="sectionbody">
<div class="paragraph">
<p>The following names are related to detected OS/Platform settings</p>
</div>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 28.5714%;">
<col style="width: 71.4286%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Key</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">osName</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">value of System.getProperty("os.name")</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">osArch</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">value of System.getProperty("os.arch")</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">osPlatform</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">combination of <code>${osName}-${osArch}</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">osVersion</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">value of System.getProperty("os.version")</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="sect1">
<h2 id="_release"><a class="anchor" href="#_release"></a>Release</h2>
<div class="sectionbody">
<div class="paragraph">
@@ -889,6 +952,18 @@ key, such that</p>
<td class="tableblock halign-left valign-top"><p class="tableblock">reverseRepoHost</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">reversed Git host, i.e. "com.github"</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">changelogChanges</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">formatted commit changes</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">changelogContributors</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">list of unique names of all commit contributors</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">changelog</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">full changelog contents</p></td>
</tr>
</tbody>
</table>
<div class="paragraph">

49
guide/latest/configuration/packagers/chocolatey.html
View File

@@ -94,7 +94,7 @@
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../../artifacts.html">Artifacts</a>
<a class="nav-link" href="../../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
@@ -162,6 +162,15 @@
<li class="nav-item" data-depth="3">
<a class="nav-link" href="snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
@@ -243,6 +252,12 @@
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
@@ -254,43 +269,53 @@
<a class="nav-link" href="../../tools/index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/cli.html">JReleaser CLI</a>
<a class="nav-link" href="../../tools/jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/maven.html">JReleaser Maven Plugin</a>
<a class="nav-link" href="../../tools/jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/gradle.html">JReleaser Gradle Plugin</a>
<a class="nav-link" href="../../tools/jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/ant.html">JReleaser Ant Tasks</a>
<a class="nav-link" href="../../tools/jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/tool-provider.html">JReleaser Tool Provider</a>
<a class="nav-link" href="../../tools/jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/docker.html">JReleaser Docker Image</a>
<a class="nav-link" href="../../tools/jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Examples</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../../examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">

57
guide/latest/configuration/packagers/docker.html
View File

@@ -94,7 +94,7 @@
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../../artifacts.html">Artifacts</a>
<a class="nav-link" href="../../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
@@ -162,6 +162,15 @@
<li class="nav-item" data-depth="3">
<a class="nav-link" href="snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
@@ -243,6 +252,12 @@
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
@@ -254,43 +269,53 @@
<a class="nav-link" href="../../tools/index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/cli.html">JReleaser CLI</a>
<a class="nav-link" href="../../tools/jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/maven.html">JReleaser Maven Plugin</a>
<a class="nav-link" href="../../tools/jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/gradle.html">JReleaser Gradle Plugin</a>
<a class="nav-link" href="../../tools/jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/ant.html">JReleaser Ant Tasks</a>
<a class="nav-link" href="../../tools/jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/tool-provider.html">JReleaser Tool Provider</a>
<a class="nav-link" href="../../tools/jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/docker.html">JReleaser Docker Image</a>
<a class="nav-link" href="../../tools/jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Examples</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../../examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
@@ -1280,6 +1305,14 @@ jreleaser {
</div>
</div>
</div>
<div class="sect1">
<h2 id="_additional_files"><a class="anchor" href="#_additional_files"></a>Additional Files</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Any files placed inside <code>${docker.templateDirectory}/assembly</code> will be copied into the container at the root.</p>
</div>
</div>
</div>
</article>
</div>
</main>

49
guide/latest/configuration/packagers/homebrew.html
View File

@@ -94,7 +94,7 @@
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../../artifacts.html">Artifacts</a>
<a class="nav-link" href="../../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
@@ -162,6 +162,15 @@
<li class="nav-item" data-depth="3">
<a class="nav-link" href="snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
@@ -243,6 +252,12 @@
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
@@ -254,43 +269,53 @@
<a class="nav-link" href="../../tools/index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/cli.html">JReleaser CLI</a>
<a class="nav-link" href="../../tools/jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/maven.html">JReleaser Maven Plugin</a>
<a class="nav-link" href="../../tools/jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/gradle.html">JReleaser Gradle Plugin</a>
<a class="nav-link" href="../../tools/jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/ant.html">JReleaser Ant Tasks</a>
<a class="nav-link" href="../../tools/jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/tool-provider.html">JReleaser Tool Provider</a>
<a class="nav-link" href="../../tools/jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/docker.html">JReleaser Docker Image</a>
<a class="nav-link" href="../../tools/jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Examples</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../../examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">

49
guide/latest/configuration/packagers/index.html
View File

@@ -94,7 +94,7 @@
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../../artifacts.html">Artifacts</a>
<a class="nav-link" href="../../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
@@ -162,6 +162,15 @@
<li class="nav-item" data-depth="3">
<a class="nav-link" href="snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
@@ -243,6 +252,12 @@
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
@@ -254,43 +269,53 @@
<a class="nav-link" href="../../tools/index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/cli.html">JReleaser CLI</a>
<a class="nav-link" href="../../tools/jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/maven.html">JReleaser Maven Plugin</a>
<a class="nav-link" href="../../tools/jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/gradle.html">JReleaser Gradle Plugin</a>
<a class="nav-link" href="../../tools/jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/ant.html">JReleaser Ant Tasks</a>
<a class="nav-link" href="../../tools/jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/tool-provider.html">JReleaser Tool Provider</a>
<a class="nav-link" href="../../tools/jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/docker.html">JReleaser Docker Image</a>
<a class="nav-link" href="../../tools/jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Examples</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../../examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">

74
guide/latest/configuration/packagers/jbang.html
View File

@@ -94,7 +94,7 @@
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../../artifacts.html">Artifacts</a>
<a class="nav-link" href="../../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
@@ -162,6 +162,15 @@
<li class="nav-item" data-depth="3">
<a class="nav-link" href="snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
@@ -243,6 +252,12 @@
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
@@ -254,43 +269,53 @@
<a class="nav-link" href="../../tools/index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/cli.html">JReleaser CLI</a>
<a class="nav-link" href="../../tools/jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/maven.html">JReleaser Maven Plugin</a>
<a class="nav-link" href="../../tools/jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/gradle.html">JReleaser Gradle Plugin</a>
<a class="nav-link" href="../../tools/jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/ant.html">JReleaser Ant Tasks</a>
<a class="nav-link" href="../../tools/jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/tool-provider.html">JReleaser Tool Provider</a>
<a class="nav-link" href="../../tools/jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/docker.html">JReleaser Docker Image</a>
<a class="nav-link" href="../../tools/jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Examples</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../../examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
@@ -848,6 +873,31 @@ Aliases must be unique!
</table>
</div>
<div class="paragraph">
<p>The following property names have additional meaning</p>
</div>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 28.5714%;">
<col style="width: 71.4286%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Key</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">reverseRepoHost</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">reversed Git host, i.e. "com.github"</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">reverseDomain</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">reversed custom <a href="https://jitpack.io/docs/#custom-domain-name">domain name</a></p></td>
</tr>
</tbody>
</table>
<div class="paragraph">
<p>Assuming that the current version is <code>1.2.3</code>, and a distribution named <code>app</code>, the above configuration will generate
a <code>app.java</code> file in the <code>duke/jbang-catalog</code> repository:</p>
</div>

49
guide/latest/configuration/packagers/scoop.html
View File

@@ -94,7 +94,7 @@
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../../artifacts.html">Artifacts</a>
<a class="nav-link" href="../../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
@@ -162,6 +162,15 @@
<li class="nav-item" data-depth="3">
<a class="nav-link" href="snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
@@ -243,6 +252,12 @@
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
@@ -254,43 +269,53 @@
<a class="nav-link" href="../../tools/index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/cli.html">JReleaser CLI</a>
<a class="nav-link" href="../../tools/jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/maven.html">JReleaser Maven Plugin</a>
<a class="nav-link" href="../../tools/jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/gradle.html">JReleaser Gradle Plugin</a>
<a class="nav-link" href="../../tools/jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/ant.html">JReleaser Ant Tasks</a>
<a class="nav-link" href="../../tools/jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/tool-provider.html">JReleaser Tool Provider</a>
<a class="nav-link" href="../../tools/jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/docker.html">JReleaser Docker Image</a>
<a class="nav-link" href="../../tools/jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Examples</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../../examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">

49
guide/latest/configuration/packagers/snap.html
View File

@@ -94,7 +94,7 @@
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../../artifacts.html">Artifacts</a>
<a class="nav-link" href="../../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
@@ -162,6 +162,15 @@
<li class="nav-item is-current-page" data-depth="3">
<a class="nav-link" href="snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
@@ -243,6 +252,12 @@
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
@@ -254,43 +269,53 @@
<a class="nav-link" href="../../tools/index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/cli.html">JReleaser CLI</a>
<a class="nav-link" href="../../tools/jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/maven.html">JReleaser Maven Plugin</a>
<a class="nav-link" href="../../tools/jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/gradle.html">JReleaser Gradle Plugin</a>
<a class="nav-link" href="../../tools/jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/ant.html">JReleaser Ant Tasks</a>
<a class="nav-link" href="../../tools/jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/tool-provider.html">JReleaser Tool Provider</a>
<a class="nav-link" href="../../tools/jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/docker.html">JReleaser Docker Image</a>
<a class="nav-link" href="../../tools/jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Examples</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../../examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">

59
guide/latest/configuration/project.html
View File

@@ -94,7 +94,7 @@
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../artifacts.html">Artifacts</a>
<a class="nav-link" href="../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
@@ -162,6 +162,15 @@
<li class="nav-item" data-depth="3">
<a class="nav-link" href="packagers/snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
@@ -243,6 +252,12 @@
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
@@ -254,43 +269,53 @@
<a class="nav-link" href="../tools/index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/cli.html">JReleaser CLI</a>
<a class="nav-link" href="../tools/jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/maven.html">JReleaser Maven Plugin</a>
<a class="nav-link" href="../tools/jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/gradle.html">JReleaser Gradle Plugin</a>
<a class="nav-link" href="../tools/jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/ant.html">JReleaser Ant Tasks</a>
<a class="nav-link" href="../tools/jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/tool-provider.html">JReleaser Tool Provider</a>
<a class="nav-link" href="../tools/jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/docker.html">JReleaser Docker Image</a>
<a class="nav-link" href="../tools/jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Examples</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
@@ -402,7 +427,7 @@ project:
# A regex to determine if the project version is snapshot
# May define a `JRELEASER_SNAPSHOT_PATTERN` environment variable instead.
# <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-eye-slash"></i></span>
snapShotPattern: .*-SNAPSHOT
snapshotPattern: .*-SNAPSHOT
# A short description (60 chars max).
# <span class="icon"><i class="fa fa-exclamation-triangle"></i></span> Only if configured distributions or announcers.
@@ -495,7 +520,7 @@ project:
# A regex to determine if the project version is snapshot
# May define a `JRELEASER_SNAPSHOT_PATTERN` environment variable instead.
# <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-eye-slash"></i></span>
snapShotPattern = ".*-SNAPSHOT"
snapshotPattern = ".*-SNAPSHOT"
# A short description (60 chars max).
# <span class="icon"><i class="fa fa-exclamation-triangle"></i></span> Only if configured distributions or announcers.
@@ -583,7 +608,7 @@ project:
// A regex to determine if the project version is snapshot
// May define a `JRELEASER_SNAPSHOT_PATTERN` environment variable instead.
// <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-eye-slash"></i></span>
"snapShotPattern": ".*-SNAPSHOT",
"snapshotPattern": ".*-SNAPSHOT",
// A short description (60 chars max).
// <span class="icon"><i class="fa fa-exclamation-triangle"></i></span> Only if configured distributions or announcers.
@@ -691,7 +716,7 @@ project:
May define a `JRELEASER_SNAPSHOT_PATTERN` environment variable instead.
<span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-eye-slash"></i></span>
--&gt;
&lt;snapShotPattern&gt;.*-SNAPSHOT&lt;/snapShotPattern&gt;
&lt;snapshotPattern&gt;.*-SNAPSHOT&lt;/snapshotPattern&gt;
&lt;!--
A short description (60 chars max).
@@ -836,7 +861,7 @@ project:
// A regex to determine if the project version is snapshot
// May define a `JRELEASER_SNAPSHOT_PATTERN` environment variable instead.
// <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-eye-slash"></i></span>
snapShotPattern = '.*-SNAPSHOT'
snapshotPattern = '.*-SNAPSHOT'
// A short description (60 chars max).
// <span class="icon"><i class="fa fa-exclamation-triangle"></i></span> Only if configured distributions or announcers.

622
guide/latest/configuration/release/gitea.html
View File

@@ -94,7 +94,7 @@
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../../artifacts.html">Artifacts</a>
<a class="nav-link" href="../../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
@@ -162,6 +162,15 @@
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../packagers/snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
@@ -243,6 +252,12 @@
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
@@ -254,43 +269,53 @@
<a class="nav-link" href="../../tools/index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/cli.html">JReleaser CLI</a>
<a class="nav-link" href="../../tools/jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/maven.html">JReleaser Maven Plugin</a>
<a class="nav-link" href="../../tools/jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/gradle.html">JReleaser Gradle Plugin</a>
<a class="nav-link" href="../../tools/jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/ant.html">JReleaser Ant Tasks</a>
<a class="nav-link" href="../../tools/jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/tool-provider.html">JReleaser Tool Provider</a>
<a class="nav-link" href="../../tools/jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/docker.html">JReleaser Docker Image</a>
<a class="nav-link" href="../../tools/jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Examples</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../../examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
@@ -342,6 +367,8 @@
</aside>
<article class="doc">
<h1 class="page">Gitea</h1>
<div id="preamble">
<div class="sectionbody">
<div class="paragraph">
<p>Legend:</p>
</div>
@@ -509,6 +536,90 @@ release:
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
links: false
# Enables or disables formatting options.
# Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
# Defaults to `NEVER`.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
formatted: ALWAYS
# The template to use for each change.
# Defaults to `- {{commitShortHash}} {{commitTitle}} ({{commitAuthor}})`.
# <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
change: '- {{commitShortHash}} {{commitTitle}}'
# The template to use for the whole changelog.
# Defaults is shown.
# <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
content: |
# Changelog
{{changelogChanges}
{{changelogContributors}}
# Path to a template file that defines the contents.
# Review the available <a href="../name-templates.html" class="page">Name Templates</a>.
# Defaults to `src/jreleaser/templates/changelog.tpl`.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
contentTemplate: path/to/template/changelog.tpl
# Hide uncategorized commits.
# Defaults to `false`.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
hideUncategorized: true
# A list of labels to be included.
# Only changes matching this list will be included.
# Defaults to empty.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
includeLabels:
- 'issue'
# A list of labels to be excluded.
# Changes matching this list will be excluded.
# Defaults to empty.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
excludeLabels:
- 'issue'
# Defines rules that apply labels to changes.
# Matchers are evaluated independently; the label will
# be set if at least one of the matchers meets the criteria.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
labelers:
# The label to be applied.
# <span class="icon"><i class="fa fa-exclamation-triangle"></i></span>
- label: 'issue'
# Matches the text of the first commit line.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
title: '^fix:'
# Matches the full text of the commit.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
body: 'Fixes #'
# Groups changes by category.
# Defaults are shown.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
categories:
- title: '🚀 Features'
labels:
- 'feature'
- 'enhancement'
- title: '🐛 Bug Fixes'
labels:
- 'bug'
- 'fix'
# Defines rules for replacing the generated content.
# Each replacer is applied in order.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
replacers:
- search: '\[chore\]\s'
replace: ''
- search: '/CVE-(\d{4})-(\d+)/g'
replace: 'https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-$1-$2'
# A milestone associated with the release
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
milestone:
@@ -521,17 +632,18 @@ release:
# May define a `JRELEASER_MILESTONE_NAME` environment variable instead.
# Defaults to `{{tagName}}`.
# <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-eye-slash"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
name: {{tagName}}
name: '{{tagName}}'
# The target branch to use.
# May define a `JRELEASER_BRANCH` environment variable instead.
# Defaults to the branch pointed by HEAD.
# <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-eye-slash"></i></span>
targetCommitish: main
branch: main
# Marks the release as a draft.
# May define a `JRELEASER_DRAFT` environment variable instead.
# Defaults to `false`.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
# <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-eye-slash"></i></span>
draft: false
# Marks the release as prerelease.
@@ -690,6 +802,88 @@ release:
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
changelog.links = false
# Enables or disables formatting options.
# Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
# Defaults to `NEVER`.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
changelog.formatted = "ALWAYS"
# The template to use for each change.
# Defaults to `- {{commitShortHash}} {{commitTitle}} ({{commitAuthor}})`.
# <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
changelog.change = "- {{commitShortHash}} {{commitTitle}}"
# The template to use for the whole changelog.
# Defaults is shown.
# <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
changelog.content = """
# Changelog
{{changelogChanges}
{{changelogContributors}}"""
# Path to a template file that defines the contents.
# Review the available <a href="../name-templates.html" class="page">Name Templates</a>.
# Defaults to `src/jreleaser/templates/changelog.tpl`.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
changelog.contentTemplate = "path/to/template/changelog.tpl"
# Hide uncategorized commits.
# Defaults to `false`.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
changelog.hideUncategorized = true
# A list of labels to be included.
# Only changes matching this list will be included.
# Defaults to empty.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
changelog.includeLabels = ["issue"]
# A list of labels to be excluded.
# Changes matching this list will be excluded.
# Defaults to empty.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
changelog.excludeLabels = ["issue"]
# Defines rules that apply labels to changes.
# Matchers are evaluated independently; the label will
# be set if at least one of the matchers meets the criteria.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
[[release.gitea.changelog.labelers]]
# The label to be applied.
# <span class="icon"><i class="fa fa-exclamation-triangle"></i></span>
label = "issue"
# Matches the text of the first commit line.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
title = "^fix:"
# Matches the full text of the commit.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
body = "Fixes #"
# Groups changes by category.
# Defaults are shown.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
[[release.gitea.changelog.categories]]
title = "🚀 Features"
labels = ["feature", "enhancement"]
[[release.gitea.changelog.categories]]
title = "🐛 Bug Fixes"
labels = ["bug", "fix"]
# Defines rules for replacing the generated content.
# Each replacer is applied in order.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
[[release.gitea.changelog.replacers]]
search = "\[chore\]\s"
replace = ""
[[release.gitea.changelog.replacers]]
search = "/CVE-(\d{4})-(\d+)/g"
replace = "https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-$1-$2"
# A milestone associated with the release
# Close the milestone (if it exists and still open) upon release.
@@ -707,11 +901,12 @@ release:
# May define a `JRELEASER_BRANCH` environment variable instead.
# Defaults to the branch pointed by HEAD.
# <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-eye-slash"></i></span>
targetCommitish = "main"
branch = "main"
# Marks the release as a draft.
# May define a `JRELEASER_DRAFT` environment variable instead.
# Defaults to `false`.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
# <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-eye-slash"></i></span>
draft = false
# Marks the release as prerelease.
@@ -874,7 +1069,104 @@ release:
// Create explicit markdown links for commit hashes.
// Defaults to `false`.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
"links": false
"links": false,
// Enables or disables formatting options.
// Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
// Defaults to `NEVER`.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
"formatted": "ALWAYS",
// The template to use for each change.
// Defaults to `- {{commitShortHash}} {{commitTitle}} ({{commitAuthor}})`.
// <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
"change": "- {{commitShortHash}} {{commitTitle}}",
// The template to use for the whole changelog.
// Defaults is shown.
// <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
"content": "#Changelog\n\n{{changelogChanges}}\n{{changelogContributors}}",
// Path to a template file that defines the contents.
// Review the available <a href="../name-templates.html" class="page">Name Templates</a>.
// Defaults to `src/jreleaser/templates/changelog.tpl`.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
"contentTemplate": "path/to/template/changelog.tpl",
// Hide uncategorized commits.
// Defaults to `false`.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
"hideUncategorized": true,
// A list of labels to be included.
// Only changes matching this list will be included.
// Defaults to empty.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
"includeLabels": [
"issue"
],
// A list of labels to be excluded.
// Changes matching this list will be excluded.
// Defaults to empty.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
"excludeLabels": [
"issue"
],
// Defines rules that apply labels to changes.
// Matchers are evaluated independently; the label will
// be set if at least one of the matchers meets the criteria.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
"labelers": [
{
// The label to be applied.
// <span class="icon"><i class="fa fa-exclamation-triangle"></i></span>
"label": "issue",
// Matches the text of the first commit line.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
"title": "^fix:",
// Matches the full text of the commit.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
"body": "Fixes #"
}
],
// Groups changes by category.
// Defaults are shown.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
"categories": [
{
"title": "🚀 Features",
"labels": [
"feature",
"enhancement"
]
},
{
"title": "🐛 Bug Fixes",
"labels": [
"bug",
"fix"
]
}
],
// Defines rules for replacing the generated content.
// Each replacer is applied in order.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
"replacers": [
{
"search": "\[chore\]\s",
"replace": ""
},
{
"search": "/CVE-(\d{4})-(\d+)/g",
"replace": "https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-$1-$2"
}
]
},
// A milestone associated with the release
@@ -896,11 +1188,12 @@ release:
// May define a `JRELEASER_BRANCH` environment variable instead.
// Defaults to the branch pointed by HEAD.
// <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-eye-slash"></i></span>
"targetCommitish": "main",
"branch": "main",
// Marks the release as a draft.
// May define a `JRELEASER_DRAFT` environment variable instead.
// Defaults to `false`.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
// <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-eye-slash"></i></span>
"draft": false,
// Marks the release as prerelease.
@@ -1120,6 +1413,127 @@ release:
<span class="icon"><i class="fa fa-dot-circle"></i></span>
--&gt;
&lt;links&gt;false&lt;/links&gt;
&lt;!--
Enables or disables formatting options.
Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
Defaults to `NEVER`.
<span class="icon"><i class="fa fa-dot-circle"></i></span>
--&gt;
&lt;formatted&gt;ALWAYS&lt;/formatted&gt;
&lt;!--
The template to use for each change.
Defaults to `- {{commitShortHash}} {{commitTitle}} ({{commitAuthor}})`.
<span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
--&gt;
&lt;change&gt;- {{commitShortHash}} {{commitTitle}}&lt;/change&gt;
&lt;!--
The template to use for the whole changelog.
Defaults is shown.
<span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
--&gt;
&lt;content&gt;
# Changelog
{{changelogChanges}
{{changelogContributors}}
&lt;/content&gt;
&lt;!--
Path to a template file that defines the contents.
Review the available <a href="../name-templates.html" class="page">Name Templates</a>.
Defaults to `src/jreleaser/templates/changelog.tpl`.
<span class="icon"><i class="fa fa-dot-circle"></i></span>
--&gt;
&lt;contentTemplate&gt;path/to/template/changelog.tpl&lt;/contentTemplate&gt;
&lt;!--
Hide uncategorized commits.
Defaults to `false`.
<span class="icon"><i class="fa fa-dot-circle"></i></span>
--&gt;
&lt;hideUncategorized&gt;true&lt;/hideUncategorized&gt;
&lt;!--
A list of labels to be included.
Only changes matching this list will be included.
Defaults to empty.
<span class="icon"><i class="fa fa-dot-circle"></i></span>
--&gt;
&lt;includeLabels&gt;
&lt;includeLabel&gt;issue&lt;/includeLabel&gt;
&lt;/includeLabels&gt;
&lt;!--
A list of labels to be excluded.
Changes matching this list will be excluded.
Defaults to empty.
<span class="icon"><i class="fa fa-dot-circle"></i></span>
--&gt;
&lt;excludeLabels&gt;
&lt;excludeLabel&gt;issue&lt;/excludeLabel&gt;
&lt;/excludeLabels&gt;
&lt;!--
Defines rules that apply labels to changes.
Matchers are evaluated independently; the label will
be set if at least one of the matchers meets the criteria.
<span class="icon"><i class="fa fa-dot-circle"></i></span>
--&gt;
&lt;labelers&gt;
&lt;labeler&gt;
&lt;!--
The label to be applied.
<span class="icon"><i class="fa fa-exclamation-triangle"></i></span>
--&gt;
&lt;label&gt;issue&lt;/label&gt;
&lt;!--
Matches the text of the first commit line.
<span class="icon"><i class="fa fa-dot-circle"></i></span>
--&gt;
&lt;title&gt;^fix:&lt;/title&gt;
&lt;!--
Matches the full text of the commit.
<span class="icon"><i class="fa fa-dot-circle"></i></span>
--&gt;
&lt;body&gt;Fixes #&lt;/body&gt;
&lt;/labeler&gt;
&lt;/labelers&gt;
&lt;!--
Groups changes by category.
Defaults are shown.
<span class="icon"><i class="fa fa-dot-circle"></i></span>
--&gt;
&lt;categories&gt;
&lt;category&gt;
&lt;title&gt;🚀 Features&lt;/title&gt;
&lt;labelsAsString&gt;feature,enhancement&lt;/labelsAsString&gt;
&lt;/category&gt;
&lt;category&gt;
&lt;title&gt;🐛 Bug Fixes&lt;/title&gt;
&lt;labelsAsString&gt;bug,fix&lt;/labelsAsString&gt;
&lt;/category&gt;
&lt;/categories&gt;
&lt;!--
Defines rules for replacing the generated content.
Each replacer is applied in order.
<span class="icon"><i class="fa fa-dot-circle"></i></span>
--&gt;
&lt;replacers&gt;
&lt;replacer&gt;
&lt;search&gt;\[chore\]\s&lt;/search&gt;
&lt;/replacer&gt;
&lt;replacer&gt;
&lt;search&gt;/CVE-(\d{4})-(\d+)/g&lt;/search&gt;
&lt;replace&gt;https: cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-$1-$2&lt;/replace&gt;
&lt;/replacer&gt;
&lt;/replacers&gt;
&lt;/changelog&gt;
&lt;!--
@@ -1150,12 +1564,13 @@ release:
Defaults to the branch pointed by HEAD.
<span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-eye-slash"></i></span>
--&gt;
&lt;targetCommitish&gt;main&lt;/targetCommitish&gt;
&lt;branch&gt;main&lt;/branch&gt;
&lt;!--
Marks the release as a draft.
May define a `JRELEASER_DRAFT` environment variable instead.
Defaults to `false`.
<span class="icon"><i class="fa fa-dot-circle"></i></span>
<span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-eye-slash"></i></span>
--&gt;
&lt;draft&gt;false&lt;/draft&gt;
@@ -1341,6 +1756,97 @@ release:
// Defaults to `false`.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
links = false
// Enables or disables formatting options.
// Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
// Defaults to `NEVER`.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
formatted = 'ALWAYS'
// The template to use for each change.
// Defaults to `- {{commitShortHash}} {{commitTitle}} ({{commitAuthor}})`.
// <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
change = '- {{commitShortHash}} {{commitTitle}}'
// The template to use for the whole changelog.
// Defaults is shown.
// <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
content = '#Changelog\n\n{{changelogChanges}}\n{{changelogContributors}}'
// Path to a template file that defines the contents.
// Review the available <a href="../name-templates.html" class="page">Name Templates</a>.
// Defaults to `src/jreleaser/templates/changelog.tpl`.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
contentTemplate = 'path/to/template/changelog.tpl'
// Hide uncategorized commits.
// Defaults to `false`.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
hideUncategorized = true
// A list of labels to be included.
// Only changes matching this list will be included.
// Defaults to empty.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
includeLabels = [
'issue'
]
// A list of labels to be excluded.
// Changes matching this list will be excluded.
// Defaults to empty.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
excludeLabels = [
'issue'
]
// Defines rules that apply labels to changes.
// Matchers are evaluated independently; the label will
// be set if at least one of the matchers meets the criteria.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
labeler {
// The label to be applied.
// <span class="icon"><i class="fa fa-exclamation-triangle"></i></span>
label = 'issue'
// Matches the text of the first commit line.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
title = '^fix:'
// Matches the full text of the commit.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
body = 'Fixes #'
}
// Groups changes by category.
// Defaults are shown.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
category {
title = '🚀 Features'
labels = [
'feature',
'enhancement'
]
}
category {
title = '🐛 Bug Fixes'
labels = [
'bug',
'fix'
]
}
// Defines rules for replacing the generated content.
// Each replacer is applied in order.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
replacer {
search = '\[chore\]\s'
replace = ''
}
replacer {
search = '/CVE-(\d{4})-(\d+)/g'
replace = 'https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-$1-$2'
}
}
// A milestone associated with the release
@@ -1362,11 +1868,12 @@ release:
// May define a `JRELEASER_BRANCH` environment variable instead.
// Defaults to the branch pointed by HEAD.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>v
targetCommitish = 'main'
branch = 'main'
// Marks the release as a draft.
// May define a `JRELEASER_DRAFT` environment variable instead.
// Defaults to `false`.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
// <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-eye-slash"></i></span>
draft = false
// Marks the release as prerelease.
@@ -1405,6 +1912,73 @@ release:
</div>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_changelog"><a class="anchor" href="#_changelog"></a>Changelog</h2>
<div class="sectionbody">
<div class="paragraph">
<p>You may define either <code>content</code> or <code>contentTemplate</code>, with the latter taking precedence over the former.</p>
</div>
<div class="paragraph">
<p>Changelog format applies only to the automatically generated changelog, that is, formatting wo&#8217;t occur if the <code>external</code>
property is set. Format applies only to local commits at the moment, the use of labelers is highly encouraged.</p>
</div>
<div class="paragraph">
<p>The <code>change</code> property only accepts the following name templates:</p>
</div>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 28.5714%;">
<col style="width: 71.4286%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Key</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">commitShortHash</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">head commit hash abbreviated to 7 characters</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">commitFullHash</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">head commit hash</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">commitTitle</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">first line of the commit message</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">commitAuthor</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">full name of the commit author</p></td>
</tr>
</tbody>
</table>
<div class="paragraph">
<p>The <code>content</code> and <code>contentTemplate</code> accept all <a href="../name-templates.html" class="page">Name Templates</a>, take special consideration on
<code>{{changelogChanges}}</code> and <code>{{changelogContributors}}</code> as they define the parsed commits.</p>
</div>
<div class="paragraph">
<p>The following configuration</p>
</div>
<div class="imageblock">
<div class="content">
<img src="../../_images/jreleaser-changelog-config.jpg" alt="jreleaser changelog config">
</div>
</div>
<div class="paragraph">
<p>Generates a changelog similar to</p>
</div>
<div class="imageblock">
<div class="content">
<img src="../../_images/jreleaser-changelog-render.jpg" alt="jreleaser changelog render">
</div>
</div>
</div>
</div>
</article>
</div>
</main>

622
guide/latest/configuration/release/github.html
View File

@@ -94,7 +94,7 @@
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../../artifacts.html">Artifacts</a>
<a class="nav-link" href="../../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
@@ -162,6 +162,15 @@
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../packagers/snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
@@ -243,6 +252,12 @@
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
@@ -254,43 +269,53 @@
<a class="nav-link" href="../../tools/index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/cli.html">JReleaser CLI</a>
<a class="nav-link" href="../../tools/jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/maven.html">JReleaser Maven Plugin</a>
<a class="nav-link" href="../../tools/jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/gradle.html">JReleaser Gradle Plugin</a>
<a class="nav-link" href="../../tools/jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/ant.html">JReleaser Ant Tasks</a>
<a class="nav-link" href="../../tools/jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/tool-provider.html">JReleaser Tool Provider</a>
<a class="nav-link" href="../../tools/jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/docker.html">JReleaser Docker Image</a>
<a class="nav-link" href="../../tools/jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Examples</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../../examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
@@ -342,6 +367,8 @@
</aside>
<article class="doc">
<h1 class="page">GitHub</h1>
<div id="preamble">
<div class="sectionbody">
<div class="paragraph">
<p>Legend:</p>
</div>
@@ -512,6 +539,90 @@ release:
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
links: false
# Enables or disables formatting options.
# Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
# Defaults to `NEVER`.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
formatted: ALWAYS
# The template to use for each change.
# Defaults to `- {{commitShortHash}} {{commitTitle}} ({{commitAuthor}})`.
# <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
change: '- {{commitShortHash}} {{commitTitle}}'
# The template to use for the whole changelog.
# Defaults is shown.
# <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
content: |
# Changelog
{{changelogChanges}
{{changelogContributors}}
# Path to a template file that defines the contents.
# Review the available <a href="../name-templates.html" class="page">Name Templates</a>.
# Defaults to `src/jreleaser/templates/changelog.tpl`.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
contentTemplate: path/to/template/changelog.tpl
# Hide uncategorized commits.
# Defaults to `false`.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
hideUncategorized: true
# A list of labels to be included.
# Only changes matching this list will be included.
# Defaults to empty.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
includeLabels:
- 'issue'
# A list of labels to be excluded.
# Changes matching this list will be excluded.
# Defaults to empty.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
excludeLabels:
- 'issue'
# Defines rules that apply labels to changes.
# Matchers are evaluated independently; the label will
# be set if at least one of the matchers meets the criteria.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
labelers:
# The label to be applied.
# <span class="icon"><i class="fa fa-exclamation-triangle"></i></span>
- label: 'issue'
# Matches the text of the first commit line.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
title: '^fix:'
# Matches the full text of the commit.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
body: 'Fixes #'
# Groups changes by category.
# Defaults are shown.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
categories:
- title: '🚀 Features'
labels:
- 'feature'
- 'enhancement'
- title: '🐛 Bug Fixes'
labels:
- 'bug'
- 'fix'
# Defines rules for replacing the generated content.
# Each replacer is applied in order.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
replacers:
- search: '\[chore\]\s'
replace: ''
- search: '/CVE-(\d{4})-(\d+)/g'
replace: 'https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-$1-$2'
# A milestone associated with the release
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
milestone:
@@ -524,17 +635,18 @@ release:
# May define a `JRELEASER_MILESTONE_NAME` environment variable instead.
# Defaults to `{{tagName}}`.
# <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-eye-slash"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
name: {{tagName}}
name: '{{tagName}}'
# The target branch to use.
# May define a `JRELEASER_BRANCH` environment variable instead.
# Defaults to the branch pointed by HEAD.
# <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-eye-slash"></i></span>
targetCommitish: main
branch: main
# Marks the release as a draft.
# May define a `JRELEASER_DRAFT` environment variable instead.
# Defaults to `false`.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
# <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-eye-slash"></i></span>
draft: false
# Marks the release as prerelease.
@@ -694,6 +806,88 @@ release:
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
changelog.links = false
# Enables or disables formatting options.
# Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
# Defaults to `NEVER`.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
changelog.formatted = "ALWAYS"
# The template to use for each change.
# Defaults to `- {{commitShortHash}} {{commitTitle}} ({{commitAuthor}})`.
# <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
changelog.change = "- {{commitShortHash}} {{commitTitle}}"
# The template to use for the whole changelog.
# Defaults is shown.
# <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
changelog.content = """
# Changelog
{{changelogChanges}
{{changelogContributors}}"""
# Path to a template file that defines the contents.
# Review the available <a href="../name-templates.html" class="page">Name Templates</a>.
# Defaults to `src/jreleaser/templates/changelog.tpl`.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
changelog.contentTemplate = "path/to/template/changelog.tpl"
# Hide uncategorized commits.
# Defaults to `false`.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
changelog.hideUncategorized = true
# A list of labels to be included.
# Only changes matching this list will be included.
# Defaults to empty.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
changelog.includeLabels = ["issue"]
# A list of labels to be excluded.
# Changes matching this list will be excluded.
# Defaults to empty.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
changelog.excludeLabels = ["issue"]
# Defines rules that apply labels to changes.
# Matchers are evaluated independently; the label will
# be set if at least one of the matchers meets the criteria.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
[[release.github.changelog.labelers]]
# The label to be applied.
# <span class="icon"><i class="fa fa-exclamation-triangle"></i></span>
label = "issue"
# Matches the text of the first commit line.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
title = "^fix:"
# Matches the full text of the commit.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
body = "Fixes #"
# Groups changes by category.
# Defaults are shown.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
[[release.github.changelog.categories]]
title = "🚀 Features"
labels = ["feature", "enhancement"]
[[release.github.changelog.categories]]
title = "🐛 Bug Fixes"
labels = ["bug", "fix"]
# Defines rules for replacing the generated content.
# Each replacer is applied in order.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
[[release.github.changelog.replacers]]
search = "\[chore\]\s"
replace = ""
[[release.github.changelog.replacers]]
search = "/CVE-(\d{4})-(\d+)/g"
replace = "https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-$1-$2"
# A milestone associated with the release
# Close the milestone (if it exists and still open) upon release.
@@ -711,11 +905,12 @@ release:
# May define a `JRELEASER_BRANCH` environment variable instead.
# Defaults to the branch pointed by HEAD.
# <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-eye-slash"></i></span>
targetCommitish = "main"
branch = "main"
# Marks the release as a draft.
# May define a `JRELEASER_DRAFT` environment variable instead.
# Defaults to `false`.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
# <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-eye-slash"></i></span>
draft = false
# Marks the release as prerelease.
@@ -881,7 +1076,104 @@ release:
// Create explicit markdown links for commit hashes.
// Defaults to `false`.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
"links": false
"links": false,
// Enables or disables formatting options.
// Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
// Defaults to `NEVER`.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
"formatted": "ALWAYS",
// The template to use for each change.
// Defaults to `- {{commitShortHash}} {{commitTitle}} ({{commitAuthor}})`.
// <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
"change": "- {{commitShortHash}} {{commitTitle}}",
// The template to use for the whole changelog.
// Defaults is shown.
// <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
"content": "#Changelog\n\n{{changelogChanges}}\n{{changelogContributors}}",
// Path to a template file that defines the contents.
// Review the available <a href="../name-templates.html" class="page">Name Templates</a>.
// Defaults to `src/jreleaser/templates/changelog.tpl`.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
"contentTemplate": "path/to/template/changelog.tpl",
// Hide uncategorized commits.
// Defaults to `false`.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
"hideUncategorized": true,
// A list of labels to be included.
// Only changes matching this list will be included.
// Defaults to empty.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
"includeLabels": [
"issue"
],
// A list of labels to be excluded.
// Changes matching this list will be excluded.
// Defaults to empty.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
"excludeLabels": [
"issue"
],
// Defines rules that apply labels to changes.
// Matchers are evaluated independently; the label will
// be set if at least one of the matchers meets the criteria.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
"labelers": [
{
// The label to be applied.
// <span class="icon"><i class="fa fa-exclamation-triangle"></i></span>
"label": "issue",
// Matches the text of the first commit line.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
"title": "^fix:",
// Matches the full text of the commit.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
"body": "Fixes #"
}
],
// Groups changes by category.
// Defaults are shown.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
"categories": [
{
"title": "🚀 Features",
"labels": [
"feature",
"enhancement"
]
},
{
"title": "🐛 Bug Fixes",
"labels": [
"bug",
"fix"
]
}
],
// Defines rules for replacing the generated content.
// Each replacer is applied in order.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
"replacers": [
{
"search": "\[chore\]\s",
"replace": ""
},
{
"search": "/CVE-(\d{4})-(\d+)/g",
"replace": "https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-$1-$2"
}
]
},
// A milestone associated with the release
@@ -903,11 +1195,12 @@ release:
// May define a `JRELEASER_BRANCH` environment variable instead.
// Defaults to the branch pointed by HEAD.
// <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-eye-slash"></i></span>
"targetCommitish": "main",
"branch": "main",
// Marks the release as a draft.
// May define a `JRELEASER_DRAFT` environment variable instead.
// Defaults to `false`.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
// <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-eye-slash"></i></span>
"draft": false,
// Marks the release as prerelease.
@@ -1130,6 +1423,127 @@ release:
<span class="icon"><i class="fa fa-dot-circle"></i></span>
--&gt;
&lt;links&gt;false&lt;/links&gt;
&lt;!--
Enables or disables formatting options.
Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
Defaults to `NEVER`.
<span class="icon"><i class="fa fa-dot-circle"></i></span>
--&gt;
&lt;formatted&gt;ALWAYS&lt;/formatted&gt;
&lt;!--
The template to use for each change.
Defaults to `- {{commitShortHash}} {{commitTitle}} ({{commitAuthor}})`.
<span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
--&gt;
&lt;change&gt;- {{commitShortHash}} {{commitTitle}}&lt;/change&gt;
&lt;!--
The template to use for the whole changelog.
Defaults is shown.
<span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
--&gt;
&lt;content&gt;
# Changelog
{{changelogChanges}
{{changelogContributors}}
&lt;/content&gt;
&lt;!--
Path to a template file that defines the contents.
Review the available <a href="../name-templates.html" class="page">Name Templates</a>.
Defaults to `src/jreleaser/templates/changelog.tpl`.
<span class="icon"><i class="fa fa-dot-circle"></i></span>
--&gt;
&lt;contentTemplate&gt;path/to/template/changelog.tpl&lt;/contentTemplate&gt;
&lt;!--
Hide uncategorized commits.
Defaults to `false`.
<span class="icon"><i class="fa fa-dot-circle"></i></span>
--&gt;
&lt;hideUncategorized&gt;true&lt;/hideUncategorized&gt;
&lt;!--
A list of labels to be included.
Only changes matching this list will be included.
Defaults to empty.
<span class="icon"><i class="fa fa-dot-circle"></i></span>
--&gt;
&lt;includeLabels&gt;
&lt;includeLabel&gt;issue&lt;/includeLabel&gt;
&lt;/includeLabels&gt;
&lt;!--
A list of labels to be excluded.
Changes matching this list will be excluded.
Defaults to empty.
<span class="icon"><i class="fa fa-dot-circle"></i></span>
--&gt;
&lt;excludeLabels&gt;
&lt;excludeLabel&gt;issue&lt;/excludeLabel&gt;
&lt;/excludeLabels&gt;
&lt;!--
Defines rules that apply labels to changes.
Matchers are evaluated independently; the label will
be set if at least one of the matchers meets the criteria.
<span class="icon"><i class="fa fa-dot-circle"></i></span>
--&gt;
&lt;labelers&gt;
&lt;labeler&gt;
&lt;!--
The label to be applied.
<span class="icon"><i class="fa fa-exclamation-triangle"></i></span>
--&gt;
&lt;label&gt;issue&lt;/label&gt;
&lt;!--
Matches the text of the first commit line.
<span class="icon"><i class="fa fa-dot-circle"></i></span>
--&gt;
&lt;title&gt;^fix:&lt;/title&gt;
&lt;!--
Matches the full text of the commit.
<span class="icon"><i class="fa fa-dot-circle"></i></span>
--&gt;
&lt;body&gt;Fixes #&lt;/body&gt;
&lt;/labeler&gt;
&lt;/labelers&gt;
&lt;!--
Groups changes by category.
Defaults are shown.
<span class="icon"><i class="fa fa-dot-circle"></i></span>
--&gt;
&lt;categories&gt;
&lt;category&gt;
&lt;title&gt;🚀 Features&lt;/title&gt;
&lt;labelsAsString&gt;feature,enhancement&lt;/labelsAsString&gt;
&lt;/category&gt;
&lt;category&gt;
&lt;title&gt;🐛 Bug Fixes&lt;/title&gt;
&lt;labelsAsString&gt;bug,fix&lt;/labelsAsString&gt;
&lt;/category&gt;
&lt;/categories&gt;
&lt;!--
Defines rules for replacing the generated content.
Each replacer is applied in order.
<span class="icon"><i class="fa fa-dot-circle"></i></span>
--&gt;
&lt;replacers&gt;
&lt;replacer&gt;
&lt;search&gt;\[chore\]\s&lt;/search&gt;
&lt;/replacer&gt;
&lt;replacer&gt;
&lt;search&gt;/CVE-(\d{4})-(\d+)/g&lt;/search&gt;
&lt;replace&gt;https: cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-$1-$2&lt;/replace&gt;
&lt;/replacer&gt;
&lt;/replacers&gt;
&lt;/changelog&gt;
&lt;!--
@@ -1160,12 +1574,13 @@ release:
Defaults to the branch pointed by HEAD.
<span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-eye-slash"></i></span>
--&gt;
&lt;targetCommitish&gt;main&lt;/targetCommitish&gt;
&lt;branch&gt;main&lt;/branch&gt;
&lt;!--
Marks the release as a draft.
May define a `JRELEASER_DRAFT` environment variable instead.
Defaults to `false`.
<span class="icon"><i class="fa fa-dot-circle"></i></span>
<span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-eye-slash"></i></span>
--&gt;
&lt;draft&gt;false&lt;/draft&gt;
@@ -1354,6 +1769,97 @@ release:
// Defaults to `false`.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
links = false
// Enables or disables formatting options.
// Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
// Defaults to `NEVER`.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
formatted = 'ALWAYS'
// The template to use for each change.
// Defaults to `- {{commitShortHash}} {{commitTitle}} ({{commitAuthor}})`.
// <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
change = '- {{commitShortHash}} {{commitTitle}}'
// The template to use for the whole changelog.
// Defaults is shown.
// <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
content = '#Changelog\n\n{{changelogChanges}}\n{{changelogContributors}}'
// Path to a template file that defines the contents.
// Review the available <a href="../name-templates.html" class="page">Name Templates</a>.
// Defaults to `src/jreleaser/templates/changelog.tpl`.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
contentTemplate = 'path/to/template/changelog.tpl'
// Hide uncategorized commits.
// Defaults to `false`.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
hideUncategorized = true
// A list of labels to be included.
// Only changes matching this list will be included.
// Defaults to empty.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
includeLabels = [
'issue'
]
// A list of labels to be excluded.
// Changes matching this list will be excluded.
// Defaults to empty.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
excludeLabels = [
'issue'
]
// Defines rules that apply labels to changes.
// Matchers are evaluated independently; the label will
// be set if at least one of the matchers meets the criteria.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
labeler {
// The label to be applied.
// <span class="icon"><i class="fa fa-exclamation-triangle"></i></span>
label = 'issue'
// Matches the text of the first commit line.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
title = '^fix:'
// Matches the full text of the commit.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
body = 'Fixes #'
}
// Groups changes by category.
// Defaults are shown.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
category {
title = '🚀 Features'
labels = [
'feature',
'enhancement'
]
}
category {
title = '🐛 Bug Fixes'
labels = [
'bug',
'fix'
]
}
// Defines rules for replacing the generated content.
// Each replacer is applied in order.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
replacer {
search = '\[chore\]\s'
replace = ''
}
replacer {
search = '/CVE-(\d{4})-(\d+)/g'
replace = 'https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-$1-$2'
}
}
// A milestone associated with the release
@@ -1375,11 +1881,12 @@ release:
// May define a `JRELEASER_BRANCH` environment variable instead.
// Defaults to the branch pointed by HEAD.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>v
targetCommitish = 'main'
branch = 'main'
// Marks the release as a draft.
// May define a `JRELEASER_DRAFT` environment variable instead.
// Defaults to `false`.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
// <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-eye-slash"></i></span>
draft = false
// Marks the release as prerelease.
@@ -1418,6 +1925,73 @@ release:
</div>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_changelog"><a class="anchor" href="#_changelog"></a>Changelog</h2>
<div class="sectionbody">
<div class="paragraph">
<p>You may define either <code>content</code> or <code>contentTemplate</code>, with the latter taking precedence over the former.</p>
</div>
<div class="paragraph">
<p>Changelog format applies only to the automatically generated changelog, that is, formatting wo&#8217;t occur if the <code>external</code>
property is set. Format applies only to local commits at the moment, the use of labelers is highly encouraged.</p>
</div>
<div class="paragraph">
<p>The <code>change</code> property only accepts the following name templates:</p>
</div>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 28.5714%;">
<col style="width: 71.4286%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Key</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">commitShortHash</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">head commit hash abbreviated to 7 characters</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">commitFullHash</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">head commit hash</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">commitTitle</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">first line of the commit message</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">commitAuthor</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">full name of the commit author</p></td>
</tr>
</tbody>
</table>
<div class="paragraph">
<p>The <code>content</code> and <code>contentTemplate</code> accept all <a href="../name-templates.html" class="page">Name Templates</a>, take special consideration on
<code>{{changelogChanges}}</code> and <code>{{changelogContributors}}</code> as they define the parsed commits.</p>
</div>
<div class="paragraph">
<p>The following configuration</p>
</div>
<div class="imageblock">
<div class="content">
<img src="../../_images/jreleaser-changelog-config.jpg" alt="jreleaser changelog config">
</div>
</div>
<div class="paragraph">
<p>Generates a changelog similar to</p>
</div>
<div class="imageblock">
<div class="content">
<img src="../../_images/jreleaser-changelog-render.jpg" alt="jreleaser changelog render">
</div>
</div>
</div>
</div>
</article>
</div>
</main>

607
guide/latest/configuration/release/gitlab.html
View File

@@ -94,7 +94,7 @@
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../../artifacts.html">Artifacts</a>
<a class="nav-link" href="../../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
@@ -162,6 +162,15 @@
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../packagers/snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
@@ -243,6 +252,12 @@
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
@@ -254,43 +269,53 @@
<a class="nav-link" href="../../tools/index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/cli.html">JReleaser CLI</a>
<a class="nav-link" href="../../tools/jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/maven.html">JReleaser Maven Plugin</a>
<a class="nav-link" href="../../tools/jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/gradle.html">JReleaser Gradle Plugin</a>
<a class="nav-link" href="../../tools/jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/ant.html">JReleaser Ant Tasks</a>
<a class="nav-link" href="../../tools/jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/tool-provider.html">JReleaser Tool Provider</a>
<a class="nav-link" href="../../tools/jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/docker.html">JReleaser Docker Image</a>
<a class="nav-link" href="../../tools/jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Examples</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../../examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
@@ -342,6 +367,8 @@
</aside>
<article class="doc">
<h1 class="page">GitLab</h1>
<div id="preamble">
<div class="sectionbody">
<div class="paragraph">
<p>Legend:</p>
</div>
@@ -512,6 +539,90 @@ release:
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
links: false
# Enables or disables formatting options.
# Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
# Defaults to `NEVER`.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
formatted: ALWAYS
# The template to use for each change.
# Defaults to `- {{commitShortHash}} {{commitTitle}} ({{commitAuthor}})`.
# <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
change: '- {{commitShortHash}} {{commitTitle}}'
# The template to use for the whole changelog.
# Defaults is shown.
# <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
content: |
# Changelog
{{changelogChanges}
{{changelogContributors}}
# Path to a template file that defines the contents.
# Review the available <a href="../name-templates.html" class="page">Name Templates</a>.
# Defaults to `src/jreleaser/templates/changelog.tpl`.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
contentTemplate: path/to/template/changelog.tpl
# Hide uncategorized commits.
# Defaults to `false`.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
hideUncategorized: true
# A list of labels to be included.
# Only changes matching this list will be included.
# Defaults to empty.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
includeLabels:
- 'issue'
# A list of labels to be excluded.
# Changes matching this list will be excluded.
# Defaults to empty.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
excludeLabels:
- 'issue'
# Defines rules that apply labels to changes.
# Matchers are evaluated independently; the label will
# be set if at least one of the matchers meets the criteria.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
labelers:
# The label to be applied.
# <span class="icon"><i class="fa fa-exclamation-triangle"></i></span>
- label: 'issue'
# Matches the text of the first commit line.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
title: '^fix:'
# Matches the full text of the commit.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
body: 'Fixes #'
# Groups changes by category.
# Defaults are shown.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
categories:
- title: '🚀 Features'
labels:
- 'feature'
- 'enhancement'
- title: '🐛 Bug Fixes'
labels:
- 'bug'
- 'fix'
# Defines rules for replacing the generated content.
# Each replacer is applied in order.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
replacers:
- search: '\[chore\]\s'
replace: ''
- search: '/CVE-(\d{4})-(\d+)/g'
replace: 'https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-$1-$2'
# A milestone associated with the release
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
milestone:
@@ -524,13 +635,13 @@ release:
# May define a `JRELEASER_MILESTONE_NAME` environment variable instead.
# Defaults to `{{tagName}}`.
# <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-eye-slash"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
name: {{tagName}}
name: '{{tagName}}'
# The target branch to use.
# May define a `JRELEASER_BRANCH` environment variable instead.
# Defaults to the branch pointed by HEAD.
# <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-eye-slash"></i></span>
ref: main
branch: main
# The following properties define <span class="icon"><i class="fa fa-dot-circle"></i></span> URL formats.
# Defaults are shown.
@@ -684,6 +795,88 @@ release:
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
changelog.links = false
# Enables or disables formatting options.
# Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
# Defaults to `NEVER`.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
changelog.formatted = "ALWAYS"
# The template to use for each change.
# Defaults to `- {{commitShortHash}} {{commitTitle}} ({{commitAuthor}})`.
# <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
changelog.change = "- {{commitShortHash}} {{commitTitle}}"
# The template to use for the whole changelog.
# Defaults is shown.
# <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
changelog.content = """
# Changelog
{{changelogChanges}
{{changelogContributors}}"""
# Path to a template file that defines the contents.
# Review the available <a href="../name-templates.html" class="page">Name Templates</a>.
# Defaults to `src/jreleaser/templates/changelog.tpl`.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
changelog.contentTemplate = "path/to/template/changelog.tpl"
# Hide uncategorized commits.
# Defaults to `false`.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
changelog.hideUncategorized = true
# A list of labels to be included.
# Only changes matching this list will be included.
# Defaults to empty.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
changelog.includeLabels = ["issue"]
# A list of labels to be excluded.
# Changes matching this list will be excluded.
# Defaults to empty.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
changelog.excludeLabels = ["issue"]
# Defines rules that apply labels to changes.
# Matchers are evaluated independently; the label will
# be set if at least one of the matchers meets the criteria.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
[[release.gitlab.changelog.labelers]]
# The label to be applied.
# <span class="icon"><i class="fa fa-exclamation-triangle"></i></span>
label = "issue"
# Matches the text of the first commit line.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
title = "^fix:"
# Matches the full text of the commit.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
body = "Fixes #"
# Groups changes by category.
# Defaults are shown.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
[[release.gitlab.changelog.categories]]
title = "🚀 Features"
labels = ["feature", "enhancement"]
[[release.gitlab.changelog.categories]]
title = "🐛 Bug Fixes"
labels = ["bug", "fix"]
# Defines rules for replacing the generated content.
# Each replacer is applied in order.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
[[release.gitlab.changelog.replacers]]
search = "\[chore\]\s"
replace = ""
[[release.gitlab.changelog.replacers]]
search = "/CVE-(\d{4})-(\d+)/g"
replace = "https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-$1-$2"
# A milestone associated with the release
# Close the milestone (if it exists and still open) upon release.
@@ -701,7 +894,7 @@ release:
# May define a `JRELEASER_BRANCH` environment variable instead.
# Defaults to the branch pointed by HEAD.
# <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-eye-slash"></i></span>
ref = "main"
branch = "main"
# The following properties define <span class="icon"><i class="fa fa-dot-circle"></i></span> URL formats.
# Defaults are shown.
@@ -860,7 +1053,104 @@ release:
// Create explicit markdown links for commit hashes.
// Defaults to `false`.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
"links": false
"links": false,
// Enables or disables formatting options.
// Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
// Defaults to `NEVER`.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
"formatted": "ALWAYS",
// The template to use for each change.
// Defaults to `- {{commitShortHash}} {{commitTitle}} ({{commitAuthor}})`.
// <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
"change": "- {{commitShortHash}} {{commitTitle}}",
// The template to use for the whole changelog.
// Defaults is shown.
// <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
"content": "#Changelog\n\n{{changelogChanges}}\n{{changelogContributors}}",
// Path to a template file that defines the contents.
// Review the available <a href="../name-templates.html" class="page">Name Templates</a>.
// Defaults to `src/jreleaser/templates/changelog.tpl`.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
"contentTemplate": "path/to/template/changelog.tpl",
// Hide uncategorized commits.
// Defaults to `false`.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
"hideUncategorized": true,
// A list of labels to be included.
// Only changes matching this list will be included.
// Defaults to empty.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
"includeLabels": [
"issue"
],
// A list of labels to be excluded.
// Changes matching this list will be excluded.
// Defaults to empty.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
"excludeLabels": [
"issue"
],
// Defines rules that apply labels to changes.
// Matchers are evaluated independently; the label will
// be set if at least one of the matchers meets the criteria.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
"labelers": [
{
// The label to be applied.
// <span class="icon"><i class="fa fa-exclamation-triangle"></i></span>
"label": "issue",
// Matches the text of the first commit line.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
"title": "^fix:",
// Matches the full text of the commit.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
"body": "Fixes #"
}
],
// Groups changes by category.
// Defaults are shown.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
"categories": [
{
"title": "🚀 Features",
"labels": [
"feature",
"enhancement"
]
},
{
"title": "🐛 Bug Fixes",
"labels": [
"bug",
"fix"
]
}
],
// Defines rules for replacing the generated content.
// Each replacer is applied in order.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
"replacers": [
{
"search": "\[chore\]\s",
"replace": ""
},
{
"search": "/CVE-(\d{4})-(\d+)/g",
"replace": "https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-$1-$2"
}
]
},
// A milestone associated with the release
@@ -882,7 +1172,7 @@ release:
// May define a `JRELEASER_BRANCH` environment variable instead.
// Defaults to the branch pointed by HEAD.
// <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-eye-slash"></i></span>
"ref": "main",
"branch": "main",
// The following properties define <span class="icon"><i class="fa fa-dot-circle"></i></span> URL formats.
// Defaults are shown.
@@ -1098,6 +1388,127 @@ release:
<span class="icon"><i class="fa fa-dot-circle"></i></span>
--&gt;
&lt;links&gt;false&lt;/links&gt;
&lt;!--
Enables or disables formatting options.
Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
Defaults to `NEVER`.
<span class="icon"><i class="fa fa-dot-circle"></i></span>
--&gt;
&lt;formatted&gt;ALWAYS&lt;/formatted&gt;
&lt;!--
The template to use for each change.
Defaults to `- {{commitShortHash}} {{commitTitle}} ({{commitAuthor}})`.
<span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
--&gt;
&lt;change&gt;- {{commitShortHash}} {{commitTitle}}&lt;/change&gt;
&lt;!--
The template to use for the whole changelog.
Defaults is shown.
<span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
--&gt;
&lt;content&gt;
# Changelog
{{changelogChanges}
{{changelogContributors}}
&lt;/content&gt;
&lt;!--
Path to a template file that defines the contents.
Review the available <a href="../name-templates.html" class="page">Name Templates</a>.
Defaults to `src/jreleaser/templates/changelog.tpl`.
<span class="icon"><i class="fa fa-dot-circle"></i></span>
--&gt;
&lt;contentTemplate&gt;path/to/template/changelog.tpl&lt;/contentTemplate&gt;
&lt;!--
Hide uncategorized commits.
Defaults to `false`.
<span class="icon"><i class="fa fa-dot-circle"></i></span>
--&gt;
&lt;hideUncategorized&gt;true&lt;/hideUncategorized&gt;
&lt;!--
A list of labels to be included.
Only changes matching this list will be included.
Defaults to empty.
<span class="icon"><i class="fa fa-dot-circle"></i></span>
--&gt;
&lt;includeLabels&gt;
&lt;includeLabel&gt;issue&lt;/includeLabel&gt;
&lt;/includeLabels&gt;
&lt;!--
A list of labels to be excluded.
Changes matching this list will be excluded.
Defaults to empty.
<span class="icon"><i class="fa fa-dot-circle"></i></span>
--&gt;
&lt;excludeLabels&gt;
&lt;excludeLabel&gt;issue&lt;/excludeLabel&gt;
&lt;/excludeLabels&gt;
&lt;!--
Defines rules that apply labels to changes.
Matchers are evaluated independently; the label will
be set if at least one of the matchers meets the criteria.
<span class="icon"><i class="fa fa-dot-circle"></i></span>
--&gt;
&lt;labelers&gt;
&lt;labeler&gt;
&lt;!--
The label to be applied.
<span class="icon"><i class="fa fa-exclamation-triangle"></i></span>
--&gt;
&lt;label&gt;issue&lt;/label&gt;
&lt;!--
Matches the text of the first commit line.
<span class="icon"><i class="fa fa-dot-circle"></i></span>
--&gt;
&lt;title&gt;^fix:&lt;/title&gt;
&lt;!--
Matches the full text of the commit.
<span class="icon"><i class="fa fa-dot-circle"></i></span>
--&gt;
&lt;body&gt;Fixes #&lt;/body&gt;
&lt;/labeler&gt;
&lt;/labelers&gt;
&lt;!--
Groups changes by category.
Defaults are shown.
<span class="icon"><i class="fa fa-dot-circle"></i></span>
--&gt;
&lt;categories&gt;
&lt;category&gt;
&lt;title&gt;🚀 Features&lt;/title&gt;
&lt;labelsAsString&gt;feature,enhancement&lt;/labelsAsString&gt;
&lt;/category&gt;
&lt;category&gt;
&lt;title&gt;🐛 Bug Fixes&lt;/title&gt;
&lt;labelsAsString&gt;bug,fix&lt;/labelsAsString&gt;
&lt;/category&gt;
&lt;/categories&gt;
&lt;!--
Defines rules for replacing the generated content.
Each replacer is applied in order.
<span class="icon"><i class="fa fa-dot-circle"></i></span>
--&gt;
&lt;replacers&gt;
&lt;replacer&gt;
&lt;search&gt;\[chore\]\s&lt;/search&gt;
&lt;/replacer&gt;
&lt;replacer&gt;
&lt;search&gt;/CVE-(\d{4})-(\d+)/g&lt;/search&gt;
&lt;replace&gt;https: cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-$1-$2&lt;/replace&gt;
&lt;/replacer&gt;
&lt;/replacers&gt;
&lt;/changelog&gt;
&lt;!--
@@ -1127,7 +1538,7 @@ release:
Defaults to the branch pointed by HEAD.
<span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-eye-slash"></i></span>
--&gt;
&lt;ref&gt;main&lt;/ref&gt;
&lt;branch&gt;main&lt;/branch&gt;
&lt;!--
The following properties define <span class="icon"><i class="fa fa-dot-circle"></i></span> URL formats.
@@ -1306,6 +1717,97 @@ release:
// Defaults to `false`.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
links = false
// Enables or disables formatting options.
// Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
// Defaults to `NEVER`.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
formatted = 'ALWAYS'
// The template to use for each change.
// Defaults to `- {{commitShortHash}} {{commitTitle}} ({{commitAuthor}})`.
// <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
change = '- {{commitShortHash}} {{commitTitle}}'
// The template to use for the whole changelog.
// Defaults is shown.
// <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
content = '#Changelog\n\n{{changelogChanges}}\n{{changelogContributors}}'
// Path to a template file that defines the contents.
// Review the available <a href="../name-templates.html" class="page">Name Templates</a>.
// Defaults to `src/jreleaser/templates/changelog.tpl`.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
contentTemplate = 'path/to/template/changelog.tpl'
// Hide uncategorized commits.
// Defaults to `false`.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
hideUncategorized = true
// A list of labels to be included.
// Only changes matching this list will be included.
// Defaults to empty.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
includeLabels = [
'issue'
]
// A list of labels to be excluded.
// Changes matching this list will be excluded.
// Defaults to empty.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
excludeLabels = [
'issue'
]
// Defines rules that apply labels to changes.
// Matchers are evaluated independently; the label will
// be set if at least one of the matchers meets the criteria.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
labeler {
// The label to be applied.
// <span class="icon"><i class="fa fa-exclamation-triangle"></i></span>
label = 'issue'
// Matches the text of the first commit line.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
title = '^fix:'
// Matches the full text of the commit.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
body = 'Fixes #'
}
// Groups changes by category.
// Defaults are shown.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
category {
title = '🚀 Features'
labels = [
'feature',
'enhancement'
]
}
category {
title = '🐛 Bug Fixes'
labels = [
'bug',
'fix'
]
}
// Defines rules for replacing the generated content.
// Each replacer is applied in order.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
replacer {
search = '\[chore\]\s'
replace = ''
}
replacer {
search = '/CVE-(\d{4})-(\d+)/g'
replace = 'https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-$1-$2'
}
}
// A milestone associated with the release
@@ -1327,7 +1829,7 @@ release:
// May define a `JRELEASER_BRANCH` environment variable instead.
// Defaults to the branch pointed by HEAD.
// <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-eye-slash"></i></span>
ref = 'main'
branch = 'main'
// The following properties define <span class="icon"><i class="fa fa-dot-circle"></i></span> URL formats.
// Defaults are shown.
@@ -1359,6 +1861,73 @@ release:
</div>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_changelog"><a class="anchor" href="#_changelog"></a>Changelog</h2>
<div class="sectionbody">
<div class="paragraph">
<p>You may define either <code>content</code> or <code>contentTemplate</code>, with the latter taking precedence over the former.</p>
</div>
<div class="paragraph">
<p>Changelog format applies only to the automatically generated changelog, that is, formatting wo&#8217;t occur if the <code>external</code>
property is set. Format applies only to local commits at the moment, the use of labelers is highly encouraged.</p>
</div>
<div class="paragraph">
<p>The <code>change</code> property only accepts the following name templates:</p>
</div>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 28.5714%;">
<col style="width: 71.4286%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Key</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">commitShortHash</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">head commit hash abbreviated to 7 characters</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">commitFullHash</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">head commit hash</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">commitTitle</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">first line of the commit message</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">commitAuthor</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">full name of the commit author</p></td>
</tr>
</tbody>
</table>
<div class="paragraph">
<p>The <code>content</code> and <code>contentTemplate</code> accept all <a href="../name-templates.html" class="page">Name Templates</a>, take special consideration on
<code>{{changelogChanges}}</code> and <code>{{changelogContributors}}</code> as they define the parsed commits.</p>
</div>
<div class="paragraph">
<p>The following configuration</p>
</div>
<div class="imageblock">
<div class="content">
<img src="../../_images/jreleaser-changelog-config.jpg" alt="jreleaser changelog config">
</div>
</div>
<div class="paragraph">
<p>Generates a changelog similar to</p>
</div>
<div class="imageblock">
<div class="content">
<img src="../../_images/jreleaser-changelog-render.jpg" alt="jreleaser changelog render">
</div>
</div>
</div>
</div>
</article>
</div>
</main>

49
guide/latest/configuration/release/index.html
View File

@@ -94,7 +94,7 @@
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../../artifacts.html">Artifacts</a>
<a class="nav-link" href="../../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
@@ -162,6 +162,15 @@
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../packagers/snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
@@ -243,6 +252,12 @@
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
@@ -254,43 +269,53 @@
<a class="nav-link" href="../../tools/index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/cli.html">JReleaser CLI</a>
<a class="nav-link" href="../../tools/jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/maven.html">JReleaser Maven Plugin</a>
<a class="nav-link" href="../../tools/jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/gradle.html">JReleaser Gradle Plugin</a>
<a class="nav-link" href="../../tools/jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/ant.html">JReleaser Ant Tasks</a>
<a class="nav-link" href="../../tools/jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/tool-provider.html">JReleaser Tool Provider</a>
<a class="nav-link" href="../../tools/jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/docker.html">JReleaser Docker Image</a>
<a class="nav-link" href="../../tools/jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Examples</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../../examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">

49
guide/latest/configuration/signing.html
View File

@@ -94,7 +94,7 @@
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../artifacts.html">Artifacts</a>
<a class="nav-link" href="../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
@@ -162,6 +162,15 @@
<li class="nav-item" data-depth="3">
<a class="nav-link" href="packagers/snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
@@ -243,6 +252,12 @@
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
@@ -254,43 +269,53 @@
<a class="nav-link" href="../tools/index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/cli.html">JReleaser CLI</a>
<a class="nav-link" href="../tools/jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/maven.html">JReleaser Maven Plugin</a>
<a class="nav-link" href="../tools/jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/gradle.html">JReleaser Gradle Plugin</a>
<a class="nav-link" href="../tools/jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/ant.html">JReleaser Ant Tasks</a>
<a class="nav-link" href="../tools/jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/tool-provider.html">JReleaser Tool Provider</a>
<a class="nav-link" href="../tools/jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/docker.html">JReleaser Docker Image</a>
<a class="nav-link" href="../tools/jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Examples</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">

942
guide/latest/configuration/upload/artifactory.html Normal file
View File

@@ -0,0 +1,942 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>Artifactory :: JReleaser</title>
<link rel="canonical" href="https://jreleaser.org/guide/latest/configuration/upload/artifactory.html">
<meta name="generator" content="Antora 2.3.4">
<link rel="stylesheet" href="../../../../_/css/site.css">
<link rel="stylesheet" href="../../../../_/css/admonitions.css">
<link rel="stylesheet" href="../../../../_/css/fontawesome.css">
<link rel="stylesheet" href="../../../../_/css/all.css">
<script>var uiRootPath = '../../../../_'</script>
</head>
<body class="article">
<header class="header">
<nav class="navbar">
<div class="navbar-brand">
<a class="navbar-item" href="https://jreleaser.org">JReleaser</a>
<button class="navbar-burger" data-target="topbar-nav">
<span></span>
<span></span>
<span></span>
</button>
</div>
</nav>
</header>
<div class="body">
<div class="nav-container" data-component="guide" data-version="latest">
<aside class="nav">
<div class="panels">
<div class="nav-panel-menu is-active" data-panel="menu">
<nav class="nav-menu">
<h3 class="title"><a href="../../index.html">JReleaser</a></h3>
<ul class="nav-list">
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../../install.html">Install</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../../quick-start/index.html">Quick Start</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../quick-start/cli.html">Command Line</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../quick-start/maven.html">Apache Maven</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../quick-start/gradle.html">Gradle</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../quick-start/ant.html">Apache Ant</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../../workflow.html">Workflow</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../../distributions/index.html">Distributions</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../distributions/java-binary.html">Java Binary</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../distributions/single-jar.html">Single JAR</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../distributions/jlink.html">Jlink</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../distributions/native-image.html">Native Image</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../index.html">Configuration</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../environment.html">Environment</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../project.html">Project</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../signing.html">Signing</a>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../release/index.html">Release</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../release/github.html">GitHub</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../release/gitlab.html">GitLab</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../release/gitea.html">Gitea</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../assemble/index.html">Assemble</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../assemble/jlink.html">Jlink</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../assemble/native-image.html">Native Image</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../packagers/index.html">Packagers</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../packagers/chocolatey.html">Chocolatey</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../packagers/docker.html">Docker</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../packagers/homebrew.html">Homebrew</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../packagers/jbang.html">Jbang</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../packagers/scoop.html">Scoop</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../packagers/snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item is-current-page" data-depth="3">
<a class="nav-link" href="artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../distributions.html">Distributions</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../files.html">Files</a>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../announce/index.html">Announce</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../announce/discord.html">Discord</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../announce/discussions.html">GitHub Discussions</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../announce/gitter.html">Gitter</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../announce/mail.html">Mail</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../announce/sdkman.html">Sdkman</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../announce/slack.html">Slack</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../announce/teams.html">Teams</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../announce/twitter.html">Twitter</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../announce/zulip.html">Zulip</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../name-templates.html">Name Templates</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Templates</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../../templates/templates.html">Template Basics</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../../templates/mustache.html">Mustache Primer</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../../continuous-integration/index.html">Continuous Integration</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/github-actions.html">GitHub Actions</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/jenkins.html">Jenkins</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/circle-ci.html">Circle CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/codefresh.html">Codefresh</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../../tools/index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../../examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../../links.html">Links</a>
</li>
</ul>
</li>
</ul>
</nav>
</div>
<div class="nav-panel-explore" data-panel="explore">
<div class="context">
<span class="title">JReleaser</span>
<span class="version">latest</span>
</div>
<ul class="components">
<li class="component is-current">
<a class="title" href="../../index.html">JReleaser</a>
<ul class="versions">
<li class="version is-current is-latest">
<a href="../../index.html">latest</a>
</li>
</ul>
</li>
</ul>
</div>
</div>
</aside>
</div>
<main class="article">
<div class="toolbar" role="navigation">
<button class="nav-toggle"></button>
<a href="../../index.html" class="home-link"></a>
<nav class="breadcrumbs" aria-label="breadcrumbs">
<ul>
<li><a href="../../index.html">JReleaser</a></li>
<li><a href="../index.html">Configuration</a></li>
<li><a href="index.html">Upload</a></li>
<li><a href="artifactory.html">Artifactory</a></li>
</ul>
</nav>
<div class="edit-this-page"><a href="https://github.com/jreleaser/jreleaser.github.io/edit/main/docs/modules/configuration/pages/upload/artifactory.adoc">Edit this Page</a></div>
</div>
<div class="content">
<aside class="toc sidebar" data-title="Contents" data-levels="2">
<div class="toc-menu"></div>
</aside>
<article class="doc">
<h1 class="page">Artifactory</h1>
<div id="preamble">
<div class="sectionbody">
<div class="paragraph">
<p>Uploads artifacts, files, and signatures to an Artifactory instance.</p>
</div>
<div class="ulist">
<div class="title">Prerequisites:</div>
<ul>
<li>
<p>A running Artifactory instance.</p>
</li>
<li>
<p>A generic repository.</p>
</li>
<li>
<p>A user + password / token with grants to upload an artifact.</p>
</li>
</ul>
</div>
<div class="admonitionblock important">
<table>
<tr>
<td class="icon">
<i class="fa icon-important" title="Important"></i>
</td>
<td class="content">
This feature <strong>does not</strong> support deploying JARs and POMs to a Maven repository.
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>Legend:</p>
</div>
<div class="ulist">
<ul>
<li>
<p><span class="icon"><i class="fa fa-exclamation-triangle"></i></span> required</p>
</li>
<li>
<p><span class="icon"><i class="fa fa-dot-circle"></i></span> optional</p>
</li>
<li>
<p><span class="icon"><i class="fa fa-eye-slash"></i></span> may use environment variable</p>
</li>
<li>
<p><span class="icon"><i class="fa fa-file-alt"></i></span> accepts <a href="../name-templates.html" class="page">Name Templates</a></p>
</li>
</ul>
</div>
<div class="tabset is-loading">
<div class="ulist tabs">
<ul>
<li>
<p><a id="tabset1_yaml"></a>YAML</p>
</li>
<li>
<p><a id="tabset1_toml"></a>TOML</p>
</li>
<li>
<p><a id="tabset1_json"></a>JSON</p>
</li>
<li>
<p><a id="tabset1_maven"></a>Maven</p>
</li>
<li>
<p><a id="tabset1_gradle"></a>Gradle</p>
</li>
</ul>
</div>
<div class="content">
<div class="tab-pane" aria-labelledby="tabset1_yaml">
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-yaml hljs" data-lang="yaml"># <span class="icon"><i class="fa fa-dot-circle"></i></span>
upload:
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
artifactories:
# Uploaders require a name.
# <span class="icon"><i class="fa fa-exclamation-triangle"></i></span>
app:
# Enables or disables the uploader.
# Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
# Defaults to `NEVER`.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
active: ALWAYS
# Defines the connection timeout in seconds.
# Defaults to `20`.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
connectTimeout: 20
# Defines the read timeout in seconds.
# Defaults to `60`.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
readTimeout: 60
# URL of the Artifacttory instance + path.
# The artifact file name will be appended automatically.
# <span class="icon"><i class="fa fa-exclamation-triangle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
target: https://duke.jfrog.io/artifactory/binaries/{{projectName}}/{{projectVersion}}
# The username that can write to the repository.
# If left unspecified, the `JRELEASER_ARTIFACTORY_${name}_USERNAME`
# environment variable must be defined.
# <span class="icon"><i class="fa fa-exclamation-triangle"></i></span> <span class="icon"><i class="fa fa-eye-slash"></i></span>
username: __DO_NOT_SET_HERE__
# Password for login into the repository.
# If left unspecified, the `JRELEASER_ARTIFACTORY_${name}_PASSWORD`
# environment variable must be defined.
# <span class="icon"><i class="fa fa-exclamation-triangle"></i></span> <span class="icon"><i class="fa fa-eye-slash"></i></span>
password: __DO_NOT_SET_HERE__
# Token for login into the repository.
# If left unspecified, the `JRELEASER_ARTIFACTORY_${name}_TOKEN`
# environment variable must be defined.
# <span class="icon"><i class="fa fa-exclamation-triangle"></i></span> <span class="icon"><i class="fa fa-eye-slash"></i></span>
token: __DO_NOT_SET_HERE__
# Upload files.
# Defaults to `true`.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
files: true
# Upload distribution artifacts.
# Defaults to `true`.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
artifacts: true
# Upload signatures.
# Defaults to `true`.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
signatures: true
# Additional properties used when evaluating templates.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
extraProperties:
# Key will be capitalized and prefixed with `artifactory`, i.e, `artifactoryFoo`.
foo: bar</code></pre>
</div>
</div>
</div>
<div class="tab-pane" aria-labelledby="tabset1_toml">
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-toml hljs" data-lang="toml"># Uploaders require a name.
# <span class="icon"><i class="fa fa-exclamation-triangle"></i></span>
[upload.artifactories.app]
# Enables or disables the uploader.
# Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
# Defaults to `NEVER`.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
active = "ALWAYS"
# Defines the connection timeout in seconds.
# Defaults to `20`.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
connectTimeout = 20
# Defines the read timeout in seconds.
# Defaults to `60`.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
readTimeout = 60
# URL of the Artifacttory instance + path.
# The artifact file name will be appended automatically.
# <span class="icon"><i class="fa fa-exclamation-triangle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
target = "https://duke.jfrog.io/artifactory/binaries/{{projectName}}/{{projectVersion}}"
# The username that can write to the repository.
# If left unspecified, the `JRELEASER_ARTIFACTORY_${name}_USERNAME`
# environment variable must be defined.
# <span class="icon"><i class="fa fa-exclamation-triangle"></i></span> <span class="icon"><i class="fa fa-eye-slash"></i></span>
username = "__DO_NOT_SET_HERE__"
# Password for login into the repository..
# If left unspecified, the `JRELEASER_ARTIFACTORY_${name}_PASSWORD`
# environment variable must be defined.
# <span class="icon"><i class="fa fa-exclamation-triangle"></i></span> <span class="icon"><i class="fa fa-eye-slash"></i></span>
password = "__DO_NOT_SET_HERE__"
# Token for login into the repository.
# If left unspecified, the `JRELEASER_ARTIFACTORY_${name}_TOKEN`
# environment variable must be defined.
# <span class="icon"><i class="fa fa-exclamation-triangle"></i></span> <span class="icon"><i class="fa fa-eye-slash"></i></span>
token = "__DO_NOT_SET_HERE__"
# Upload files.
# Defaults to `true`.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
files = true
# Upload distribution artifacts.
# Defaults to `true`.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
artifacts = true
# Upload signatures.
# Defaults to `true`.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
signatures = true
# Additional properties used when evaluating templates.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
extraProperties.foo = "bar"
# Key will be capitalized and prefixed with `artifactory`, i.e, `artifactoryFoo`.</code></pre>
</div>
</div>
</div>
<div class="tab-pane" aria-labelledby="tabset1_json">
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-json hljs" data-lang="json">{
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
"upload": {
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
"artifactories": {
// Uploaders require a name.
// <span class="icon"><i class="fa fa-exclamation-triangle"></i></span>
"app": {
// Enables or disables the uploader.
// Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
// Defaults to `NEVER`.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
"active": "ALWAYS",
// Defines the connection timeout in seconds.
// Defaults to `20`.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
"connectTimeout": 20,
// Defines the read timeout in seconds.
// Defaults to `60`.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
"readTimeout": 60,
// URL of the Artifacttory instance + path.
// The artifact file name will be appended automatically.
// <span class="icon"><i class="fa fa-exclamation-triangle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
"target": "https://duke.jfrog.io/artifactory/binaries/{{projectName}}/{{projectVersion}}",
// The username that can write to the repository.
// If left unspecified, the `JRELEASER_ARTIFACTORY_${name}_USERNAME`
// environment variable must be defined.
// <span class="icon"><i class="fa fa-exclamation-triangle"></i></span> <span class="icon"><i class="fa fa-eye-slash"></i></span>
"username": "__DO_NOT_SET_HERE__",
// Password for login into the repository.
// If left unspecified, the `JRELEASER_ARTIFACTORY_${name}_PASSWORD`
// environment variable must be defined.
// <span class="icon"><i class="fa fa-exclamation-triangle"></i></span> <span class="icon"><i class="fa fa-eye-slash"></i></span>
"password": "__DO_NOT_SET_HERE__",
// Token for login into the repository.
// If left unspecified, the `JRELEASER_ARTIFACTORY_${name}_TOKEN`
// environment variable must be defined.
// <span class="icon"><i class="fa fa-exclamation-triangle"></i></span> <span class="icon"><i class="fa fa-eye-slash"></i></span>
"token": "__DO_NOT_SET_HERE__",
// Upload files.
// Defaults to `true`.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
"files": true,
// Upload distribution artifacts.
// Defaults to `true`.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
"artifacts": true,
// Upload signatures.
// Defaults to `true`.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
"signatures": true,
// Additional properties used when evaluating templates.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
"extraProperties": {
// Key will be capitalized and prefixed with `artifactory`, i.e, `artifactoryFoo`.
"foo": "bar"
}
}
}
}
}</code></pre>
</div>
</div>
</div>
<div class="tab-pane" aria-labelledby="tabset1_maven">
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml">&lt;jreleaser&gt;
&lt;upload&gt;
&lt;!--
<span class="icon"><i class="fa fa-dot-circle"></i></span>
--&gt;
&lt;artifactories&gt;
&lt;!--
Uploaders require a name.
<span class="icon"><i class="fa fa-exclamation-triangle"></i></span>
--&gt;
&lt;app&gt;
&lt;!--
Enables or disables the distribution.
Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
Defaults to `ALWAYS`.
<span class="icon"><i class="fa fa-dot-circle"></i></span>
--&gt;
&lt;active&gt;ALWAYS&lt;/active&gt;
&lt;!--
Defines the connection timeout in seconds.
Defaults to `20`.
<span class="icon"><i class="fa fa-dot-circle"></i></span>
--&gt;
&lt;connectTimeout&gt;20&lt;/connectTimeout&gt;
&lt;!--
Defines the read timeout in seconds.
Defaults to `60`.
<span class="icon"><i class="fa fa-dot-circle"></i></span>
--&gt;
&lt;readTimeout&gt;60&lt;/readTimeout&gt;
&lt;!--
URL of the Artifacttory instance + path.
The artifact file name will be appended automatically.
<span class="icon"><i class="fa fa-exclamation-triangle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
--&gt;
&lt;target&gt;https:my.zulipchat.com/api/v1&lt;/target&gt;
&lt;!--
The username that can write to the repository.
If left unspecified, the `JRELEASER_ARTIFACTORY_${name}_USERNAME`
environment variable must be defined.
<span class="icon"><i class="fa fa-exclamation-triangle"></i></span> <span class="icon"><i class="fa fa-eye-slash"></i></span>
--&gt;
&lt;username&gt;__DO_NOT_SET_HERE__&lt;/username&gt;
&lt;!--
Password for login into the repository.
If left unspecified, the `JRELEASER_ARTIFACTORY_${name}_PASSWORD`
environment variable must be defined.
<span class="icon"><i class="fa fa-exclamation-triangle"></i></span> <span class="icon"><i class="fa fa-eye-slash"></i></span>
--&gt;
&lt;password&gt;__DO_NOT_SET_HERE__&lt;/password&gt;
&lt;!--
Token for login into the repository.
If left unspecified, the `JRELEASER_ARTIFACTORY_${name}_TOKEN`
environment variable must be defined.
<span class="icon"><i class="fa fa-exclamation-triangle"></i></span> <span class="icon"><i class="fa fa-eye-slash"></i></span>
--&gt;
&lt;token&gt;__DO_NOT_SET_HERE__&lt;/token&gt;
&lt;!--
Upload files.
Defaults to `true`.
<span class="icon"><i class="fa fa-dot-circle"></i></span>
--&gt;
&lt;files&gt;true&lt;/files&gt;
&lt;!--
Upload distribution artifacts.
Defaults to `true`.
<span class="icon"><i class="fa fa-dot-circle"></i></span>
--&gt;
&lt;artifacts&gt;true&lt;/artifacts&gt;
&lt;!--
Upload signatures.
Defaults to `true`.
<span class="icon"><i class="fa fa-dot-circle"></i></span>
--&gt;
&lt;signatures&gt;true&lt;/signatures&gt;
&lt;!--
Additional properties used when evaluating templates.
<span class="icon"><i class="fa fa-dot-circle"></i></span>
--&gt;
&lt;extraProperties&gt;
&lt;!--
Key will be capitalized and prefixed with `artifactory`, i.e, `artifactoryFoo`.
--&gt;
&lt;foo&gt;bar&lt;/foo&gt;
&lt;/extraProperties&gt;
&lt;/app&gt;
&lt;/artifactories&gt;
&lt;/upload&gt;
&lt;/jreleaser&gt;</code></pre>
</div>
</div>
</div>
<div class="tab-pane" aria-labelledby="tabset1_gradle">
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-groovy hljs" data-lang="groovy">jreleaser {
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
upload {
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
artifactories {
// Uploaders require a name.
// <span class="icon"><i class="fa fa-exclamation-triangle"></i></span>
app {
// Enables or disables the uploader.
// Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
// Defaults to `NEVER`.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
active = 'ALWAYS'
// Defines the connection timeout in seconds.
// Defaults to `20`.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
connectTimeout = 20
// Defines the read timeout in seconds.
// Defaults to `60`.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
readTimeout = 60
// URL of the Artifacttory instance + path.
// The artifact file name will be appended automatically.
// <span class="icon"><i class="fa fa-exclamation-triangle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
target = 'https://duke.jfrog.io/artifactory/binaries/{{projectName}}/{{projectVersion}}'
// The username that can write to the repository.
// If left unspecified, the `JRELEASER_ARTIFACTORY_${name}_USERNAME`
// environment variable must be defined.
// <span class="icon"><i class="fa fa-exclamation-triangle"></i></span> <span class="icon"><i class="fa fa-eye-slash"></i></span>
username = '__DO_NOT_SET_HERE__'
// Password for login into the repository.
// If left unspecified, the `JRELEASER_ARTIFACTORY_${name}_PASSWORD`
// environment variable must be defined.
// <span class="icon"><i class="fa fa-exclamation-triangle"></i></span> <span class="icon"><i class="fa fa-eye-slash"></i></span>
password = '__DO_NOT_SET_HERE__'
// Token for login into the repository.
// If left unspecified, the `JRELEASER_ARTIFACTORY_${name}_TOKEN`
// environment variable must be defined.
// <span class="icon"><i class="fa fa-exclamation-triangle"></i></span> <span class="icon"><i class="fa fa-eye-slash"></i></span>
token = '__DO_NOT_SET_HERE__'
// Upload files.
// Defaults to `true`.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
files = true
// Upload distribution artifacts.
// Defaults to `true`.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
artifacts = true
// Upload signatures.
// Defaults to `true`.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
signatures = true
// Additional properties used when evaluating templates.
// Key will be capitalized and prefixed with `artifactory`, i.e, `artifactoryFoo`.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
extraProperties.put('foo', 'bar')
}
}
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
Either set <code>username</code>/<code>password</code> or <code>token</code>.
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_target"><a class="anchor" href="#_target"></a>Target</h2>
<div class="sectionbody">
<div class="paragraph">
<p>The target is the URL to upload the artifacts to (without the name of the artifact).</p>
</div>
<div class="paragraph">
<p>An example configuration can look like</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code>target: 'http://artifacts.company.com:8081/artifactory/example-repo-local/{{projectName}}/{{projectVersion}}'</code></pre>
</div>
</div>
<div class="paragraph">
<p>And will result in a final deployment like
<code>http://artifacts.company.com:8081/artifactory/example-repo-local/app/1.0.0/app-1.0.0.zip</code>.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_username"><a class="anchor" href="#_username"></a>Username</h2>
<div class="sectionbody">
<div class="paragraph">
<p>The configured username needs to be authenticated against the Artifactory instance.</p>
</div>
<div class="paragraph">
<p>You can have the username set in the configuration as shown above or you can have it read from an environment variable.
The configured name of the Artifactory instance will be used to build the environment variable name.
This means that the name per configured instance needs to be unique.</p>
</div>
<div class="paragraph">
<p>The name of the environment variable will be <code>JRELEASER_ARTIFACTORY_NAME_USERNAME</code>. If your instance is named <code>production</code>,
you can store the username in the environment variable <code>JRELEASER_ARTIFACTORY_PRODUCTION_USERNAME</code>. The name will be
transformed to uppercase.</p>
</div>
<div class="paragraph">
<p>If a configured username is found in the configuration file, then the environment variable is not used at all.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_password"><a class="anchor" href="#_password"></a>Password</h2>
<div class="sectionbody">
<div class="paragraph">
<p>The password will be stored in a environment variable. The configured name of the Artifactory instance will
be used. This means that the name per configured instance needs to be unique.</p>
</div>
<div class="paragraph">
<p>The name of the environment variable will be <code>JRELEASER_ARTIFACTORY_NAME_PASSWORD</code>. If your instance is named <code>production</code>,
you need to store the secret in the environment variable <code>JRELEASER_ARTIFACTORY_PRODUCTION_PASSWORD</code>. The name will be
transformed to uppercase.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_token"><a class="anchor" href="#_token"></a>Token</h2>
<div class="sectionbody">
<div class="paragraph">
<p>The token will be stored in a environment variable. The configured name of the Artifactory instance will
be used. This means that the name per configured instance needs to be unique.</p>
</div>
<div class="paragraph">
<p>The name of the environment variable will be <code>JRELEASER_ARTIFACTORY_NAME_TOKEN</code>. If your instance is named <code>production</code>,
you need to store the secret in the environment variable <code>JRELEASER_ARTIFACTORY_PRODUCTION_TOKEN</code>. The name will be
transformed to uppercase.</p>
</div>
</div>
</div>
</article>
</div>
</main>
</div>
<footer class="footer">
<p>Copyright (C) 2021 Andres Almiray. This page was built using an adapted version of the Antora default UI.</p>
<p>The source code for this UI is licensed under the <a href="https://www.mozilla.org/en-US/MPL/2.0/">Mozilla Public License Version 2.0</a> (MPL-2.0).</p>
</footer>
<!--script src="../../../../_/js/fontawesome.js"></script>
<script src="../../../../_/js/all.js"></script-->
<script src="../../../../_/js/site.js"></script>
<script async src="../../../../_/js/vendor/highlight.js"></script>
</body>
</html>

502
guide/latest/configuration/upload/index.html Normal file
View File

@@ -0,0 +1,502 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>Upload :: JReleaser</title>
<link rel="canonical" href="https://jreleaser.org/guide/latest/configuration/upload/index.html">
<meta name="generator" content="Antora 2.3.4">
<link rel="stylesheet" href="../../../../_/css/site.css">
<link rel="stylesheet" href="../../../../_/css/admonitions.css">
<link rel="stylesheet" href="../../../../_/css/fontawesome.css">
<link rel="stylesheet" href="../../../../_/css/all.css">
<script>var uiRootPath = '../../../../_'</script>
</head>
<body class="article">
<header class="header">
<nav class="navbar">
<div class="navbar-brand">
<a class="navbar-item" href="https://jreleaser.org">JReleaser</a>
<button class="navbar-burger" data-target="topbar-nav">
<span></span>
<span></span>
<span></span>
</button>
</div>
</nav>
</header>
<div class="body">
<div class="nav-container" data-component="guide" data-version="latest">
<aside class="nav">
<div class="panels">
<div class="nav-panel-menu is-active" data-panel="menu">
<nav class="nav-menu">
<h3 class="title"><a href="../../index.html">JReleaser</a></h3>
<ul class="nav-list">
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../../install.html">Install</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../../quick-start/index.html">Quick Start</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../quick-start/cli.html">Command Line</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../quick-start/maven.html">Apache Maven</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../quick-start/gradle.html">Gradle</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../quick-start/ant.html">Apache Ant</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../../workflow.html">Workflow</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../../distributions/index.html">Distributions</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../distributions/java-binary.html">Java Binary</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../distributions/single-jar.html">Single JAR</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../distributions/jlink.html">Jlink</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../distributions/native-image.html">Native Image</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../index.html">Configuration</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../environment.html">Environment</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../project.html">Project</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../signing.html">Signing</a>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../release/index.html">Release</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../release/github.html">GitHub</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../release/gitlab.html">GitLab</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../release/gitea.html">Gitea</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../assemble/index.html">Assemble</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../assemble/jlink.html">Jlink</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../assemble/native-image.html">Native Image</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../packagers/index.html">Packagers</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../packagers/chocolatey.html">Chocolatey</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../packagers/docker.html">Docker</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../packagers/homebrew.html">Homebrew</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../packagers/jbang.html">Jbang</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../packagers/scoop.html">Scoop</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../packagers/snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item is-current-page" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../distributions.html">Distributions</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../files.html">Files</a>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../announce/index.html">Announce</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../announce/discord.html">Discord</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../announce/discussions.html">GitHub Discussions</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../announce/gitter.html">Gitter</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../announce/mail.html">Mail</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../announce/sdkman.html">Sdkman</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../announce/slack.html">Slack</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../announce/teams.html">Teams</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../announce/twitter.html">Twitter</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../announce/zulip.html">Zulip</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../name-templates.html">Name Templates</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Templates</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../../templates/templates.html">Template Basics</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../../templates/mustache.html">Mustache Primer</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../../continuous-integration/index.html">Continuous Integration</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/github-actions.html">GitHub Actions</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/jenkins.html">Jenkins</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/circle-ci.html">Circle CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/codefresh.html">Codefresh</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../continuous-integration/drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../../tools/index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../tools/jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../../examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../../links.html">Links</a>
</li>
</ul>
</li>
</ul>
</nav>
</div>
<div class="nav-panel-explore" data-panel="explore">
<div class="context">
<span class="title">JReleaser</span>
<span class="version">latest</span>
</div>
<ul class="components">
<li class="component is-current">
<a class="title" href="../../index.html">JReleaser</a>
<ul class="versions">
<li class="version is-current is-latest">
<a href="../../index.html">latest</a>
</li>
</ul>
</li>
</ul>
</div>
</div>
</aside>
</div>
<main class="article">
<div class="toolbar" role="navigation">
<button class="nav-toggle"></button>
<a href="../../index.html" class="home-link"></a>
<nav class="breadcrumbs" aria-label="breadcrumbs">
<ul>
<li><a href="../../index.html">JReleaser</a></li>
<li><a href="../index.html">Configuration</a></li>
<li><a href="index.html">Upload</a></li>
</ul>
</nav>
<div class="edit-this-page"><a href="https://github.com/jreleaser/jreleaser.github.io/edit/main/docs/modules/configuration/pages/upload/index.adoc">Edit this Page</a></div>
</div>
<div class="content">
<aside class="toc sidebar" data-title="Contents" data-levels="2">
<div class="toc-menu"></div>
</aside>
<article class="doc">
<h1 class="page">Upload</h1>
<div class="paragraph">
<p>Artifacts and files may be uploaded to configured servers.</p>
</div>
<div class="paragraph">
<p>Legend:</p>
</div>
<div class="ulist">
<ul>
<li>
<p><span class="icon"><i class="fa fa-exclamation-triangle"></i></span> required</p>
</li>
<li>
<p><span class="icon"><i class="fa fa-dot-circle"></i></span> optional</p>
</li>
<li>
<p><span class="icon"><i class="fa fa-eye-slash"></i></span> may use environment variable</p>
</li>
<li>
<p><span class="icon"><i class="fa fa-file-alt"></i></span> accepts <a href="../name-templates.html" class="page">Name Templates</a></p>
</li>
</ul>
</div>
<div class="tabset is-loading">
<div class="ulist tabs">
<ul>
<li>
<p><a id="tabset1_yaml"></a>YAML</p>
</li>
<li>
<p><a id="tabset1_toml"></a>TOML</p>
</li>
<li>
<p><a id="tabset1_json"></a>JSON</p>
</li>
<li>
<p><a id="tabset1_maven"></a>Maven</p>
</li>
<li>
<p><a id="tabset1_gradle"></a>Gradle</p>
</li>
</ul>
</div>
<div class="content">
<div class="tab-pane" aria-labelledby="tabset1_yaml">
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-yaml hljs" data-lang="yaml"># <span class="icon"><i class="fa fa-dot-circle"></i></span>
upload:
# Enable or disable all configured uploaders.
# Defaults to `true`.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
enabled: true</code></pre>
</div>
</div>
</div>
<div class="tab-pane" aria-labelledby="tabset1_toml">
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-toml hljs" data-lang="toml"># <span class="icon"><i class="fa fa-dot-circle"></i></span>
[upload]
# Enable or disable all configured uploaders.
# Defaults to `true`.
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
enable = true</code></pre>
</div>
</div>
</div>
<div class="tab-pane" aria-labelledby="tabset1_json">
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-json hljs" data-lang="json">{
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
"upload": {
// Enable or disable all configured uploaders.
// Defaults to `true`.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
"enabled": true
}
}</code></pre>
</div>
</div>
</div>
<div class="tab-pane" aria-labelledby="tabset1_maven">
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml">&lt;jreleaser&gt;
&lt;!--
<span class="icon"><i class="fa fa-dot-circle"></i></span>
--&gt;
&lt;upload&gt;
&lt;!--
Enable or disable all configured uploaders.
Defaults to `true`.
<span class="icon"><i class="fa fa-dot-circle"></i></span>
--&gt;
&lt;enabled&gt;true&lt;/enabled&gt;
&lt;/upload&gt;
&lt;/jreleaser&gt;</code></pre>
</div>
</div>
</div>
<div class="tab-pane" aria-labelledby="tabset1_gradle">
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-groovy hljs" data-lang="groovy">jreleaser {
// icon;dot-circle[]
upload {
// Enable or disable all configured uploaders.
// Defaults to `true`.
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
enabled = true
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</article>
</div>
</main>
</div>
<footer class="footer">
<p>Copyright (C) 2021 Andres Almiray. This page was built using an adapted version of the Antora default UI.</p>
<p>The source code for this UI is licensed under the <a href="https://www.mozilla.org/en-US/MPL/2.0/">Mozilla Public License Version 2.0</a> (MPL-2.0).</p>
</footer>
<!--script src="../../../../_/js/fontawesome.js"></script>
<script src="../../../../_/js/all.js"></script-->
<script src="../../../../_/js/site.js"></script>
<script async src="../../../../_/js/vendor/highlight.js"></script>
</body>
</html>

63
guide/latest/continuous-integration/circle-ci.html
View File

@@ -94,7 +94,7 @@
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../artifacts.html">Artifacts</a>
<a class="nav-link" href="../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
@@ -162,6 +162,15 @@
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/packagers/snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../configuration/upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
@@ -243,6 +252,12 @@
<li class="nav-item" data-depth="2">
<a class="nav-link" href="gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
@@ -254,43 +269,53 @@
<a class="nav-link" href="../tools/index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/cli.html">JReleaser CLI</a>
<a class="nav-link" href="../tools/jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/maven.html">JReleaser Maven Plugin</a>
<a class="nav-link" href="../tools/jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/gradle.html">JReleaser Gradle Plugin</a>
<a class="nav-link" href="../tools/jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/ant.html">JReleaser Ant Tasks</a>
<a class="nav-link" href="../tools/jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/tool-provider.html">JReleaser Tool Provider</a>
<a class="nav-link" href="../tools/jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/docker.html">JReleaser Docker Image</a>
<a class="nav-link" href="../tools/jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Examples</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
@@ -352,7 +377,7 @@
</td>
<td class="content">
If you&#8217;re already building with either Maven or Gradle then you might use the
<a href="../tools/maven.html" class="page">JReleaser Maven Plugin</a> or the <a href="../tools/gradle.html" class="page">JReleaser Gradle Plugin</a> plugin instead.
<a href="../tools/jreleaser-maven.html" class="page">JReleaser Maven Plugin</a> or the <a href="../tools/jreleaser-gradle.html" class="page">JReleaser Gradle Plugin</a> instead.
</td>
</tr>
</table>
@@ -398,6 +423,18 @@ jobs:
java -jar jreleaser-cli.jar full-release</code></pre>
</div>
</div>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
You may use <code>latest</code> to pull the latest stable release or <code>early-access</code> to pull the latest snapshot.
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>You may split the pipeline into multiple steps if a different version of Java is required for building and testing.</p>
</div>

436
guide/latest/continuous-integration/cirrus-ci.html Normal file
View File

@@ -0,0 +1,436 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>Cirrus CI :: JReleaser</title>
<link rel="canonical" href="https://jreleaser.org/guide/latest/continuous-integration/cirrus-ci.html">
<meta name="generator" content="Antora 2.3.4">
<link rel="stylesheet" href="../../../_/css/site.css">
<link rel="stylesheet" href="../../../_/css/admonitions.css">
<link rel="stylesheet" href="../../../_/css/fontawesome.css">
<link rel="stylesheet" href="../../../_/css/all.css">
<script>var uiRootPath = '../../../_'</script>
</head>
<body class="article">
<header class="header">
<nav class="navbar">
<div class="navbar-brand">
<a class="navbar-item" href="https://jreleaser.org">JReleaser</a>
<button class="navbar-burger" data-target="topbar-nav">
<span></span>
<span></span>
<span></span>
</button>
</div>
</nav>
</header>
<div class="body">
<div class="nav-container" data-component="guide" data-version="latest">
<aside class="nav">
<div class="panels">
<div class="nav-panel-menu is-active" data-panel="menu">
<nav class="nav-menu">
<h3 class="title"><a href="../index.html">JReleaser</a></h3>
<ul class="nav-list">
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../install.html">Install</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../quick-start/index.html">Quick Start</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../quick-start/cli.html">Command Line</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../quick-start/maven.html">Apache Maven</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../quick-start/gradle.html">Gradle</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../quick-start/ant.html">Apache Ant</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../workflow.html">Workflow</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../distributions/index.html">Distributions</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../distributions/java-binary.html">Java Binary</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../distributions/single-jar.html">Single JAR</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../distributions/jlink.html">Jlink</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../distributions/native-image.html">Native Image</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../configuration/index.html">Configuration</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../configuration/environment.html">Environment</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../configuration/project.html">Project</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../configuration/signing.html">Signing</a>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../configuration/release/index.html">Release</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/release/github.html">GitHub</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/release/gitlab.html">GitLab</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/release/gitea.html">Gitea</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../configuration/assemble/index.html">Assemble</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/assemble/jlink.html">Jlink</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/assemble/native-image.html">Native Image</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../configuration/packagers/index.html">Packagers</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/packagers/chocolatey.html">Chocolatey</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/packagers/docker.html">Docker</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/packagers/homebrew.html">Homebrew</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/packagers/jbang.html">Jbang</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/packagers/scoop.html">Scoop</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/packagers/snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../configuration/upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../configuration/distributions.html">Distributions</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../configuration/files.html">Files</a>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../configuration/announce/index.html">Announce</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/announce/discord.html">Discord</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/announce/discussions.html">GitHub Discussions</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/announce/gitter.html">Gitter</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/announce/mail.html">Mail</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/announce/sdkman.html">Sdkman</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/announce/slack.html">Slack</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/announce/teams.html">Teams</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/announce/twitter.html">Twitter</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/announce/zulip.html">Zulip</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../configuration/name-templates.html">Name Templates</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Templates</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../templates/templates.html">Template Basics</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../templates/mustache.html">Mustache Primer</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="index.html">Continuous Integration</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="github-actions.html">GitHub Actions</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="jenkins.html">Jenkins</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="circle-ci.html">Circle CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="codefresh.html">Codefresh</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item is-current-page" data-depth="2">
<a class="nav-link" href="cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../tools/index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../links.html">Links</a>
</li>
</ul>
</li>
</ul>
</nav>
</div>
<div class="nav-panel-explore" data-panel="explore">
<div class="context">
<span class="title">JReleaser</span>
<span class="version">latest</span>
</div>
<ul class="components">
<li class="component is-current">
<a class="title" href="../index.html">JReleaser</a>
<ul class="versions">
<li class="version is-current is-latest">
<a href="../index.html">latest</a>
</li>
</ul>
</li>
</ul>
</div>
</div>
</aside>
</div>
<main class="article">
<div class="toolbar" role="navigation">
<button class="nav-toggle"></button>
<a href="../index.html" class="home-link"></a>
<nav class="breadcrumbs" aria-label="breadcrumbs">
<ul>
<li><a href="../index.html">JReleaser</a></li>
<li><a href="index.html">Continuous Integration</a></li>
<li><a href="cirrus-ci.html">Cirrus CI</a></li>
</ul>
</nav>
<div class="edit-this-page"><a href="https://github.com/jreleaser/jreleaser.github.io/edit/main/docs/modules/continuous-integration/pages/cirrus-ci.adoc">Edit this Page</a></div>
</div>
<div class="content">
<aside class="toc sidebar" data-title="Contents" data-levels="2">
<div class="toc-menu"></div>
</aside>
<article class="doc">
<h1 class="page">Cirrus CI</h1>
<div class="paragraph">
<p>You can setup JReleaser to run in <a href="https://cirrus-ci.org/">Cirrus CI</a>.</p>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
If you&#8217;re already building with either Maven or Gradle then you might use the
<a href="../tools/jreleaser-maven.html" class="page">JReleaser Maven Plugin</a> or the <a href="../tools/jreleaser-gradle.html" class="page">JReleaser Gradle Plugin</a> instead.
</td>
</tr>
</table>
</div>
<div class="listingblock">
<div class="title">.cirrus.yml</div>
<div class="content">
<pre class="highlightjs highlight"><code class="language-yaml hljs" data-lang="yaml">task:
name: Release
env:
JRELEASER_GITHUB_TOKEN: ENCRYPTED[ABC123]
container:
image: jreleaser/jreleaser-slim:latest
release_script: jreleaser full-release</code></pre>
</div>
</div>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
You may use <code>latest</code> to pull the latest stable release or <code>early-access</code> to pull the latest snapshot.
</td>
</tr>
</table>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
You&#8217;ll need to create <a href="https://cirrus-ci.org/guide/writing-tasks/#encrypted-variables">encrypted variables</a> to
store <code>JRELEASER_GITHUB_TOKEN</code> and any other secrets for JReleaser to access the GitHub API and other sensitive data.
</td>
</tr>
</table>
</div>
</article>
</div>
</main>
</div>
<footer class="footer">
<p>Copyright (C) 2021 Andres Almiray. This page was built using an adapted version of the Antora default UI.</p>
<p>The source code for this UI is licensed under the <a href="https://www.mozilla.org/en-US/MPL/2.0/">Mozilla Public License Version 2.0</a> (MPL-2.0).</p>
</footer>
<!--script src="../../../_/js/fontawesome.js"></script>
<script src="../../../_/js/all.js"></script-->
<script src="../../../_/js/site.js"></script>
<script async src="../../../_/js/vendor/highlight.js"></script>
</body>
</html>

63
guide/latest/continuous-integration/codefresh.html
View File

@@ -94,7 +94,7 @@
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../artifacts.html">Artifacts</a>
<a class="nav-link" href="../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
@@ -162,6 +162,15 @@
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/packagers/snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../configuration/upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
@@ -243,6 +252,12 @@
<li class="nav-item" data-depth="2">
<a class="nav-link" href="gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
@@ -254,43 +269,53 @@
<a class="nav-link" href="../tools/index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/cli.html">JReleaser CLI</a>
<a class="nav-link" href="../tools/jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/maven.html">JReleaser Maven Plugin</a>
<a class="nav-link" href="../tools/jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/gradle.html">JReleaser Gradle Plugin</a>
<a class="nav-link" href="../tools/jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/ant.html">JReleaser Ant Tasks</a>
<a class="nav-link" href="../tools/jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/tool-provider.html">JReleaser Tool Provider</a>
<a class="nav-link" href="../tools/jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/docker.html">JReleaser Docker Image</a>
<a class="nav-link" href="../tools/jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Examples</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
@@ -352,7 +377,7 @@
</td>
<td class="content">
If you&#8217;re already building with either Maven or Gradle then you might use the
<a href="../tools/maven.html" class="page">JReleaser Maven Plugin</a> or the <a href="../tools/gradle.html" class="page">JReleaser Gradle Plugin</a> plugin instead.
<a href="../tools/jreleaser-maven.html" class="page">JReleaser Maven Plugin</a> or the <a href="../tools/jreleaser-gradle.html" class="page">JReleaser Gradle Plugin</a> instead.
</td>
</tr>
</table>
@@ -408,6 +433,18 @@ steps:
- 'java -jar jreleaser-cli.jar full-release'</code></pre>
</div>
</div>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
You may use <code>latest</code> to pull the latest stable release or <code>early-access</code> to pull the latest snapshot.
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>You need to pass the <code>JRELEASER_*</code> variables in the Codefresh UI or load them from a
<a href="https://codefresh.io/docs/docs/configure-ci-cd-pipeline/shared-configuration/">shared configuration</a>.</p>

450
guide/latest/continuous-integration/drone.html Normal file
View File

@@ -0,0 +1,450 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>Drone :: JReleaser</title>
<link rel="canonical" href="https://jreleaser.org/guide/latest/continuous-integration/drone.html">
<meta name="generator" content="Antora 2.3.4">
<link rel="stylesheet" href="../../../_/css/site.css">
<link rel="stylesheet" href="../../../_/css/admonitions.css">
<link rel="stylesheet" href="../../../_/css/fontawesome.css">
<link rel="stylesheet" href="../../../_/css/all.css">
<script>var uiRootPath = '../../../_'</script>
</head>
<body class="article">
<header class="header">
<nav class="navbar">
<div class="navbar-brand">
<a class="navbar-item" href="https://jreleaser.org">JReleaser</a>
<button class="navbar-burger" data-target="topbar-nav">
<span></span>
<span></span>
<span></span>
</button>
</div>
</nav>
</header>
<div class="body">
<div class="nav-container" data-component="guide" data-version="latest">
<aside class="nav">
<div class="panels">
<div class="nav-panel-menu is-active" data-panel="menu">
<nav class="nav-menu">
<h3 class="title"><a href="../index.html">JReleaser</a></h3>
<ul class="nav-list">
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../install.html">Install</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../quick-start/index.html">Quick Start</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../quick-start/cli.html">Command Line</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../quick-start/maven.html">Apache Maven</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../quick-start/gradle.html">Gradle</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../quick-start/ant.html">Apache Ant</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../workflow.html">Workflow</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../distributions/index.html">Distributions</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../distributions/java-binary.html">Java Binary</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../distributions/single-jar.html">Single JAR</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../distributions/jlink.html">Jlink</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../distributions/native-image.html">Native Image</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../configuration/index.html">Configuration</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../configuration/environment.html">Environment</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../configuration/project.html">Project</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../configuration/signing.html">Signing</a>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../configuration/release/index.html">Release</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/release/github.html">GitHub</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/release/gitlab.html">GitLab</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/release/gitea.html">Gitea</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../configuration/assemble/index.html">Assemble</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/assemble/jlink.html">Jlink</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/assemble/native-image.html">Native Image</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../configuration/packagers/index.html">Packagers</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/packagers/chocolatey.html">Chocolatey</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/packagers/docker.html">Docker</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/packagers/homebrew.html">Homebrew</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/packagers/jbang.html">Jbang</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/packagers/scoop.html">Scoop</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/packagers/snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../configuration/upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../configuration/distributions.html">Distributions</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../configuration/files.html">Files</a>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../configuration/announce/index.html">Announce</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/announce/discord.html">Discord</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/announce/discussions.html">GitHub Discussions</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/announce/gitter.html">Gitter</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/announce/mail.html">Mail</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/announce/sdkman.html">Sdkman</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/announce/slack.html">Slack</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/announce/teams.html">Teams</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/announce/twitter.html">Twitter</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/announce/zulip.html">Zulip</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../configuration/name-templates.html">Name Templates</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Templates</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../templates/templates.html">Template Basics</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../templates/mustache.html">Mustache Primer</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="index.html">Continuous Integration</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="github-actions.html">GitHub Actions</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="jenkins.html">Jenkins</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="circle-ci.html">Circle CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="codefresh.html">Codefresh</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item is-current-page" data-depth="2">
<a class="nav-link" href="drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../tools/index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../links.html">Links</a>
</li>
</ul>
</li>
</ul>
</nav>
</div>
<div class="nav-panel-explore" data-panel="explore">
<div class="context">
<span class="title">JReleaser</span>
<span class="version">latest</span>
</div>
<ul class="components">
<li class="component is-current">
<a class="title" href="../index.html">JReleaser</a>
<ul class="versions">
<li class="version is-current is-latest">
<a href="../index.html">latest</a>
</li>
</ul>
</li>
</ul>
</div>
</div>
</aside>
</div>
<main class="article">
<div class="toolbar" role="navigation">
<button class="nav-toggle"></button>
<a href="../index.html" class="home-link"></a>
<nav class="breadcrumbs" aria-label="breadcrumbs">
<ul>
<li><a href="../index.html">JReleaser</a></li>
<li><a href="index.html">Continuous Integration</a></li>
<li><a href="drone.html">Drone</a></li>
</ul>
</nav>
<div class="edit-this-page"><a href="https://github.com/jreleaser/jreleaser.github.io/edit/main/docs/modules/continuous-integration/pages/drone.adoc">Edit this Page</a></div>
</div>
<div class="content">
<aside class="toc sidebar" data-title="Contents" data-levels="2">
<div class="toc-menu"></div>
</aside>
<article class="doc">
<h1 class="page">Drone</h1>
<div class="paragraph">
<p>You can setup JReleaser to run with <a href="https://www.drone.io/">Drone</a>.</p>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
If you&#8217;re already building with either Maven or Gradle then you might use the
<a href="../tools/jreleaser-maven.html" class="page">JReleaser Maven Plugin</a> or the <a href="../tools/jreleaser-gradle.html" class="page">JReleaser Gradle Plugin</a> instead.
</td>
</tr>
</table>
</div>
<div class="listingblock">
<div class="title">.drone.yml</div>
<div class="content">
<pre class="highlightjs highlight"><code class="language-yaml hljs" data-lang="yaml">kind: pipeline
name: default
steps:
- name: fetch
image: docker:git
commands:
- git fetch --tags
- name: test
image: maven:3-jdk-10
commands:
- mvn -B verify
- name: release
image: jreleaser/jreleaser-slim:latest
environment:
JRELEASER_GITHUB_TOKEN:
from_secret: github_token
commands:
- jreleaser full-release</code></pre>
</div>
</div>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
You may use <code>latest</code> to pull the latest stable release or <code>early-access</code> to pull the latest snapshot.
</td>
</tr>
</table>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
You&#8217;ll need to create <a href="https://docs.drone.io/secret/">secrets</a> to store <code>JRELEASER_GITHUB_TOKEN</code> and any other
secrets for JReleaser to access the GitHub API and other sensitive data.
</td>
</tr>
</table>
</div>
</article>
</div>
</main>
</div>
<footer class="footer">
<p>Copyright (C) 2021 Andres Almiray. This page was built using an adapted version of the Antora default UI.</p>
<p>The source code for this UI is licensed under the <a href="https://www.mozilla.org/en-US/MPL/2.0/">Mozilla Public License Version 2.0</a> (MPL-2.0).</p>
</footer>
<!--script src="../../../_/js/fontawesome.js"></script>
<script src="../../../_/js/all.js"></script-->
<script src="../../../_/js/site.js"></script>
<script async src="../../../_/js/vendor/highlight.js"></script>
</body>
</html>

67
guide/latest/continuous-integration/github-actions.html
View File

@@ -94,7 +94,7 @@
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../artifacts.html">Artifacts</a>
<a class="nav-link" href="../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
@@ -162,6 +162,15 @@
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/packagers/snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../configuration/upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
@@ -243,6 +252,12 @@
<li class="nav-item" data-depth="2">
<a class="nav-link" href="gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
@@ -254,43 +269,53 @@
<a class="nav-link" href="../tools/index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/cli.html">JReleaser CLI</a>
<a class="nav-link" href="../tools/jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/maven.html">JReleaser Maven Plugin</a>
<a class="nav-link" href="../tools/jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/gradle.html">JReleaser Gradle Plugin</a>
<a class="nav-link" href="../tools/jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/ant.html">JReleaser Ant Tasks</a>
<a class="nav-link" href="../tools/jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/tool-provider.html">JReleaser Tool Provider</a>
<a class="nav-link" href="../tools/jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/docker.html">JReleaser Docker Image</a>
<a class="nav-link" href="../tools/jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Examples</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
@@ -363,7 +388,7 @@
</td>
<td class="content">
If you&#8217;re already building with either Maven or Gradle then you might use the
<a href="../tools/maven.html" class="page">JReleaser Maven Plugin</a> or the <a href="../tools/gradle.html" class="page">JReleaser Gradle Plugin</a> plugin instead.
<a href="../tools/jreleaser-maven.html" class="page">JReleaser Maven Plugin</a> or the <a href="../tools/jreleaser-gradle.html" class="page">JReleaser Gradle Plugin</a> instead.
</td>
</tr>
</table>
@@ -520,8 +545,20 @@ Defaults to the directory the calling workflow runs in.</p></td>
</tr>
</tbody>
</table>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
You may use <code>latest</code> to pull the latest stable release or <code>early-access</code> to pull the latest snapshot.
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>Arguments may be any of those supported by the <a href="../tools/cli.html" class="page">CLI</a> tool.</p>
<p>Arguments may be any of those supported by the <a href="../tools/jreleaser-cli.html" class="page">CLI</a> tool.</p>
</div>
</div>
</div>
@@ -557,7 +594,7 @@ as provided by <code>secrets</code></p></td>
<div class="sectionbody">
<div class="paragraph">
<p>The default <code>GITHUB_TOKEN</code> from <code>secrets</code> is <a href="https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token#about-the-github_token-secret">limited</a>
to the repository that contains your worklow.</p>
to the repository that contains your workflow.</p>
</div>
<div class="paragraph">
<p>Pushing to other repositories such as Homebrew tap requires additional permissions, you must create a custom

100
guide/latest/continuous-integration/gitlab-ci.html
View File

@@ -94,7 +94,7 @@
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../artifacts.html">Artifacts</a>
<a class="nav-link" href="../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
@@ -162,6 +162,15 @@
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/packagers/snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../configuration/upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
@@ -243,6 +252,12 @@
<li class="nav-item is-current-page" data-depth="2">
<a class="nav-link" href="gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
@@ -254,43 +269,53 @@
<a class="nav-link" href="../tools/index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/cli.html">JReleaser CLI</a>
<a class="nav-link" href="../tools/jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/maven.html">JReleaser Maven Plugin</a>
<a class="nav-link" href="../tools/jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/gradle.html">JReleaser Gradle Plugin</a>
<a class="nav-link" href="../tools/jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/ant.html">JReleaser Ant Tasks</a>
<a class="nav-link" href="../tools/jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/tool-provider.html">JReleaser Tool Provider</a>
<a class="nav-link" href="../tools/jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/docker.html">JReleaser Docker Image</a>
<a class="nav-link" href="../tools/jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Examples</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
@@ -352,7 +377,7 @@
</td>
<td class="content">
If you&#8217;re already building with either Maven or Gradle then you might use the
<a href="../tools/maven.html" class="page">JReleaser Maven Plugin</a> or the <a href="../tools/gradle.html" class="page">JReleaser Gradle Plugin</a> plugin instead.
<a href="../tools/jreleaser-maven.html" class="page">JReleaser Maven Plugin</a> or the <a href="../tools/jreleaser-gradle.html" class="page">JReleaser Gradle Plugin</a> instead.
</td>
</tr>
</table>
@@ -376,44 +401,15 @@ build:
paths:
- target/distributions/app/*.zip
# Get the JReleaser bootstrapper
get-jreleaser:
# Bind to `build` stage to make it run in parallel
stage: build
script:
- curl -sL <a href="https://git.io/get-jreleaser" class="bare">https://git.io/get-jreleaser</a> &gt; get_jreleaser.java
# Save the downloaded file
artifacts:
paths:
- '*.java'
# Download JReleaser
download-jreleaser:
# The JReleaser bootstrapper requires JDK 11+
image: azul/zulu-openjdk:11
# Bind to `test` stage
stage: test
# Invoke the bootstrapper and check it works
script:
# Download JReleaser with version = &lt;version&gt;
# Change &lt;version&gt; to a tagged JReleaser release
# or leave it out to pull `latest`.
- java get_jreleaser.java &lt;version&gt;
# Let's check we've got the right version
- java -jar jreleaser-cli.jar --version
# Save the downloaded JAR
artifacts:
paths:
- jreleaser-cli.jar
# Create a release
release:
# JReleaser requires JDK 11+
image: azul/zulu-openjdk:11
# Use the predefined JReleaser Docker image
image: jreleaser/jreleaser-slim:&lt;version&gt;
# Bind to `deploy` stage
stage: deploy
# Set environment variables accordingly
variables:
JRELEASER_PROJECT_VERSION: 1.0.0
JRELEASER_GPG_PASSPHRASE: $GPG_PASSPHRASE
JRELEASER_GPG_PUBLIC_KEY: $GPG_PUBLIC_KEY
JRELEASER_GPG_SECRET_KEY: $GPG_SECRET_KEY
@@ -423,9 +419,21 @@ release:
GIT_DEPTH: 0
# <span class="icon"><i class="fa fa-rocket"></i></span> Execute JReleaser
script:
- java -jar jreleaser-cli.jar full-release</code></pre>
- jreleaser full-release</code></pre>
</div>
</div>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
You may use <code>latest</code> to pull the latest stable release or <code>early-access</code> to pull the latest snapshot.
</td>
</tr>
</table>
</div>
</article>
</div>
</main>

55
guide/latest/continuous-integration/index.html
View File

@@ -94,7 +94,7 @@
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../artifacts.html">Artifacts</a>
<a class="nav-link" href="../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
@@ -162,6 +162,15 @@
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/packagers/snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../configuration/upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
@@ -243,6 +252,12 @@
<li class="nav-item" data-depth="2">
<a class="nav-link" href="gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
@@ -254,43 +269,53 @@
<a class="nav-link" href="../tools/index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/cli.html">JReleaser CLI</a>
<a class="nav-link" href="../tools/jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/maven.html">JReleaser Maven Plugin</a>
<a class="nav-link" href="../tools/jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/gradle.html">JReleaser Gradle Plugin</a>
<a class="nav-link" href="../tools/jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/ant.html">JReleaser Ant Tasks</a>
<a class="nav-link" href="../tools/jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/tool-provider.html">JReleaser Tool Provider</a>
<a class="nav-link" href="../tools/jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/docker.html">JReleaser Docker Image</a>
<a class="nav-link" href="../tools/jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Examples</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
@@ -361,6 +386,12 @@ in the future:</p>
<li>
<p><a href="gitlab-ci.html" class="page">GitLab CI</a></p>
</li>
<li>
<p><a href="cirrus-ci.html" class="page">Cirrus CI</a></p>
</li>
<li>
<p><a href="drone.html" class="page">Drone</a></p>
</li>
</ul>
</div>
</article>

63
guide/latest/continuous-integration/jenkins.html
View File

@@ -94,7 +94,7 @@
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../artifacts.html">Artifacts</a>
<a class="nav-link" href="../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
@@ -162,6 +162,15 @@
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/packagers/snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../configuration/upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
@@ -243,6 +252,12 @@
<li class="nav-item" data-depth="2">
<a class="nav-link" href="gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
@@ -254,43 +269,53 @@
<a class="nav-link" href="../tools/index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/cli.html">JReleaser CLI</a>
<a class="nav-link" href="../tools/jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/maven.html">JReleaser Maven Plugin</a>
<a class="nav-link" href="../tools/jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/gradle.html">JReleaser Gradle Plugin</a>
<a class="nav-link" href="../tools/jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/ant.html">JReleaser Ant Tasks</a>
<a class="nav-link" href="../tools/jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/tool-provider.html">JReleaser Tool Provider</a>
<a class="nav-link" href="../tools/jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/docker.html">JReleaser Docker Image</a>
<a class="nav-link" href="../tools/jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Examples</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
@@ -352,7 +377,7 @@
</td>
<td class="content">
If you&#8217;re already building with either Maven or Gradle then you might use the
<a href="../tools/maven.html" class="page">JReleaser Maven Plugin</a> or the <a href="../tools/gradle.html" class="page">JReleaser Gradle Plugin</a> plugin instead.
<a href="../tools/jreleaser-maven.html" class="page">JReleaser Maven Plugin</a> or the <a href="../tools/jreleaser-gradle.html" class="page">JReleaser Gradle Plugin</a> instead.
</td>
</tr>
</table>
@@ -465,6 +490,18 @@ If you&#8217;re already building with either Maven or Gradle then you might use
</div>
</div>
</div>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
You may use <code>latest</code> to pull the latest stable release or <code>early-access</code> to pull the latest snapshot.
</td>
</tr>
</table>
</div>
</article>
</div>
</main>

49
guide/latest/distributions/index.html
View File

@@ -94,7 +94,7 @@
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../artifacts.html">Artifacts</a>
<a class="nav-link" href="../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
@@ -162,6 +162,15 @@
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/packagers/snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../configuration/upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
@@ -243,6 +252,12 @@
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
@@ -254,43 +269,53 @@
<a class="nav-link" href="../tools/index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/cli.html">JReleaser CLI</a>
<a class="nav-link" href="../tools/jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/maven.html">JReleaser Maven Plugin</a>
<a class="nav-link" href="../tools/jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/gradle.html">JReleaser Gradle Plugin</a>
<a class="nav-link" href="../tools/jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/ant.html">JReleaser Ant Tasks</a>
<a class="nav-link" href="../tools/jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/tool-provider.html">JReleaser Tool Provider</a>
<a class="nav-link" href="../tools/jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/docker.html">JReleaser Docker Image</a>
<a class="nav-link" href="../tools/jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Examples</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">

49
guide/latest/distributions/java-binary.html
View File

@@ -94,7 +94,7 @@
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../artifacts.html">Artifacts</a>
<a class="nav-link" href="../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
@@ -162,6 +162,15 @@
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/packagers/snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../configuration/upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
@@ -243,6 +252,12 @@
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
@@ -254,43 +269,53 @@
<a class="nav-link" href="../tools/index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/cli.html">JReleaser CLI</a>
<a class="nav-link" href="../tools/jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/maven.html">JReleaser Maven Plugin</a>
<a class="nav-link" href="../tools/jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/gradle.html">JReleaser Gradle Plugin</a>
<a class="nav-link" href="../tools/jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/ant.html">JReleaser Ant Tasks</a>
<a class="nav-link" href="../tools/jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/tool-provider.html">JReleaser Tool Provider</a>
<a class="nav-link" href="../tools/jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/docker.html">JReleaser Docker Image</a>
<a class="nav-link" href="../tools/jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Examples</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">

49
guide/latest/distributions/jlink.html
View File

@@ -94,7 +94,7 @@
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../artifacts.html">Artifacts</a>
<a class="nav-link" href="../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
@@ -162,6 +162,15 @@
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/packagers/snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../configuration/upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
@@ -243,6 +252,12 @@
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
@@ -254,43 +269,53 @@
<a class="nav-link" href="../tools/index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/cli.html">JReleaser CLI</a>
<a class="nav-link" href="../tools/jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/maven.html">JReleaser Maven Plugin</a>
<a class="nav-link" href="../tools/jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/gradle.html">JReleaser Gradle Plugin</a>
<a class="nav-link" href="../tools/jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/ant.html">JReleaser Ant Tasks</a>
<a class="nav-link" href="../tools/jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/tool-provider.html">JReleaser Tool Provider</a>
<a class="nav-link" href="../tools/jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/docker.html">JReleaser Docker Image</a>
<a class="nav-link" href="../tools/jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Examples</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">

49
guide/latest/distributions/native-image.html
View File

@@ -94,7 +94,7 @@
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../artifacts.html">Artifacts</a>
<a class="nav-link" href="../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
@@ -162,6 +162,15 @@
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/packagers/snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../configuration/upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
@@ -243,6 +252,12 @@
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
@@ -254,43 +269,53 @@
<a class="nav-link" href="../tools/index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/cli.html">JReleaser CLI</a>
<a class="nav-link" href="../tools/jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/maven.html">JReleaser Maven Plugin</a>
<a class="nav-link" href="../tools/jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/gradle.html">JReleaser Gradle Plugin</a>
<a class="nav-link" href="../tools/jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/ant.html">JReleaser Ant Tasks</a>
<a class="nav-link" href="../tools/jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/tool-provider.html">JReleaser Tool Provider</a>
<a class="nav-link" href="../tools/jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/docker.html">JReleaser Docker Image</a>
<a class="nav-link" href="../tools/jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Examples</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">

49
guide/latest/distributions/single-jar.html
View File

@@ -94,7 +94,7 @@
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../artifacts.html">Artifacts</a>
<a class="nav-link" href="../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
@@ -162,6 +162,15 @@
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/packagers/snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../configuration/upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
@@ -243,6 +252,12 @@
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
@@ -254,43 +269,53 @@
<a class="nav-link" href="../tools/index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/cli.html">JReleaser CLI</a>
<a class="nav-link" href="../tools/jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/maven.html">JReleaser Maven Plugin</a>
<a class="nav-link" href="../tools/jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/gradle.html">JReleaser Gradle Plugin</a>
<a class="nav-link" href="../tools/jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/ant.html">JReleaser Ant Tasks</a>
<a class="nav-link" href="../tools/jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/tool-provider.html">JReleaser Tool Provider</a>
<a class="nav-link" href="../tools/jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/docker.html">JReleaser Docker Image</a>
<a class="nav-link" href="../tools/jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Examples</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">

55
guide/latest/examples/auto-config-release.html
View File

@@ -94,7 +94,7 @@
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../artifacts.html">Artifacts</a>
<a class="nav-link" href="../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
@@ -162,6 +162,15 @@
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/packagers/snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../configuration/upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
@@ -243,6 +252,12 @@
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
@@ -254,43 +269,53 @@
<a class="nav-link" href="../tools/index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/cli.html">JReleaser CLI</a>
<a class="nav-link" href="../tools/jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/maven.html">JReleaser Maven Plugin</a>
<a class="nav-link" href="../tools/jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/gradle.html">JReleaser Gradle Plugin</a>
<a class="nav-link" href="../tools/jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/ant.html">JReleaser Ant Tasks</a>
<a class="nav-link" href="../tools/jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/tool-provider.html">JReleaser Tool Provider</a>
<a class="nav-link" href="../tools/jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/docker.html">JReleaser Docker Image</a>
<a class="nav-link" href="../tools/jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Examples</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="simple-release.html">Simple Release</a>
</li>
<li class="nav-item is-current-page" data-depth="1">
<li class="nav-item is-current-page" data-depth="2">
<a class="nav-link" href="auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
@@ -329,7 +354,7 @@
<nav class="breadcrumbs" aria-label="breadcrumbs">
<ul>
<li><a href="../index.html">JReleaser</a></li>
<li>Examples</li>
<li><a href="index.html">Examples</a></li>
<li><a href="auto-config-release.html">AutoConfig Release</a></li>
</ul>
</nav>
@@ -375,7 +400,7 @@ origin https://github.com/duke/app.git (push)</code></pre>
--file=file1.txt \
--file=file2.txt
[INFO] JReleaser 0.2.0
[INFO] JReleaser 0.3.0
[INFO] Auto configure is ON
[INFO] - basedir set to /Home/duke/app
[INFO] - project.name: app
@@ -441,7 +466,7 @@ origin https://github.com/duke/app.git (push)</code></pre>
</div>
<div class="paragraph">
<p>Find more information about the options available for this type of releases
<a href="../tools/cli.html#_release" class="page">here</a>.</p>
<a href="../tools/jreleaser-cli.html#_release" class="page">here</a>.</p>
</div>
</article>
</div>

63
guide/latest/examples/cross-platform-jlink.html
View File

@@ -94,7 +94,7 @@
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../artifacts.html">Artifacts</a>
<a class="nav-link" href="../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
@@ -162,6 +162,15 @@
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/packagers/snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../configuration/upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
@@ -243,6 +252,12 @@
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
@@ -254,43 +269,53 @@
<a class="nav-link" href="../tools/index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/cli.html">JReleaser CLI</a>
<a class="nav-link" href="../tools/jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/maven.html">JReleaser Maven Plugin</a>
<a class="nav-link" href="../tools/jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/gradle.html">JReleaser Gradle Plugin</a>
<a class="nav-link" href="../tools/jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/ant.html">JReleaser Ant Tasks</a>
<a class="nav-link" href="../tools/jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/tool-provider.html">JReleaser Tool Provider</a>
<a class="nav-link" href="../tools/jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/docker.html">JReleaser Docker Image</a>
<a class="nav-link" href="../tools/jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Examples</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item is-current-page" data-depth="1">
<li class="nav-item is-current-page" data-depth="2">
<a class="nav-link" href="cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
@@ -329,7 +354,7 @@
<nav class="breadcrumbs" aria-label="breadcrumbs">
<ul>
<li><a href="../index.html">JReleaser</a></li>
<li>Examples</li>
<li><a href="index.html">Examples</a></li>
<li><a href="cross-platform-jlink.html">Cross Platform Jlink</a></li>
</ul>
</nav>
@@ -566,7 +591,7 @@ packagers:
&lt;plugin&gt;
&lt;groupId&gt;org.jreleaser&lt;/groupId&gt;
&lt;artifactId&gt;jreleaser-maven-plugin&lt;/artifactId&gt;
&lt;version&gt;0.2.0&lt;/version&gt;
&lt;version&gt;0.3.0&lt;/version&gt;
&lt;configuration&gt;
&lt;jreleaser&gt;
&lt;project&gt;
@@ -706,7 +731,7 @@ jreleaser {
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-sh hljs" data-lang="sh">$ jreleaser assemble
[INFO] JReleaser 0.2.0
[INFO] JReleaser 0.3.0
[INFO] Configuring with jreleaser.yml
[INFO] - basedir set to /Users/duke/tmp/app
[INFO] Reading configuration
@@ -732,7 +757,7 @@ jreleaser {
<div class="content">
<pre class="highlightjs highlight"><code class="language-sh hljs" data-lang="sh">$ jreleaser full-release
[INFO] JReleaser 0.2.0
[INFO] JReleaser 0.3.0
[INFO] Configuring with jreleaser.yml
[INFO] - basedir set to /Users/duke/tmp/app
[INFO] Reading configuration
@@ -761,9 +786,9 @@ jreleaser {
[INFO] [docker] packaging app distribution
[INFO] [docker] - duke/app:v1.0.0
[INFO] [docker] sha256:a8eb8c32b795b320a3b52e9c6e62e5c6845def2fee83fd30b2a82b20b7c542a9
[INFO] Uploading distributions
[INFO] - Uploading app distribution
[INFO] [docker] uploading app distribution
[INFO] Publishing distributions
[INFO] - Publishing app distribution
[INFO] [docker] publishing app distribution
[INFO] [docker] - duke/app:v1.0.0
[INFO] [docker] Removing login credentials for https://index.docker.io/v1/
[INFO] Announcing release

386
guide/latest/examples/index.html Normal file
View File

@@ -0,0 +1,386 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>Examples :: JReleaser</title>
<link rel="canonical" href="https://jreleaser.org/guide/latest/examples/index.html">
<meta name="generator" content="Antora 2.3.4">
<link rel="stylesheet" href="../../../_/css/site.css">
<link rel="stylesheet" href="../../../_/css/admonitions.css">
<link rel="stylesheet" href="../../../_/css/fontawesome.css">
<link rel="stylesheet" href="../../../_/css/all.css">
<script>var uiRootPath = '../../../_'</script>
</head>
<body class="article">
<header class="header">
<nav class="navbar">
<div class="navbar-brand">
<a class="navbar-item" href="https://jreleaser.org">JReleaser</a>
<button class="navbar-burger" data-target="topbar-nav">
<span></span>
<span></span>
<span></span>
</button>
</div>
</nav>
</header>
<div class="body">
<div class="nav-container" data-component="guide" data-version="latest">
<aside class="nav">
<div class="panels">
<div class="nav-panel-menu is-active" data-panel="menu">
<nav class="nav-menu">
<h3 class="title"><a href="../index.html">JReleaser</a></h3>
<ul class="nav-list">
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../install.html">Install</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../quick-start/index.html">Quick Start</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../quick-start/cli.html">Command Line</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../quick-start/maven.html">Apache Maven</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../quick-start/gradle.html">Gradle</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../quick-start/ant.html">Apache Ant</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../workflow.html">Workflow</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../distributions/index.html">Distributions</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../distributions/java-binary.html">Java Binary</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../distributions/single-jar.html">Single JAR</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../distributions/jlink.html">Jlink</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../distributions/native-image.html">Native Image</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../configuration/index.html">Configuration</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../configuration/environment.html">Environment</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../configuration/project.html">Project</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../configuration/signing.html">Signing</a>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../configuration/release/index.html">Release</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/release/github.html">GitHub</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/release/gitlab.html">GitLab</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/release/gitea.html">Gitea</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../configuration/assemble/index.html">Assemble</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/assemble/jlink.html">Jlink</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/assemble/native-image.html">Native Image</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../configuration/packagers/index.html">Packagers</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/packagers/chocolatey.html">Chocolatey</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/packagers/docker.html">Docker</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/packagers/homebrew.html">Homebrew</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/packagers/jbang.html">Jbang</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/packagers/scoop.html">Scoop</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/packagers/snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../configuration/upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../configuration/distributions.html">Distributions</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../configuration/files.html">Files</a>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../configuration/announce/index.html">Announce</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/announce/discord.html">Discord</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/announce/discussions.html">GitHub Discussions</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/announce/gitter.html">Gitter</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/announce/mail.html">Mail</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/announce/sdkman.html">Sdkman</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/announce/slack.html">Slack</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/announce/teams.html">Teams</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/announce/twitter.html">Twitter</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/announce/zulip.html">Zulip</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../configuration/name-templates.html">Name Templates</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Templates</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../templates/templates.html">Template Basics</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../templates/mustache.html">Mustache Primer</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../continuous-integration/index.html">Continuous Integration</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/github-actions.html">GitHub Actions</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/jenkins.html">Jenkins</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/circle-ci.html">Circle CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/codefresh.html">Codefresh</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../tools/index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item is-current-page" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../links.html">Links</a>
</li>
</ul>
</li>
</ul>
</nav>
</div>
<div class="nav-panel-explore" data-panel="explore">
<div class="context">
<span class="title">JReleaser</span>
<span class="version">latest</span>
</div>
<ul class="components">
<li class="component is-current">
<a class="title" href="../index.html">JReleaser</a>
<ul class="versions">
<li class="version is-current is-latest">
<a href="../index.html">latest</a>
</li>
</ul>
</li>
</ul>
</div>
</div>
</aside>
</div>
<main class="article">
<div class="toolbar" role="navigation">
<button class="nav-toggle"></button>
<a href="../index.html" class="home-link"></a>
<nav class="breadcrumbs" aria-label="breadcrumbs">
<ul>
<li><a href="../index.html">JReleaser</a></li>
<li><a href="index.html">Examples</a></li>
</ul>
</nav>
<div class="edit-this-page"><a href="https://github.com/jreleaser/jreleaser.github.io/edit/main/docs/modules/examples/pages/index.adoc">Edit this Page</a></div>
</div>
<div class="content">
<aside class="toc sidebar" data-title="Contents" data-levels="2">
<div class="toc-menu"></div>
</aside>
<article class="doc">
<h1 class="page">Examples</h1>
<div class="paragraph">
<p>The following sections describe examples and sample configuration that you may adapt to your
own projects.</p>
</div>
</article>
</div>
</main>
</div>
<footer class="footer">
<p>Copyright (C) 2021 Andres Almiray. This page was built using an adapted version of the Antora default UI.</p>
<p>The source code for this UI is licensed under the <a href="https://www.mozilla.org/en-US/MPL/2.0/">Mozilla Public License Version 2.0</a> (MPL-2.0).</p>
</footer>
<!--script src="../../../_/js/fontawesome.js"></script>
<script src="../../../_/js/all.js"></script-->
<script src="../../../_/js/site.js"></script>
<script async src="../../../_/js/vendor/highlight.js"></script>
</body>
</html>

150
guide/latest/examples/jreleaser.html
View File

@@ -94,7 +94,7 @@
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../artifacts.html">Artifacts</a>
<a class="nav-link" href="../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
@@ -162,6 +162,15 @@
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/packagers/snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../configuration/upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
@@ -243,6 +252,12 @@
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
@@ -254,43 +269,53 @@
<a class="nav-link" href="../tools/index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/cli.html">JReleaser CLI</a>
<a class="nav-link" href="../tools/jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/maven.html">JReleaser Maven Plugin</a>
<a class="nav-link" href="../tools/jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/gradle.html">JReleaser Gradle Plugin</a>
<a class="nav-link" href="../tools/jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/ant.html">JReleaser Ant Tasks</a>
<a class="nav-link" href="../tools/jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/tool-provider.html">JReleaser Tool Provider</a>
<a class="nav-link" href="../tools/jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/docker.html">JReleaser Docker Image</a>
<a class="nav-link" href="../tools/jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Examples</span>
<ul class="nav-list">
<li class="nav-item is-current-page" data-depth="1">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item is-current-page" data-depth="2">
<a class="nav-link" href="jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
@@ -329,7 +354,7 @@
<nav class="breadcrumbs" aria-label="breadcrumbs">
<ul>
<li><a href="../index.html">JReleaser</a></li>
<li>Examples</li>
<li><a href="index.html">Examples</a></li>
<li><a href="jreleaser.html">JReleaser&#8217;s Release</a></li>
</ul>
</nav>
@@ -355,7 +380,16 @@ is used to create both release and snapshot releases:</p>
project:
name: jreleaser
description: Release Java projects quickly and easily with JReleaser
longDescription: Release Java projects quickly and easily with JReleaser
longDescription: |
JReleaser is a release automation tool for Java projects. Its goal is to simplify creating releases
and publishing artifacts to multiple package managers while providing customizable options.
JReleaser takes inputs from popular builds tools (Ant, Maven, Gradle) such as JAR files, binary
distributions (.zip, .tar), JLink images, or any other file that you’d like to publish as a Git
release on popular Git services such as Github or Gitlab. Distribution files can additionally be
published to be consumed by popular package managers as Homebrew, Snapcraft, or get ready to be
launched via Jbang. Releases may be announced in a variety of channels such as Twitter, Zulip, or SDKMAN!
website: https://jreleaser.org
authors:
- Andres Almiray
@@ -366,12 +400,43 @@ project:
# The repository is hosted at https://github.com/jreleaser/jreleaser
# which means the default username would be `jreleaser` however a
# different username is required
# different username is required in this case
release:
github:
username: aalmiray
overwrite: true
sign: true
changelog:
formatted: ALWAYS
change: '- {{commitShortHash}} {{commitTitle}}'
# Label commits by matching their first line
labelers:
- label: 'feature'
title: 'Resolves #'
body: 'Resolves #'
- label: 'issue'
title: 'Fixes #'
body: 'Fixes #'
- label: 'issue'
title: 'Relates to #'
body: 'Relates to #'
- label: 'task'
title: '[chore]'
# Categorize commits by labels
categories:
- title: '🚀 Features'
labels:
- 'feature'
- title: '✅ Issues'
labels:
- 'issue'
- title: '🧰 Tasks'
labels:
- 'task'
# Remove `[chore] ` from the commit message
replacers:
- search: '\[chore\] '
replace: ''
# File signing is always active
signing:
@@ -385,6 +450,39 @@ announce:
sdkman:
active: release
# Configure a cross-platform Jlink assembly &amp; distribution
assemble:
jlinks:
jreleaser-standalone:
active: always
extraProperties:
sdkmanSkip: true
java:
version: 11
mainClass: org.jreleaser.cli.Main
imageName: 'jreleaser-standalone-{{projectEffectiveVersion}}'
executable: 'jreleaser'
moduleNames:
- java.base
- java.desktop
- java.management
- java.naming
- java.rmi
- java.security.jgss
- java.sql
targetJdks:
- path: 'apps/jreleaser/build/jdks/zulu11.48.21-ca-jdk11.0.11-macosx_x64/zulu-11.jdk/Contents/Home'
platform: osx
- path: 'apps/jreleaser/build/jdks/zulu11.48.21-ca-jdk11.0.11-linux_x64'
platform: linux
- path: 'apps/jreleaser/build/jdks/zulu11.48.21-ca-jdk11.0.11-win_x64'
platform: windows
mainJar:
path: 'apps/jreleaser/build/libs/jreleaser-{{projectVersion}}.jar'
jars:
- directory: 'apps/jreleaser/build/dependencies/flat'
include: '*.jar'
# Configure 3 distributions
distributions:
# Distribution 1 is of type JAVA_BINARY
@@ -397,6 +495,14 @@ distributions:
scoop:
# Active only on release
active: release
snap:
# Active only on release
active: release
remoteBuild: true
base: core18
localPlugs:
- network
- home
jbang:
# Always active
active: always
@@ -404,11 +510,13 @@ distributions:
# Transform the artifact name
- path: apps/{{distributionName}}/build/distributions/{{distributionName}}-{{projectVersion}}.zip
transform: '{{distributionName}}/{{distributionName}}-{{projectEffectiveVersion}}.zip'
- path: apps/{{distributionName}}/build/distributions/{{distributionName}}-{{projectVersion}}.tar
transform: '{{distributionName}}/{{distributionName}}-{{projectEffectiveVersion}}.tar'
# Distribution 2 is of type JAVA_BINARY
jreleaser-ant-tasks:
extraProperties:
# Do not considerits artifacts for publication via SdkMan
# Do not consider its artifacts for publication via SdkMan
sdkmanSkip: true
artifacts:
# Transform the artifact name
@@ -445,12 +553,8 @@ files:
</div>
</div>
<div class="paragraph">
<p>Which will create and tag a prerelease on GitHub when the project is snapshot</p>
</div>
<div class="imageblock">
<div class="content">
<img src="../_images/jreleaser-early-access.png" alt="jreleaser early access">
</div>
<p>Which will create and tag a prerelease on GitHub when the project is snapshot, and a regular release when
the project is not snapshot.</p>
</div>
</article>
</div>

55
guide/latest/examples/simple-release.html
View File

@@ -94,7 +94,7 @@
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../artifacts.html">Artifacts</a>
<a class="nav-link" href="../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
@@ -162,6 +162,15 @@
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/packagers/snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../configuration/upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
@@ -243,6 +252,12 @@
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
@@ -254,43 +269,53 @@
<a class="nav-link" href="../tools/index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/cli.html">JReleaser CLI</a>
<a class="nav-link" href="../tools/jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/maven.html">JReleaser Maven Plugin</a>
<a class="nav-link" href="../tools/jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/gradle.html">JReleaser Gradle Plugin</a>
<a class="nav-link" href="../tools/jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/ant.html">JReleaser Ant Tasks</a>
<a class="nav-link" href="../tools/jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/tool-provider.html">JReleaser Tool Provider</a>
<a class="nav-link" href="../tools/jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/docker.html">JReleaser Docker Image</a>
<a class="nav-link" href="../tools/jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Examples</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item is-current-page" data-depth="1">
<li class="nav-item is-current-page" data-depth="2">
<a class="nav-link" href="simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
@@ -329,7 +354,7 @@
<nav class="breadcrumbs" aria-label="breadcrumbs">
<ul>
<li><a href="../index.html">JReleaser</a></li>
<li>Examples</li>
<li><a href="index.html">Examples</a></li>
<li><a href="simple-release.html">Simple Release</a></li>
</ul>
</nav>
@@ -344,7 +369,7 @@
<div class="paragraph">
<p>The following configuration creates and tags a release at the chosen Git repository, in this case it will be
https://github.com/duke/app. The changelog will be automatically computed. No additional files nor
distributions will be checksumed, signed, nor uploaded.</p>
distributions will be checksumed, signed, nor published.</p>
</div>
<div class="tabset is-loading">
<div class="ulist tabs">
@@ -449,7 +474,7 @@ release:
&lt;plugin&gt;
&lt;groupId&gt;org.jreleaser&lt;/groupId&gt;
&lt;artifactId&gt;jreleaser-maven-plugin&lt;/artifactId&gt;
&lt;version&gt;0.2.0&lt;/version&gt;
&lt;version&gt;0.3.0&lt;/version&gt;
&lt;configuration&gt;
&lt;jreleaser&gt;
&lt;release&gt;

55
guide/latest/index.html
View File

@@ -94,7 +94,7 @@
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="artifacts.html">Artifacts</a>
<a class="nav-link" href="artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
@@ -162,6 +162,15 @@
<li class="nav-item" data-depth="3">
<a class="nav-link" href="configuration/packagers/snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="configuration/upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="configuration/upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
@@ -243,6 +252,12 @@
<li class="nav-item" data-depth="2">
<a class="nav-link" href="continuous-integration/gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="continuous-integration/cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="continuous-integration/drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
@@ -254,43 +269,53 @@
<a class="nav-link" href="tools/index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="tools/cli.html">JReleaser CLI</a>
<a class="nav-link" href="tools/jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="tools/maven.html">JReleaser Maven Plugin</a>
<a class="nav-link" href="tools/jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="tools/gradle.html">JReleaser Gradle Plugin</a>
<a class="nav-link" href="tools/jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="tools/ant.html">JReleaser Ant Tasks</a>
<a class="nav-link" href="tools/jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="tools/tool-provider.html">JReleaser Tool Provider</a>
<a class="nav-link" href="tools/jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="tools/docker.html">JReleaser Docker Image</a>
<a class="nav-link" href="tools/jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="tools/jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="tools/jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Examples</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
@@ -368,9 +393,9 @@ as Twitter, Zulip, SDKMAN!, and others.</p>
<h2 id="_how_does_it_work"><a class="anchor" href="#_how_does_it_work"></a>How does it work</h2>
<div class="sectionbody">
<div class="paragraph">
<p>A release process can be customized with a <code>jreleaser.[yml|toml|json]</code> file if using the <a href="tools/cli.html" class="page">CLI</a> or
<a href="tools/ant.html" class="page">Ant</a> options, or direct DSL configuration inside a <code>pom.xml</code> (<a href="tools/maven.html" class="page">Maven</a>) or
<code>build.gradle</code> (<a href="tools/gradle.html" class="page">Gradle</a>) file.</p>
<p>A release process can be customized with a <code>jreleaser.[yml|toml|json]</code> file if using the <a href="tools/jreleaser-cli.html" class="page">CLI</a> or
<a href="tools/jreleaser-ant.html" class="page">Ant</a> options, or direct DSL configuration inside a <code>pom.xml</code> (<a href="tools/jreleaser-maven.html" class="page">Maven</a>) or
<code>build.gradle</code> (<a href="tools/jreleaser-gradle.html" class="page">Gradle</a>) file.</p>
</div>
<div class="paragraph">
<p>Once setup, you can create a new release by invoking the <code>full-release</code> command.</p>

199
guide/latest/install.html
View File

@@ -94,7 +94,7 @@
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="artifacts.html">Artifacts</a>
<a class="nav-link" href="artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
@@ -162,6 +162,15 @@
<li class="nav-item" data-depth="3">
<a class="nav-link" href="configuration/packagers/snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="configuration/upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="configuration/upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
@@ -243,6 +252,12 @@
<li class="nav-item" data-depth="2">
<a class="nav-link" href="continuous-integration/gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="continuous-integration/cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="continuous-integration/drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
@@ -254,43 +269,53 @@
<a class="nav-link" href="tools/index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="tools/cli.html">JReleaser CLI</a>
<a class="nav-link" href="tools/jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="tools/maven.html">JReleaser Maven Plugin</a>
<a class="nav-link" href="tools/jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="tools/gradle.html">JReleaser Gradle Plugin</a>
<a class="nav-link" href="tools/jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="tools/ant.html">JReleaser Ant Tasks</a>
<a class="nav-link" href="tools/jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="tools/tool-provider.html">JReleaser Tool Provider</a>
<a class="nav-link" href="tools/jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="tools/docker.html">JReleaser Docker Image</a>
<a class="nav-link" href="tools/jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="tools/jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="tools/jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Examples</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
@@ -351,7 +376,7 @@
<h2 id="_cli"><a class="anchor" href="#_cli"></a>CLI</h2>
<div class="sectionbody">
<div class="paragraph">
<p>The <a href="tools/cli.html" class="page">CLI</a> can be installed in the following ways:</p>
<p>The <a href="tools/jreleaser-cli.html" class="page">CLI</a> can be installed in the following ways:</p>
</div>
<div class="tabset is-loading">
<div class="ulist tabs">
@@ -372,6 +397,9 @@
<div class="paragraph">
<p><strong>sdkman</strong></p>
</div>
<div class="paragraph">
<p>Requires Java 8</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code>sdk install jreleaser</code></pre>
@@ -380,6 +408,9 @@
<div class="paragraph">
<p><strong>jbang</strong></p>
</div>
<div class="paragraph">
<p>Requires Java 8</p>
</div>
<div class="listingblock">
<div class="title">stable</div>
<div class="content">
@@ -391,7 +422,7 @@ jbang jreleaser@jreleaser &lt;command&gt; [&lt;args&gt;]</code></pre>
<div class="title">early-access</div>
<div class="content">
<pre class="highlightjs highlight"><code>// Download, cache, and run
jbang jreleaser_snapshot@jreleaser &lt;command&gt; [&lt;args&gt;]</code></pre>
jbang jreleaser-snapshot@jreleaser &lt;command&gt; [&lt;args&gt;]</code></pre>
</div>
</div>
<div class="paragraph">
@@ -401,11 +432,28 @@ jbang jreleaser_snapshot@jreleaser &lt;command&gt; [&lt;args&gt;]</code></pre>
<p>Download the pre-compiled binary from the <a href="https://github.com/jreleaser/jreleaser/releases">releases page</a>,
uncompress and copy to the desired location.</p>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
Be mindful that <code>jreleaser-0.3.0.zip</code> requires Java 8 to be installed while
<code>jreleaser-standalone-0.3.0-windows.zip</code> can be used without a previous installation of Java as
it includes its own Java Runtime.
</td>
</tr>
</table>
</div>
</div>
<div class="tab-pane" aria-labelledby="tabset1_linux">
<div class="paragraph">
<p><strong>sdkman</strong></p>
</div>
<div class="paragraph">
<p>Requires Java 8</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code>sdk install jreleaser</code></pre>
@@ -414,6 +462,9 @@ uncompress and copy to the desired location.</p>
<div class="paragraph">
<p><strong>jbang</strong></p>
</div>
<div class="paragraph">
<p>Requires Java 8</p>
</div>
<div class="listingblock">
<div class="title">stable</div>
<div class="content">
@@ -425,21 +476,70 @@ jbang jreleaser@jreleaser &lt;command&gt; [&lt;args&gt;]</code></pre>
<div class="title">early-access</div>
<div class="content">
<pre class="highlightjs highlight"><code>// Download, cache, and run
jbang jreleaser_snapshot@jreleaser &lt;command&gt; [&lt;args&gt;]</code></pre>
jbang jreleaser-snapshot@jreleaser &lt;command&gt; [&lt;args&gt;]</code></pre>
</div>
</div>
<div class="paragraph">
<p><strong>curl</strong></p>
</div>
<div class="paragraph">
<p>Requires Java 11</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code>// Get the jreleaser downloader
curl -sL https://git.io/get-jreleaser &gt; get_jreleaser.java
// Download JReleaser with version = &lt;version&gt;
// Change &lt;version&gt; to a tagged JReleaser release
// or leave it out to pull `latest`.
java get_jreleaser.java &lt;version&gt;
// Execute a JReleaser
java -jar jreleaser-cli.jar &lt;command&gt; [&lt;args&gt;]</code></pre>
</div>
</div>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
You may use <code>latest</code> to pull the latest stable release or <code>early-access</code> to pull the latest snapshot.
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p><strong>manually</strong></p>
</div>
<div class="paragraph">
<p>Download the pre-compiled binary from the <a href="https://github.com/jreleaser/jreleaser/releases">releases page</a>,
uncompress and copy to the desired location.</p>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
Be mindful that <code>jreleaser-0.3.0.zip</code> requires Java 8 to be installed while
<code>jreleaser-standalone-0.3.0-linux.zip</code> can be used without a previous installation of Java as
it includes its own Java Runtime.
</td>
</tr>
</table>
</div>
</div>
<div class="tab-pane" aria-labelledby="tabset1_mac">
<div class="paragraph">
<p><strong>homebrew tap</strong></p>
</div>
<div class="paragraph">
<p>Requires Java 8</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code>brew install jreleaser/tap/jreleaser</code></pre>
@@ -448,6 +548,9 @@ uncompress and copy to the desired location.</p>
<div class="paragraph">
<p><strong>sdkman</strong></p>
</div>
<div class="paragraph">
<p>Requires Java 8</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code>sdk install jreleaser</code></pre>
@@ -456,6 +559,9 @@ uncompress and copy to the desired location.</p>
<div class="paragraph">
<p><strong>jbang</strong></p>
</div>
<div class="paragraph">
<p>Requires Java 8</p>
</div>
<div class="listingblock">
<div class="title">stable</div>
<div class="content">
@@ -467,16 +573,62 @@ jbang jreleaser@jreleaser &lt;command&gt; [&lt;args&gt;]</code></pre>
<div class="title">early-access</div>
<div class="content">
<pre class="highlightjs highlight"><code>// Download, cache, and run
jbang jreleaser_snapshot@jreleaser &lt;command&gt; [&lt;args&gt;]</code></pre>
jbang jreleaser-snapshot@jreleaser &lt;command&gt; [&lt;args&gt;]</code></pre>
</div>
</div>
<div class="paragraph">
<p><strong>curl</strong></p>
</div>
<div class="paragraph">
<p>Requires Java 11</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code>// Get the jreleaser downloader
curl -sL https://git.io/get-jreleaser &gt; get_jreleaser.java
// Download JReleaser with version = &lt;version&gt;
// Change &lt;version&gt; to a tagged JReleaser release
// or leave it out to pull `latest`.
java get_jreleaser.java &lt;version&gt;
// Execute a JReleaser
java -jar jreleaser-cli.jar &lt;command&gt; [&lt;args&gt;]</code></pre>
</div>
</div>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
You may use <code>latest</code> to pull the latest stable release or <code>early-access</code> to pull the latest snapshot.
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p><strong>manually</strong></p>
</div>
<div class="paragraph">
<p>Download the pre-compiled binary from the <a href="https://github.com/jreleaser/jreleaser/releases">releases page</a>,
uncompress and copy to the desired location.</p>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
Be mindful that <code>jreleaser-0.3.0.zip</code> requires Java 8 to be installed while
<code>jreleaser-standalone-0.3.0-osx.zip</code> can be used without a previous installation of Java as
it includes its own Java Runtime.
</td>
</tr>
</table>
</div>
</div>
</div>
</div>
@@ -510,13 +662,16 @@ The <code>--basedir</code> argument will be automatically set to <code>--basedir
<p>You may also need to map environment variables to the container, such as <code>JRELEASER_PROJECT_VERSION</code>,
<code>JRELEASER_GITHUB_TOKEN</code>, or others depending on your setup. Refer to the <a href="configuration/index.html" class="page">Configuration</a> pages.</p>
</div>
<div class="paragraph">
<p>You can find the tag listing <a href="hub.docker.com/r/jreleaser/jreleaser-slim/tags">here</a>.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_maven"><a class="anchor" href="#_maven"></a>Maven</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Configure the <a href="tools/maven.html" class="page">jreleaser-maven-plugin</a> in your POM file</p>
<p>Configure the <a href="tools/jreleaser-maven.html" class="page">jreleaser-maven-plugin</a> in your POM file</p>
</div>
<div class="listingblock">
<div class="title">pom.xml</div>
@@ -524,7 +679,7 @@ The <code>--basedir</code> argument will be automatically set to <code>--basedir
<pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml">&lt;plugin&gt;
&lt;groupId&gt;org.jreleaser&lt;/groupId&gt;
&lt;artifactId&gt;jreleaser-maven-plugin&lt;/artifactId&gt;
&lt;version&gt;0.2.0&lt;/version&gt;
&lt;version&gt;0.3.0&lt;/version&gt;
&lt;/plugin&gt;</code></pre>
</div>
</div>
@@ -534,13 +689,13 @@ The <code>--basedir</code> argument will be automatically set to <code>--basedir
<h2 id="_gradle"><a class="anchor" href="#_gradle"></a>Gradle</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Configure the <a href="tools/gradle.html" class="page">jreleaser-gradle-plugin</a> in your <code>build.gradle</code> file</p>
<p>Configure the <a href="tools/jreleaser-gradle.html" class="page">jreleaser-gradle-plugin</a> in your <code>build.gradle</code> file</p>
</div>
<div class="listingblock">
<div class="title">build.gradle</div>
<div class="content">
<pre class="highlightjs highlight"><code class="language-groovy hljs" data-lang="groovy">plugins {
id 'org.jreleaser' version '0.2.0'
id 'org.jreleaser' version '0.3.0'
}</code></pre>
</div>
</div>
@@ -550,7 +705,7 @@ The <code>--basedir</code> argument will be automatically set to <code>--basedir
<h2 id="_ant"><a class="anchor" href="#_ant"></a>Ant</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Download the <a href="tools/ant.html" class="page">jreleaser-ant-tasks</a> ZIP bundle from the
<p>Download the <a href="tools/jreleaser-ant.html" class="page">jreleaser-ant-tasks</a> ZIP bundle from the
<a href="https://github.com/jreleaser/jreleaser/releases">releases page</a> and unzip it in your project. Place all JARs inside
the <code>lib</code> folder. Create this folder if there is none. Add the following elements to your <code>build.xml</code> file</p>
</div>
@@ -559,7 +714,7 @@ the <code>lib</code> folder. Create this folder if there is none. Add the follow
<div class="content">
<pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml">&lt;path id="jreleaser.classpath"&gt;
&lt;fileset dir="lib"&gt;
&lt;include name="jreleaser-ant-tasks-0.2.0/*.jar"/&gt;
&lt;include name="jreleaser-ant-tasks-0.3.0/*.jar"/&gt;
&lt;/fileset&gt;
&lt;/path&gt;

49
guide/latest/links.html
View File

@@ -94,7 +94,7 @@
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="artifacts.html">Artifacts</a>
<a class="nav-link" href="artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
@@ -162,6 +162,15 @@
<li class="nav-item" data-depth="3">
<a class="nav-link" href="configuration/packagers/snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="configuration/upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="configuration/upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
@@ -243,6 +252,12 @@
<li class="nav-item" data-depth="2">
<a class="nav-link" href="continuous-integration/gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="continuous-integration/cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="continuous-integration/drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
@@ -254,43 +269,53 @@
<a class="nav-link" href="tools/index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="tools/cli.html">JReleaser CLI</a>
<a class="nav-link" href="tools/jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="tools/maven.html">JReleaser Maven Plugin</a>
<a class="nav-link" href="tools/jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="tools/gradle.html">JReleaser Gradle Plugin</a>
<a class="nav-link" href="tools/jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="tools/ant.html">JReleaser Ant Tasks</a>
<a class="nav-link" href="tools/jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="tools/tool-provider.html">JReleaser Tool Provider</a>
<a class="nav-link" href="tools/jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="tools/docker.html">JReleaser Docker Image</a>
<a class="nav-link" href="tools/jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="tools/jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="tools/jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Examples</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">

56
guide/latest/quick-start/ant.html
View File

@@ -94,7 +94,7 @@
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../artifacts.html">Artifacts</a>
<a class="nav-link" href="../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
@@ -162,6 +162,15 @@
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/packagers/snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../configuration/upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
@@ -243,6 +252,12 @@
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
@@ -254,43 +269,53 @@
<a class="nav-link" href="../tools/index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/cli.html">JReleaser CLI</a>
<a class="nav-link" href="../tools/jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/maven.html">JReleaser Maven Plugin</a>
<a class="nav-link" href="../tools/jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/gradle.html">JReleaser Gradle Plugin</a>
<a class="nav-link" href="../tools/jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/ant.html">JReleaser Ant Tasks</a>
<a class="nav-link" href="../tools/jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/tool-provider.html">JReleaser Tool Provider</a>
<a class="nav-link" href="../tools/jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/docker.html">JReleaser Docker Image</a>
<a class="nav-link" href="../tools/jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Examples</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
@@ -420,7 +445,7 @@ configuration by invoking</p>
Buildfile: /Home/duke/app/build.xml
jreleaser-full-release:
JReleaser 0.2.0
JReleaser 0.3.0
Configuring with jreleaser.yml
- basedir set to /Home/duke/app
Reading configuration
@@ -436,6 +461,7 @@ Calculating checksums
[checksum] target/distributions/app/app-1.0.0.zip
Signing files
Signing is not enabled. Skipping
Uploading is not enabled. Skipping.
Releasing to https://github.com/duke/app
- Uploading app-1.0.0.zip
- Uploading checksums.txt
@@ -443,8 +469,8 @@ Preparing distributions
- Preparing app distribution
Packaging distributions
- Packaging app distribution
Uploading distributions
- Uploading app distribution
Publishing distributions
- Publishing app distribution
Announcing release
Announcing is not enabled. Skipping.
JReleaser succeeded after 0.894s

56
guide/latest/quick-start/cli.html
View File

@@ -94,7 +94,7 @@
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../artifacts.html">Artifacts</a>
<a class="nav-link" href="../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
@@ -162,6 +162,15 @@
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/packagers/snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../configuration/upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
@@ -243,6 +252,12 @@
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
@@ -254,43 +269,53 @@
<a class="nav-link" href="../tools/index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/cli.html">JReleaser CLI</a>
<a class="nav-link" href="../tools/jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/maven.html">JReleaser Maven Plugin</a>
<a class="nav-link" href="../tools/jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/gradle.html">JReleaser Gradle Plugin</a>
<a class="nav-link" href="../tools/jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/ant.html">JReleaser Ant Tasks</a>
<a class="nav-link" href="../tools/jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/tool-provider.html">JReleaser Tool Provider</a>
<a class="nav-link" href="../tools/jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/docker.html">JReleaser Docker Image</a>
<a class="nav-link" href="../tools/jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Examples</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
@@ -408,7 +433,7 @@ configuration by invoking</p>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code>$ jreleaser full-release
[INFO] JReleaser 0.2.0
[INFO] JReleaser 0.3.0
[INFO] Configuring with jreleaser.yml
[INFO] - basedir set to /Home/duke/app
[INFO] Reading configuration
@@ -424,6 +449,7 @@ configuration by invoking</p>
[INFO] [checksum] target/distributions/app/app-1.0.0.zip
[INFO] Signing files
[INFO] Signing is not enabled. Skipping
[INFO] Uploading is not enabled. Skipping.
[INFO] Releasing to https://github.com/duke/app
[INFO] - Uploading app-1.0.0.zip
[INFO] - Uploading checksums.txt
@@ -431,8 +457,8 @@ configuration by invoking</p>
[INFO] - Preparing app distribution
[INFO] Packaging distributions
[INFO] - Packaging app distribution
[INFO] Uploading distributions
[INFO] - Uploading app distribution
[INFO] Publishing distributions
[INFO] - Publishing app distribution
[INFO] Announcing release
[INFO] Announcing is not enabled. Skipping.
[INFO] JReleaser succeeded after 0.894s

72
guide/latest/quick-start/gradle.html
View File

@@ -94,7 +94,7 @@
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../artifacts.html">Artifacts</a>
<a class="nav-link" href="../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
@@ -162,6 +162,15 @@
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/packagers/snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../configuration/upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
@@ -243,6 +252,12 @@
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
@@ -254,43 +269,53 @@
<a class="nav-link" href="../tools/index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/cli.html">JReleaser CLI</a>
<a class="nav-link" href="../tools/jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/maven.html">JReleaser Maven Plugin</a>
<a class="nav-link" href="../tools/jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/gradle.html">JReleaser Gradle Plugin</a>
<a class="nav-link" href="../tools/jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/ant.html">JReleaser Ant Tasks</a>
<a class="nav-link" href="../tools/jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/tool-provider.html">JReleaser Tool Provider</a>
<a class="nav-link" href="../tools/jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/docker.html">JReleaser Docker Image</a>
<a class="nav-link" href="../tools/jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Examples</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
@@ -346,7 +371,7 @@
the <code><a href="https://docs.gradle.org/current/userguide/application_plugin.html">application</a></code> plugin.</p>
</div>
<div class="paragraph">
<p>You also have to configure the <a href="../tools/gradle.html" class="page">jreleaser-gradle-plugin</a>. We recommend using the
<p>You also have to configure the <a href="../tools/jreleaser-gradle.html" class="page">jreleaser-gradle-plugin</a>. We recommend using the
<a href="https://kordamp.org/kordamp-gradle-plugins/">Kordamp plugins</a> as they provide additional benefits,
however their use is optional. A sample project using Kordamp may look like this:</p>
</div>
@@ -357,7 +382,7 @@ however their use is optional. A sample project using Kordamp may look like this
id 'java-library'
id 'application'
id 'org.kordamp.gradle.java-project' version '0.45.0'
id 'org.jreleaser' version '0.2.0'
id 'org.jreleaser' version '0.3.0'
}
application {
@@ -458,7 +483,7 @@ copyright year, default settings.</p>
<pre class="highlightjs highlight"><code class="language-groovy hljs" data-lang="groovy">plugins {
id 'java-library'
id 'application'
id 'org.jreleaser' version '0.2.0'
id 'org.jreleaser' version '0.3.0'
}
application {
@@ -499,12 +524,6 @@ from the <code>assembleDist</code> task.</p>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code>$ gradle jreleaseFullRelease
[INFO] Loading properties from /Home/duke/.jreleaser/config.properties
[INFO] Validating configuration
[INFO] Project version set to 1.0.0
[INFO] Release is not snapshot
[INFO] Timestamp is 2021-03-28T12:25:16.219+02:00
[INFO] HEAD is at c3e39f1
&gt; Task :compileJava
&gt; Task :processResources NO-SOURCE
&gt; Task :classes
@@ -516,12 +535,19 @@ from the <code>assembleDist</code> task.</p>
&gt; Task :assembleDist
&gt; Task :jreleaserFullRelease
[INFO] Loading properties from /Home/duke/.jreleaser/config.properties
[INFO] Validating configuration
[INFO] Project version set to 1.0.0
[INFO] Release is not snapshot
[INFO] Timestamp is 2021-03-28T12:25:16.219+02:00
[INFO] HEAD is at c3e39f1
[INFO] dryrun set to false
[INFO] Generating changelog: out/jreleaser/release/CHANGELOG.md
[INFO] Calculating checksums
[INFO] [checksum] target/distributions/app/app-1.0.0.zip
[INFO] Signing files
[INFO] Signing is not enabled. Skipping
[INFO] Uploading is not enabled. Skipping.
[INFO] Releasing to https://github.com/duke/app
[INFO] - Uploading app-1.0.0.zip
[INFO] - Uploading checksums.txt
@@ -529,8 +555,8 @@ from the <code>assembleDist</code> task.</p>
[INFO] - Preparing app distribution
[INFO] Packaging distributions
[INFO] - Packaging app distribution
[INFO] Uploading distributions
[INFO] - Uploading app distribution
[INFO] Publishing distributions
[INFO] - Publishing app distribution
[INFO] Announcing release
[INFO] Announcing is not enabled. Skipping.
[INFO] JReleaser succeeded after 0.894s

49
guide/latest/quick-start/index.html
View File

@@ -94,7 +94,7 @@
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../artifacts.html">Artifacts</a>
<a class="nav-link" href="../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
@@ -162,6 +162,15 @@
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/packagers/snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../configuration/upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
@@ -243,6 +252,12 @@
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
@@ -254,43 +269,53 @@
<a class="nav-link" href="../tools/index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/cli.html">JReleaser CLI</a>
<a class="nav-link" href="../tools/jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/maven.html">JReleaser Maven Plugin</a>
<a class="nav-link" href="../tools/jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/gradle.html">JReleaser Gradle Plugin</a>
<a class="nav-link" href="../tools/jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/ant.html">JReleaser Ant Tasks</a>
<a class="nav-link" href="../tools/jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/tool-provider.html">JReleaser Tool Provider</a>
<a class="nav-link" href="../tools/jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/docker.html">JReleaser Docker Image</a>
<a class="nav-link" href="../tools/jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Examples</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">

60
guide/latest/quick-start/maven.html
View File

@@ -94,7 +94,7 @@
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../artifacts.html">Artifacts</a>
<a class="nav-link" href="../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
@@ -162,6 +162,15 @@
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/packagers/snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../configuration/upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
@@ -243,6 +252,12 @@
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
@@ -254,43 +269,53 @@
<a class="nav-link" href="../tools/index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/cli.html">JReleaser CLI</a>
<a class="nav-link" href="../tools/jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/maven.html">JReleaser Maven Plugin</a>
<a class="nav-link" href="../tools/jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/gradle.html">JReleaser Gradle Plugin</a>
<a class="nav-link" href="../tools/jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/ant.html">JReleaser Ant Tasks</a>
<a class="nav-link" href="../tools/jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/tool-provider.html">JReleaser Tool Provider</a>
<a class="nav-link" href="../tools/jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/docker.html">JReleaser Docker Image</a>
<a class="nav-link" href="../tools/jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Examples</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
@@ -360,7 +385,7 @@ dependencies and generates launcher scripts.</p>
</ul>
</div>
<div class="paragraph">
<p>You also have to configure the <a href="../tools/maven.html" class="page">jreleaser-maven-plugin</a>. A sample project may look like this:</p>
<p>You also have to configure the <a href="../tools/jreleaser-maven.html" class="page">jreleaser-maven-plugin</a>. A sample project may look like this:</p>
</div>
<div class="listingblock">
<div class="title">pom.xml</div>
@@ -480,7 +505,7 @@ dependencies and generates launcher scripts.</p>
&lt;plugin&gt;
&lt;groupId&gt;org.jreleaser&lt;/groupId&gt;
&lt;artifactId&gt;jreleaser-maven-plugin&lt;/artifactId&gt;
&lt;version&gt;0.2.0&lt;/version&gt;
&lt;version&gt;0.3.0&lt;/version&gt;
&lt;configuration&gt;
&lt;jreleaser&gt;
&lt;project&gt;
@@ -569,7 +594,7 @@ dependencies and generates launcher scripts.</p>
[INFO] Building zip: /Home/duke/app/target/distributions/app/app-1.0.0.zip
[INFO] Copying files to /Home/duke/app/target/distributions/app/app-1.0.0
[INFO]
[INFO] --- jreleaser-maven-plugin:0.2.0:full-release (default-cli) @ app ---
[INFO] --- jreleaser-maven-plugin:0.3.0:full-release (default-cli) @ app ---
[INFO] Loading properties from /Home/duke/.jreleaser/config.properties
[INFO] Validating configuration
[INFO] Project version set to 1.0.0
@@ -582,6 +607,7 @@ dependencies and generates launcher scripts.</p>
[INFO] [checksum] target/distributions/app/app-1.0.0.zip
[INFO] Signing files
[INFO] Signing is not enabled. Skipping
[INFO] Uploading is not enabled. Skipping.
[INFO] Releasing to https://github.com/duke/app
[INFO] - Uploading app-1.0.0.zip
[INFO] - Uploading checksums.txt
@@ -589,8 +615,8 @@ dependencies and generates launcher scripts.</p>
[INFO] - Preparing app distribution
[INFO] Packaging distributions
[INFO] - Packaging app distribution
[INFO] Uploading distributions
[INFO] - Uploading app distribution
[INFO] Publishing distributions
[INFO] - Publishing app distribution
[INFO] Announcing release
[INFO] Announcing is not enabled. Skipping.
[INFO] JReleaser succeeded after 0.894s

49
guide/latest/templates/mustache.html
View File

@@ -94,7 +94,7 @@
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../artifacts.html">Artifacts</a>
<a class="nav-link" href="../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
@@ -162,6 +162,15 @@
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/packagers/snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../configuration/upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
@@ -243,6 +252,12 @@
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
@@ -254,43 +269,53 @@
<a class="nav-link" href="../tools/index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/cli.html">JReleaser CLI</a>
<a class="nav-link" href="../tools/jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/maven.html">JReleaser Maven Plugin</a>
<a class="nav-link" href="../tools/jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/gradle.html">JReleaser Gradle Plugin</a>
<a class="nav-link" href="../tools/jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/ant.html">JReleaser Ant Tasks</a>
<a class="nav-link" href="../tools/jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/tool-provider.html">JReleaser Tool Provider</a>
<a class="nav-link" href="../tools/jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/docker.html">JReleaser Docker Image</a>
<a class="nav-link" href="../tools/jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Examples</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">

53
guide/latest/templates/templates.html
View File

@@ -94,7 +94,7 @@
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../artifacts.html">Artifacts</a>
<a class="nav-link" href="../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
@@ -162,6 +162,15 @@
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/packagers/snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../configuration/upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
@@ -243,6 +252,12 @@
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
@@ -254,43 +269,53 @@
<a class="nav-link" href="../tools/index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/cli.html">JReleaser CLI</a>
<a class="nav-link" href="../tools/jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/maven.html">JReleaser Maven Plugin</a>
<a class="nav-link" href="../tools/jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/gradle.html">JReleaser Gradle Plugin</a>
<a class="nav-link" href="../tools/jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/ant.html">JReleaser Ant Tasks</a>
<a class="nav-link" href="../tools/jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/tool-provider.html">JReleaser Tool Provider</a>
<a class="nav-link" href="../tools/jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/docker.html">JReleaser Docker Image</a>
<a class="nav-link" href="../tools/jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../tools/jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Examples</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
@@ -363,8 +388,8 @@ expected by each packager, or by pointing the packager to a different template s
</div>
<div class="paragraph">
<p>Template files may be generated using the appropriate command exposed by your tool of choice:
<a href="../tools/cli.html#_template" class="page">CLI</a>, <a href="../tools/maven.html#_jreleasertemplate" class="page">Maven</a>,
<a href="../tools/gradle.html#_jreleasertemplate" class="page">Gradle</a>, <a href="../tools/ant.html#_jreleaser_template" class="page">Ant</a>.</p>
<a href="../tools/jreleaser-cli.html#_template" class="page">CLI</a>, <a href="../tools/jreleaser-maven.html#_jreleasertemplate" class="page">Maven</a>,
<a href="../tools/jreleaser-gradle.html#_jreleasertemplate" class="page">Gradle</a>, <a href="../tools/jreleaser-ant.html#_jreleaser_template" class="page">Ant</a>.</p>
</div>
<div class="paragraph">
<p>Some configuration elements let you define custom properties that may be used as placeholders, for example</p>

79
guide/latest/tools/index.html
View File

@@ -94,7 +94,7 @@
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../artifacts.html">Artifacts</a>
<a class="nav-link" href="../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
@@ -162,6 +162,15 @@
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/packagers/snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../configuration/upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
@@ -243,6 +252,12 @@
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
@@ -254,43 +269,53 @@
<a class="nav-link" href="index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="cli.html">JReleaser CLI</a>
<a class="nav-link" href="jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="maven.html">JReleaser Maven Plugin</a>
<a class="nav-link" href="jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="gradle.html">JReleaser Gradle Plugin</a>
<a class="nav-link" href="jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="ant.html">JReleaser Ant Tasks</a>
<a class="nav-link" href="jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="tool-provider.html">JReleaser Tool Provider</a>
<a class="nav-link" href="jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="docker.html">JReleaser Docker Image</a>
<a class="nav-link" href="jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Examples</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
@@ -347,22 +372,40 @@ The following options are currently available:</p>
<div class="ulist">
<ul>
<li>
<p><a href="cli.html" class="page">JReleaser CLI</a></p>
<p><a href="jreleaser-cli.html" class="page">JReleaser CLI</a></p>
</li>
<li>
<p><a href="maven.html" class="page">JReleaser Maven Plugin</a></p>
<p><a href="jreleaser-maven.html" class="page">JReleaser Maven Plugin</a></p>
</li>
<li>
<p><a href="gradle.html" class="page">JReleaser Gradle Plugin</a></p>
<p><a href="jreleaser-gradle.html" class="page">JReleaser Gradle Plugin</a></p>
</li>
<li>
<p><a href="ant.html" class="page">JReleaser Ant Tasks</a></p>
<p><a href="jreleaser-ant.html" class="page">JReleaser Ant Tasks</a></p>
</li>
<li>
<p><a href="tool-provider.html" class="page">JReleaser Tool Provider</a></p>
<p><a href="jreleaser-tool-provider.html" class="page">JReleaser Tool Provider</a></p>
</li>
<li>
<p><a href="docker.html" class="page">JReleaser Docker Image</a></p>
<p><a href="jreleaser-docker.html" class="page">JReleaser Docker Image</a></p>
</li>
</ul>
</div>
<div class="paragraph">
<p>Some features require additional JDKs to be readily available, such as assembling cross-platform
<a href="../distributions/jlink.html" class="page">Jlink</a> Java Runtimes or assembling <a href="../distributions/native-image.html" class="page">Native Image</a>
binaries with GraalVM.</p>
</div>
<div class="paragraph">
<p>The following options may be used to download, verify, and unpack JDK/GraalVM distributions</p>
</div>
<div class="ulist">
<ul>
<li>
<p><a href="jdks-maven.html" class="page">JDKs Maven Plugin</a></p>
</li>
<li>
<p><a href="jdks-gradle.html" class="page">JDKs Gradle Plugin</a></p>
</li>
</ul>
</div>

689
guide/latest/tools/jdks-gradle.html Normal file
View File

@@ -0,0 +1,689 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>JDKs Gradle Plugin :: JReleaser</title>
<link rel="canonical" href="https://jreleaser.org/guide/latest/tools/jdks-gradle.html">
<meta name="generator" content="Antora 2.3.4">
<link rel="stylesheet" href="../../../_/css/site.css">
<link rel="stylesheet" href="../../../_/css/admonitions.css">
<link rel="stylesheet" href="../../../_/css/fontawesome.css">
<link rel="stylesheet" href="../../../_/css/all.css">
<script>var uiRootPath = '../../../_'</script>
</head>
<body class="article">
<header class="header">
<nav class="navbar">
<div class="navbar-brand">
<a class="navbar-item" href="https://jreleaser.org">JReleaser</a>
<button class="navbar-burger" data-target="topbar-nav">
<span></span>
<span></span>
<span></span>
</button>
</div>
</nav>
</header>
<div class="body">
<div class="nav-container" data-component="guide" data-version="latest">
<aside class="nav">
<div class="panels">
<div class="nav-panel-menu is-active" data-panel="menu">
<nav class="nav-menu">
<h3 class="title"><a href="../index.html">JReleaser</a></h3>
<ul class="nav-list">
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../install.html">Install</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../quick-start/index.html">Quick Start</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../quick-start/cli.html">Command Line</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../quick-start/maven.html">Apache Maven</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../quick-start/gradle.html">Gradle</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../quick-start/ant.html">Apache Ant</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../workflow.html">Workflow</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../distributions/index.html">Distributions</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../distributions/java-binary.html">Java Binary</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../distributions/single-jar.html">Single JAR</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../distributions/jlink.html">Jlink</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../distributions/native-image.html">Native Image</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../configuration/index.html">Configuration</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../configuration/environment.html">Environment</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../configuration/project.html">Project</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../configuration/signing.html">Signing</a>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../configuration/release/index.html">Release</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/release/github.html">GitHub</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/release/gitlab.html">GitLab</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/release/gitea.html">Gitea</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../configuration/assemble/index.html">Assemble</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/assemble/jlink.html">Jlink</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/assemble/native-image.html">Native Image</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../configuration/packagers/index.html">Packagers</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/packagers/chocolatey.html">Chocolatey</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/packagers/docker.html">Docker</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/packagers/homebrew.html">Homebrew</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/packagers/jbang.html">Jbang</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/packagers/scoop.html">Scoop</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/packagers/snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../configuration/upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../configuration/distributions.html">Distributions</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../configuration/files.html">Files</a>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../configuration/announce/index.html">Announce</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/announce/discord.html">Discord</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/announce/discussions.html">GitHub Discussions</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/announce/gitter.html">Gitter</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/announce/mail.html">Mail</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/announce/sdkman.html">Sdkman</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/announce/slack.html">Slack</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/announce/teams.html">Teams</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/announce/twitter.html">Twitter</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/announce/zulip.html">Zulip</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../configuration/name-templates.html">Name Templates</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Templates</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../templates/templates.html">Template Basics</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../templates/mustache.html">Mustache Primer</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../continuous-integration/index.html">Continuous Integration</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/github-actions.html">GitHub Actions</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/jenkins.html">Jenkins</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/circle-ci.html">Circle CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/codefresh.html">Codefresh</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item is-current-page" data-depth="2">
<a class="nav-link" href="jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../links.html">Links</a>
</li>
</ul>
</li>
</ul>
</nav>
</div>
<div class="nav-panel-explore" data-panel="explore">
<div class="context">
<span class="title">JReleaser</span>
<span class="version">latest</span>
</div>
<ul class="components">
<li class="component is-current">
<a class="title" href="../index.html">JReleaser</a>
<ul class="versions">
<li class="version is-current is-latest">
<a href="../index.html">latest</a>
</li>
</ul>
</li>
</ul>
</div>
</div>
</aside>
</div>
<main class="article">
<div class="toolbar" role="navigation">
<button class="nav-toggle"></button>
<a href="../index.html" class="home-link"></a>
<nav class="breadcrumbs" aria-label="breadcrumbs">
<ul>
<li><a href="../index.html">JReleaser</a></li>
<li><a href="index.html">Tools</a></li>
<li><a href="jdks-gradle.html">JDKs Gradle Plugin</a></li>
</ul>
</nav>
<div class="edit-this-page"><a href="https://github.com/jreleaser/jreleaser.github.io/edit/main/docs/modules/tools/pages/jdks-gradle.adoc">Edit this Page</a></div>
</div>
<div class="content">
<aside class="toc sidebar" data-title="Contents" data-levels="2">
<div class="toc-menu"></div>
</aside>
<article class="doc">
<h1 class="page">JDKs Gradle Plugin</h1>
<div id="preamble">
<div class="sectionbody">
<div class="paragraph">
<p>Downloads JDK distributions.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_install"><a class="anchor" href="#_install"></a>Install</h2>
<div class="sectionbody">
<div class="listingblock">
<div class="title">build.gradle</div>
<div class="content">
<pre class="highlightjs highlight"><code class="language-groovy hljs" data-lang="groovy">plugins {
id 'org.jreleaser.jdks' version '0.3.0'
}</code></pre>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_configuration_dsl"><a class="anchor" href="#_configuration_dsl"></a>Configuration DSL</h2>
<div class="sectionbody">
<div class="paragraph">
<p>JDKS must define the following properties:</p>
</div>
<div class="ulist">
<ul>
<li>
<p><code>name</code>: a user defined name, must be unique.</p>
</li>
<li>
<p><code>url</code>: the URL from where the JDK can be downloaded.</p>
</li>
<li>
<p><code>checksum</code>: the checksum value used to verify the archive&#8217;s integrity.</p>
</li>
<li>
<p><code>platform</code>: the platform this JDK is related to.</p>
</li>
</ul>
</div>
<div class="paragraph">
<p>The <code>checksum</code> property accepts thew following formats:</p>
</div>
<div class="ulist">
<ul>
<li>
<p><code>&lt;algorithm&gt;/&lt;checksum&gt;</code></p>
</li>
<li>
<p><code>&lt;checksum&gt;</code></p>
</li>
</ul>
</div>
<div class="paragraph">
<p>The value of <code>&lt;algorithm&gt;</code> must match those specified at
<a href="https://docs.oracle.com/en/java/javase/11/docs/specs/security/standard-names.html#messagedigest-algorithms">MessageDigest section</a>
in the Java Security Standard Algorithm Names Specification. If no value for <code>&lt;algorithm&gt;</code> is given then <code>SHA-256</code> is assumed.</p>
</div>
<div class="paragraph">
<p>The value of <code>platform</code> is dictated by the normalized values detected by
<a href="https://github.com/trustin/os-maven-plugin">os-maven-plugin</a>. You may use the plain <code>platform</code> value or append a
<code>arch</code> classifier. The following values are currently recognized:</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">platform</dt>
<dd>
<p><code>aix</code>, <code>hpux</code>, <code>os400</code>, <code>linux</code>, <code>osx</code>, <code>freebsd</code>, <code>openbsd</code>, <code>netbsd</code>, <code>sunos</code>, <code>windows</code>, <code>zos</code>.</p>
</dd>
<dt class="hdlist1">arch</dt>
<dd>
<p><code>x86_64</code>, <code>x86_32</code>, <code>itanium_64</code>, <code>itanium_32</code>, <code>sparc_32</code>, <code>sparc_64</code>, <code>arm_32</code>, <code>aarch_64</code>, <code>mips_32</code>,
<code>mipsel_32</code>, <code>mips_64</code>, <code>mipsel_64</code>, <code>ppc_32</code>, <code>ppcle_32</code>, <code>ppc_64</code>, <code>ppcle_64</code>, <code>s390_32</code>, <code>s390_64</code>, <code>riscv</code></p>
</dd>
</dl>
</div>
<div class="paragraph">
<p>Examples:</p>
</div>
<div class="ulist">
<ul>
<li>
<p><code>osx</code></p>
</li>
<li>
<p><code>osx-arm</code></p>
</li>
<li>
<p><code>windows</code></p>
</li>
<li>
<p><code>linux</code></p>
</li>
<li>
<p><code>linux-x86_64</code></p>
</li>
</ul>
</div>
<div class="paragraph">
<p>Here&#8217;s an example configuration</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-groovy hljs" data-lang="groovy">jdks {
zulu11Linux {
platform = 'linux'
url = 'https://cdn.azul.com/zulu/bin/zulu11.48.21-ca-jdk11.0.11-linux_x64.zip'
checksum = '9d1718ef74c29a8148b67ddd90bc9267fc1614e0a1eb0f4ea16e234e86419a60'
}
zulu11Windows {
platform = 'windows'
url = 'https://cdn.azul.com/zulu/bin/zulu11.48.21-ca-jdk11.0.11-win_x64.zip'
checksum = '7bcbaedecca73811f70a5ee89e9258afff9bc009286449d97d9b3105f52a1a3a'
}
zulu11Osx {
platform = 'osx'
url = 'https://cdn.azul.com/zulu/bin/zulu11.48.21-ca-jdk11.0.11-macosx_x64.zip'
checksum = 'abc3a9696fb6c10efcf3c5878cdb049244b0ba5dcc7141c6f0f88b99df626d2a'
}
graal21_1_0_linux {
platform = 'linux'
url = 'https://github.com/graalvm/graalvm-ce-builds/releases/download/vm-21.1.0/graalvm-ce-java11-linux-amd64-21.1.0.tar.gz'
checksum = '39252954d2cb16dbc8ce4269f8b93a326a0efffdce04625615e827fe5b5e4ab7'
}
}</code></pre>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_tasks"><a class="anchor" href="#_tasks"></a>Tasks</h2>
<div class="sectionbody">
<div class="paragraph">
<p>The following tasks are provided per JDK</p>
</div>
<div class="sect2">
<h3 id="_downloadjdkname"><a class="anchor" href="#_downloadjdkname"></a>downloadJdk&lt;name&gt;</h3>
<div class="paragraph">
<p>Downloads a JDK with a matching name.</p>
</div>
</div>
<div class="sect2">
<h3 id="_verifyjdkname"><a class="anchor" href="#_verifyjdkname"></a>verifyJdk&lt;name&gt;</h3>
<div class="paragraph">
<p>Verifies the integrity of the JDK archive with a matching name.</p>
</div>
</div>
<div class="sect2">
<h3 id="_downloadjdkname_2"><a class="anchor" href="#_downloadjdkname_2"></a>downloadJdk&lt;name&gt;</h3>
<div class="paragraph">
<p>Unpacks the JDK archive with a matching name.</p>
</div>
<div class="paragraph">
<p>The following tasks are provided for all JDKS</p>
</div>
</div>
<div class="sect2">
<h3 id="_downloadjdks"><a class="anchor" href="#_downloadjdks"></a>downloadJdks</h3>
<div class="paragraph">
<p>Downloads all configured JDKS.</p>
</div>
</div>
<div class="sect2">
<h3 id="_verifyjdks"><a class="anchor" href="#_verifyjdks"></a>verifyJdks</h3>
<div class="paragraph">
<p>Verifies all configured JDKS.</p>
</div>
</div>
<div class="sect2">
<h3 id="_unpackjdks"><a class="anchor" href="#_unpackjdks"></a>unpackJdks</h3>
<div class="paragraph">
<p>Unpacks all configured JDKS.</p>
</div>
</div>
<div class="sect2">
<h3 id="_setupjdks"><a class="anchor" href="#_setupjdks"></a>setupJdks</h3>
<div class="paragraph">
<p>Downloads, verifies, and unpacks all configured JDKS.</p>
</div>
</div>
<div class="sect2">
<h3 id="_listjdks"><a class="anchor" href="#_listjdks"></a>listJdks</h3>
<div class="paragraph">
<p>Lists all configured JDKS.</p>
</div>
</div>
<div class="sect2">
<h3 id="_copyjdkstocache"><a class="anchor" href="#_copyjdkstocache"></a>copyJdksToCache</h3>
<div class="paragraph">
<p>Copies all JDK archives to the Gradle cache directory.</p>
</div>
</div>
<div class="sect2">
<h3 id="_copyjdksfromcache"><a class="anchor" href="#_copyjdksfromcache"></a>copyJdksFromCache</h3>
<div class="paragraph">
<p>Copies all JDK archives from the Gradle cache directory to the build directory.</p>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_examples"><a class="anchor" href="#_examples"></a>Examples</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Listing all JDKS</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code>$ gm listJdks
&gt; Task :listJdks
== JDK graal21_1_0_linux ==
url: https://github.com/graalvm/graalvm-ce-builds/releases/download/vm-21.1.0/graalvm-ce-java11-linux-amd64-21.1.0.tar.gz
checksum: 39252954d2cb16dbc8ce4269f8b93a326a0efffdce04625615e827fe5b5e4ab7
platform: linux
== JDK zulu11Linux ==
url: https://cdn.azul.com/zulu/bin/zulu11.48.21-ca-jdk11.0.11-linux_x64.zip
checksum: 9d1718ef74c29a8148b67ddd90bc9267fc1614e0a1eb0f4ea16e234e86419a60
platform: linux
== JDK zulu11Osx ==
url: https://cdn.azul.com/zulu/bin/zulu11.48.21-ca-jdk11.0.11-macosx_x64.zip
checksum: abc3a9696fb6c10efcf3c5878cdb049244b0ba5dcc7141c6f0f88b99df626d2a
platform: osx
== JDK zulu11Windows ==
url: https://cdn.azul.com/zulu/bin/zulu11.48.21-ca-jdk11.0.11-win_x64.zip
checksum: 7bcbaedecca73811f70a5ee89e9258afff9bc009286449d97d9b3105f52a1a3a
platform: windows</code></pre>
</div>
</div>
<div class="paragraph">
<p>Setup all JDKS</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code>$ gm setuJdks
&gt; Task :downloadJdkGraal21_1_0_linux
Download https://github.com/graalvm/graalvm-ce-builds/releases/download/vm-21.1.0/graalvm-ce-java11-linux-amd64-21.1.0.tar.gz
&gt; Task :downloadJdkZulu11Linux
Download https://cdn.azul.com/zulu/bin/zulu11.48.21-ca-jdk11.0.11-linux_x64.zip
&gt; Task :downloadJdkZulu11Osx
Download https://cdn.azul.com/zulu/bin/zulu11.48.21-ca-jdk11.0.11-macosx_x64.zip
&gt; Task :downloadJdkZulu11Windows
Download https://cdn.azul.com/zulu/bin/zulu11.48.21-ca-jdk11.0.11-win_x64.zip
&gt; Task :downloadJdks
&gt; Task :verifyJdkGraal21_1_0_linux
&gt; Task :unpackJdkGraal21_1_0_linux
&gt; Task :verifyJdkZulu11Linux
&gt; Task :unpackJdkZulu11Linux
&gt; Task :verifyJdkZulu11Osx
&gt; Task :unpackJdkZulu11Osx
&gt; Task :verifyJdkZulu11Windows
&gt; Task :unpackJdkZulu11Windows
&gt; Task :unpackJdks
&gt; Task :verifyJdks
&gt; Task :setupJdks
&gt; Task :copyJdksToCache</code></pre>
</div>
</div>
<div class="paragraph">
<p>All tasks are added to the <code>JDKS</code> group</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code>$ gm tasks --group=JDKS
&gt; Task :tasks
------------------------------------------------------------
Tasks runnable from root project 'app'
------------------------------------------------------------
Jdks tasks
----------
copyJdksFromCache - Copy JDKs from Gradle cache
copyJdksToCache - Copy JDKs to Gradle cache
downloadJdkGraal21_1_0_linux - Download JDK graal21_1_0_linux
downloadJdks - Download all JDKs
downloadJdkZulu11Linux - Download JDK zulu11Linux
downloadJdkZulu11Osx - Download JDK zulu11Osx
downloadJdkZulu11Windows - Download JDK zulu11Windows
listJdks - Lists all JDKs
setupJdks - Setups all JDKs
unpackJdkGraal21_1_0_linux - Unpack JDK graal21_1_0_linux
unpackJdks - Unpack all JDKs
unpackJdkZulu11Linux - Unpack JDK zulu11Linux
unpackJdkZulu11Osx - Unpack JDK zulu11Osx
unpackJdkZulu11Windows - Unpack JDK zulu11Windows
verifyJdkGraal21_1_0_linux - Verify JDK graal21_1_0_linux
verifyJdks - Verify all JDKs
verifyJdkZulu11Linux - Verify JDK zulu11Linux
verifyJdkZulu11Osx - Verify JDK zulu11Osx
verifyJdkZulu11Windows - Verify JDK zulu11Windows</code></pre>
</div>
</div>
</div>
</div>
</article>
</div>
</main>
</div>
<footer class="footer">
<p>Copyright (C) 2021 Andres Almiray. This page was built using an adapted version of the Antora default UI.</p>
<p>The source code for this UI is licensed under the <a href="https://www.mozilla.org/en-US/MPL/2.0/">Mozilla Public License Version 2.0</a> (MPL-2.0).</p>
</footer>
<!--script src="../../../_/js/fontawesome.js"></script>
<script src="../../../_/js/all.js"></script-->
<script src="../../../_/js/site.js"></script>
<script async src="../../../_/js/vendor/highlight.js"></script>
</body>
</html>

622
guide/latest/tools/jdks-maven.html Normal file
View File

@@ -0,0 +1,622 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>JDKs Maven Plugin :: JReleaser</title>
<link rel="canonical" href="https://jreleaser.org/guide/latest/tools/jdks-maven.html">
<meta name="generator" content="Antora 2.3.4">
<link rel="stylesheet" href="../../../_/css/site.css">
<link rel="stylesheet" href="../../../_/css/admonitions.css">
<link rel="stylesheet" href="../../../_/css/fontawesome.css">
<link rel="stylesheet" href="../../../_/css/all.css">
<script>var uiRootPath = '../../../_'</script>
</head>
<body class="article">
<header class="header">
<nav class="navbar">
<div class="navbar-brand">
<a class="navbar-item" href="https://jreleaser.org">JReleaser</a>
<button class="navbar-burger" data-target="topbar-nav">
<span></span>
<span></span>
<span></span>
</button>
</div>
</nav>
</header>
<div class="body">
<div class="nav-container" data-component="guide" data-version="latest">
<aside class="nav">
<div class="panels">
<div class="nav-panel-menu is-active" data-panel="menu">
<nav class="nav-menu">
<h3 class="title"><a href="../index.html">JReleaser</a></h3>
<ul class="nav-list">
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../install.html">Install</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../quick-start/index.html">Quick Start</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../quick-start/cli.html">Command Line</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../quick-start/maven.html">Apache Maven</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../quick-start/gradle.html">Gradle</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../quick-start/ant.html">Apache Ant</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../workflow.html">Workflow</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../distributions/index.html">Distributions</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../distributions/java-binary.html">Java Binary</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../distributions/single-jar.html">Single JAR</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../distributions/jlink.html">Jlink</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../distributions/native-image.html">Native Image</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../configuration/index.html">Configuration</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../configuration/environment.html">Environment</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../configuration/project.html">Project</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../configuration/signing.html">Signing</a>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../configuration/release/index.html">Release</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/release/github.html">GitHub</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/release/gitlab.html">GitLab</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/release/gitea.html">Gitea</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../configuration/assemble/index.html">Assemble</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/assemble/jlink.html">Jlink</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/assemble/native-image.html">Native Image</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../configuration/packagers/index.html">Packagers</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/packagers/chocolatey.html">Chocolatey</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/packagers/docker.html">Docker</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/packagers/homebrew.html">Homebrew</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/packagers/jbang.html">Jbang</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/packagers/scoop.html">Scoop</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/packagers/snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../configuration/upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../configuration/distributions.html">Distributions</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../configuration/files.html">Files</a>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../configuration/announce/index.html">Announce</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/announce/discord.html">Discord</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/announce/discussions.html">GitHub Discussions</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/announce/gitter.html">Gitter</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/announce/mail.html">Mail</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/announce/sdkman.html">Sdkman</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/announce/slack.html">Slack</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/announce/teams.html">Teams</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/announce/twitter.html">Twitter</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/announce/zulip.html">Zulip</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../configuration/name-templates.html">Name Templates</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Templates</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../templates/templates.html">Template Basics</a>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../templates/mustache.html">Mustache Primer</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../continuous-integration/index.html">Continuous Integration</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/github-actions.html">GitHub Actions</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/jenkins.html">Jenkins</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/circle-ci.html">Circle CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/codefresh.html">Codefresh</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item is-current-page" data-depth="2">
<a class="nav-link" href="jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../links.html">Links</a>
</li>
</ul>
</li>
</ul>
</nav>
</div>
<div class="nav-panel-explore" data-panel="explore">
<div class="context">
<span class="title">JReleaser</span>
<span class="version">latest</span>
</div>
<ul class="components">
<li class="component is-current">
<a class="title" href="../index.html">JReleaser</a>
<ul class="versions">
<li class="version is-current is-latest">
<a href="../index.html">latest</a>
</li>
</ul>
</li>
</ul>
</div>
</div>
</aside>
</div>
<main class="article">
<div class="toolbar" role="navigation">
<button class="nav-toggle"></button>
<a href="../index.html" class="home-link"></a>
<nav class="breadcrumbs" aria-label="breadcrumbs">
<ul>
<li><a href="../index.html">JReleaser</a></li>
<li><a href="index.html">Tools</a></li>
<li><a href="jdks-maven.html">JDKs Maven Plugin</a></li>
</ul>
</nav>
<div class="edit-this-page"><a href="https://github.com/jreleaser/jreleaser.github.io/edit/main/docs/modules/tools/pages/jdks-maven.adoc">Edit this Page</a></div>
</div>
<div class="content">
<aside class="toc sidebar" data-title="Contents" data-levels="2">
<div class="toc-menu"></div>
</aside>
<article class="doc">
<h1 class="page">JDKs Maven Plugin</h1>
<div id="preamble">
<div class="sectionbody">
<div class="paragraph">
<p>Downloads JDK distributions.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_install"><a class="anchor" href="#_install"></a>Install</h2>
<div class="sectionbody">
<div class="listingblock">
<div class="title">pom.xml</div>
<div class="content">
<pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml">&lt;plugin&gt;
&lt;groupId&gt;org.jreleaser&lt;/groupId&gt;
&lt;artifactId&gt;jdks-maven-plugin&lt;/artifactId&gt;
&lt;version&gt;0.3.0&lt;/version&gt;
&lt;/plugin&gt;</code></pre>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_configuration_dsl"><a class="anchor" href="#_configuration_dsl"></a>Configuration DSL</h2>
<div class="sectionbody">
<div class="paragraph">
<p>JDKS must define the following properties:</p>
</div>
<div class="ulist">
<ul>
<li>
<p><code>name</code>: a user defined name, must be unique.</p>
</li>
<li>
<p><code>url</code>: the URL from where the JDK can be downloaded.</p>
</li>
<li>
<p><code>checksum</code>: the checksum value used to verify the archive&#8217;s integrity.</p>
</li>
<li>
<p><code>platform</code>: the platform this JDK is related to.</p>
</li>
</ul>
</div>
<div class="paragraph">
<p>The <code>checksum</code> property accepts thew following formats:</p>
</div>
<div class="ulist">
<ul>
<li>
<p><code>&lt;algorithm&gt;/&lt;checksum&gt;</code></p>
</li>
<li>
<p><code>&lt;checksum&gt;</code></p>
</li>
</ul>
</div>
<div class="paragraph">
<p>The value of <code>&lt;algorithm&gt;</code> must match those specified at
<a href="https://docs.oracle.com/en/java/javase/11/docs/specs/security/standard-names.html#messagedigest-algorithms">MessageDigest section</a>
in the Java Security Standard Algorithm Names Specification. If no value for <code>&lt;algorithm&gt;</code> is given then <code>SHA-256</code> is assumed.</p>
</div>
<div class="paragraph">
<p>The value of <code>platform</code> is dictated by the normalized values detected by
<a href="https://github.com/trustin/os-maven-plugin">os-maven-plugin</a>. You may use the plain <code>platform</code> value or append a
<code>arch</code> classifier. The following values are currently recognized:</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">platform</dt>
<dd>
<p><code>aix</code>, <code>hpux</code>, <code>os400</code>, <code>linux</code>, <code>osx</code>, <code>freebsd</code>, <code>openbsd</code>, <code>netbsd</code>, <code>sunos</code>, <code>windows</code>, <code>zos</code>.</p>
</dd>
<dt class="hdlist1">arch</dt>
<dd>
<p><code>x86_64</code>, <code>x86_32</code>, <code>itanium_64</code>, <code>itanium_32</code>, <code>sparc_32</code>, <code>sparc_64</code>, <code>arm_32</code>, <code>aarch_64</code>, <code>mips_32</code>,
<code>mipsel_32</code>, <code>mips_64</code>, <code>mipsel_64</code>, <code>ppc_32</code>, <code>ppcle_32</code>, <code>ppc_64</code>, <code>ppcle_64</code>, <code>s390_32</code>, <code>s390_64</code>, <code>riscv</code></p>
</dd>
</dl>
</div>
<div class="paragraph">
<p>Examples:</p>
</div>
<div class="ulist">
<ul>
<li>
<p><code>osx</code></p>
</li>
<li>
<p><code>osx-arm</code></p>
</li>
<li>
<p><code>windows</code></p>
</li>
<li>
<p><code>linux</code></p>
</li>
<li>
<p><code>linux-x86_64</code></p>
</li>
</ul>
</div>
<div class="paragraph">
<p>Here&#8217;s an example configuration</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml">&lt;plugin&gt;
&lt;groupId&gt;org.jreleaser&lt;/groupId&gt;
&lt;artifactId&gt;jdks-maven-plugin&lt;/artifactId&gt;
&lt;version&gt;0.3.0&lt;/version&gt;
&lt;configuration&gt;
&lt;jdks&gt;
&lt;jdk&gt;
&lt;name&gt;zulu11Linux&lt;/name&gt;
&lt;platform&gt;linux&lt;/platform&gt;
&lt;url&gt;https://cdn.azul.com/zulu/bin/zulu11.48.21-ca-jdk11.0.11-linux_x64.zip&lt;/url&gt;
&lt;checksum&gt;9d1718ef74c29a8148b67ddd90bc9267fc1614e0a1eb0f4ea16e234e86419a60&lt;/checksum&gt;
&lt;/jdk&gt;
&lt;jdk&gt;
&lt;name&gt;zulu11Windows&lt;/name&gt;
&lt;platform&gt;windows&lt;/platform&gt;
&lt;url&gt;https://cdn.azul.com/zulu/bin/zulu11.48.21-ca-jdk11.0.11-win_x64.zip&lt;/url&gt;
&lt;checksum&gt;7bcbaedecca73811f70a5ee89e9258afff9bc009286449d97d9b3105f52a1a3a&lt;/checksum&gt;
&lt;/jdk&gt;
&lt;jdk&gt;
&lt;name&gt;zulu11Osx&lt;/name&gt;
&lt;platform&gt;osx&lt;/platform&gt;
&lt;url&gt;https://cdn.azul.com/zulu/bin/zulu11.48.21-ca-jdk11.0.11-macosx_x64.zip&lt;/url&gt;
&lt;checksum&gt;abc3a9696fb6c10efcf3c5878cdb049244b0ba5dcc7141c6f0f88b99df626d2a&lt;/checksum&gt;
&lt;/jdk&gt;
&lt;jdk&gt;
&lt;name&gt;graal21.1.0-linux&lt;/name&gt;
&lt;platform&gt;linux&lt;/platform&gt;
&lt;url&gt;https://github.com/graalvm/graalvm-ce-builds/releases/download/vm-21.1.0/graalvm-ce-java11-linux-amd64-21.1.0.tar.gz&lt;/url&gt;
&lt;checksum&gt;39252954d2cb16dbc8ce4269f8b93a326a0efffdce04625615e827fe5b5e4ab7&lt;/checksum&gt;
&lt;/jdk&gt;
&lt;/jdks&gt;
&lt;/configuration&gt;
&lt;/plugin&gt;</code></pre>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_goals"><a class="anchor" href="#_goals"></a>Goals</h2>
<div class="sectionbody">
<div class="paragraph">
<p>None of the exposed MOJOs are bound to a specific life-cycle phase, letting you decide when and how that
should happen in your build.</p>
</div>
<div class="paragraph">
<p>The following MOJOs are provided:</p>
</div>
<div class="sect2">
<h3 id="_jreleaserlist_jdks"><a class="anchor" href="#_jreleaserlist_jdks"></a>jreleaser:list-jdks</h3>
<div class="paragraph">
<p>Lists all configured JDKS.</p>
</div>
</div>
<div class="sect2">
<h3 id="_jreleasersetup_jdks"><a class="anchor" href="#_jreleasersetup_jdks"></a>jreleaser:setup-jdks</h3>
<div class="paragraph">
<p>Downloads, verifies, and unpacks JDKs.</p>
</div>
<div class="paragraph">
<p>Available parameters:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>jdkName<br>
The name of the JDK to be downloaded.<br>
Type: String<br>
User property: <code>jdk.name</code></p>
</li>
<li>
<p>outputDirectory (Default: ${project.build.directory}/jdks)<br>
Type: File<br>
User property: <code>jdks.output.directory</code></p>
</li>
<li>
<p>skip<br>
Skip execution.<br>
Type: boolean<br>
User property: <code>jdks.setup.skip</code></p>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_examples"><a class="anchor" href="#_examples"></a>Examples</h2>
<div class="sectionbody">
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code>[INFO] --- jdks-maven-plugin:0.3.0:list-jdks (default-cli) @ app ---
[INFO] == JDK zulu11Linux ==
[INFO] url: https://cdn.azul.com/zulu/bin/zulu11.48.21-ca-jdk11.0.11-linux_x64.zip
[INFO] checksum: 9d1718ef74c29a8148b67ddd90bc9267fc1614e0a1eb0f4ea16e234e86419a60
[INFO] platform: linux
[INFO]
[INFO] == JDK zulu11Windows ==
[INFO] url: https://cdn.azul.com/zulu/bin/zulu11.48.21-ca-jdk11.0.11-win_x64.zip
[INFO] checksum: 7bcbaedecca73811f70a5ee89e9258afff9bc009286449d97d9b3105f52a1a3a
[INFO] platform: windows
[INFO]
[INFO] == JDK zulu11Osx ==
[INFO] url: https://cdn.azul.com/zulu/bin/zulu11.48.21-ca-jdk11.0.11-macosx_x64.zip
[INFO] checksum: abc3a9696fb6c10efcf3c5878cdb049244b0ba5dcc7141c6f0f88b99df626d2a
[INFO] platform: osx
[INFO]
[INFO] == JDK graal21.1.0-linux ==
[INFO] url: https://github.com/graalvm/graalvm-ce-builds/releases/download/vm-21.1.0/graalvm-ce-java11-linux-amd64-21.1.0.tar.gz
[INFO] checksum: 39252954d2cb16dbc8ce4269f8b93a326a0efffdce04625615e827fe5b5e4ab7
[INFO] platform: linux</code></pre>
</div>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code>[INFO] --- jdks-maven-plugin:0.3.0:setup-jdks (default-cli) @ app ---
[INFO] Downloading https://cdn.azul.com/zulu/bin/zulu11.48.21-ca-jdk11.0.11-linux_x64.zip
[INFO] Verifying zulu11.48.21-ca-jdk11.0.11-linux_x64.zip
[INFO] Extracting zulu11.48.21-ca-jdk11.0.11-linux_x64.zip
[INFO] Downloading https://cdn.azul.com/zulu/bin/zulu11.48.21-ca-jdk11.0.11-win_x64.zip
[INFO] Verifying zulu11.48.21-ca-jdk11.0.11-win_x64.zip
[INFO] Extracting zulu11.48.21-ca-jdk11.0.11-win_x64.zip
[INFO] Downloading https://cdn.azul.com/zulu/bin/zulu11.48.21-ca-jdk11.0.11-macosx_x64.zip
[INFO] Verifying zulu11.48.21-ca-jdk11.0.11-macosx_x64.zip
[INFO] Extracting zulu11.48.21-ca-jdk11.0.11-macosx_x64.zip
[INFO] Downloading https://github.com/graalvm/graalvm-ce-builds/releases/download/vm-21.1.0/graalvm-ce-java11-linux-amd64-21.1.0.tar.gz
[INFO] Verifying graalvm-ce-java11-linux-amd64-21.1.0.tar.gz
[INFO] Extracting graalvm-ce-java11-linux-amd64-21.1.0.tar.gz
[INFO] Expanding: /Users/aalmiray/tmp/app/target/jdks/graalvm-ce-java11-linux-amd64-21.1.0.tar.gz into /Users/duke/app/target/jdks</code></pre>
</div>
</div>
</div>
</div>
</article>
</div>
</main>
</div>
<footer class="footer">
<p>Copyright (C) 2021 Andres Almiray. This page was built using an adapted version of the Antora default UI.</p>
<p>The source code for this UI is licensed under the <a href="https://www.mozilla.org/en-US/MPL/2.0/">Mozilla Public License Version 2.0</a> (MPL-2.0).</p>
</footer>
<!--script src="../../../_/js/fontawesome.js"></script>
<script src="../../../_/js/all.js"></script-->
<script src="../../../_/js/site.js"></script>
<script async src="../../../_/js/vendor/highlight.js"></script>
</body>
</html>

417
guide/latest/tools/ant.html → guide/latest/tools/jreleaser-ant.html
View File

@@ -4,7 +4,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>JReleaser Ant Tasks :: JReleaser</title>
<link rel="canonical" href="https://jreleaser.org/guide/latest/tools/ant.html">
<link rel="canonical" href="https://jreleaser.org/guide/latest/tools/jreleaser-ant.html">
<meta name="generator" content="Antora 2.3.4">
<link rel="stylesheet" href="../../../_/css/site.css">
<link rel="stylesheet" href="../../../_/css/admonitions.css">
@@ -94,7 +94,7 @@
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../artifacts.html">Artifacts</a>
<a class="nav-link" href="../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
@@ -162,6 +162,15 @@
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/packagers/snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../configuration/upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
@@ -243,6 +252,12 @@
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
@@ -254,43 +269,53 @@
<a class="nav-link" href="index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="cli.html">JReleaser CLI</a>
<a class="nav-link" href="jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="maven.html">JReleaser Maven Plugin</a>
<a class="nav-link" href="jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="gradle.html">JReleaser Gradle Plugin</a>
<a class="nav-link" href="jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item is-current-page" data-depth="2">
<a class="nav-link" href="ant.html">JReleaser Ant Tasks</a>
<a class="nav-link" href="jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="tool-provider.html">JReleaser Tool Provider</a>
<a class="nav-link" href="jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="docker.html">JReleaser Docker Image</a>
<a class="nav-link" href="jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Examples</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
@@ -330,10 +355,10 @@
<ul>
<li><a href="../index.html">JReleaser</a></li>
<li><a href="index.html">Tools</a></li>
<li><a href="ant.html">JReleaser Ant Tasks</a></li>
<li><a href="jreleaser-ant.html">JReleaser Ant Tasks</a></li>
</ul>
</nav>
<div class="edit-this-page"><a href="https://github.com/jreleaser/jreleaser.github.io/edit/main/docs/modules/tools/pages/ant.adoc">Edit this Page</a></div>
<div class="edit-this-page"><a href="https://github.com/jreleaser/jreleaser.github.io/edit/main/docs/modules/tools/pages/jreleaser-ant.adoc">Edit this Page</a></div>
</div>
<div class="content">
<aside class="toc sidebar" data-title="Contents" data-levels="2">
@@ -344,17 +369,52 @@
<div id="preamble">
<div class="sectionbody">
<div class="paragraph">
<p>Executes a JReleaser workflow as Ant tasks</p>
</div>
<div class="paragraph">
<p>The following tasks are provided:</p>
<p>Executes a JReleaser workflow as Ant tasks.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_jreleaser_init"><a class="anchor" href="#_jreleaser_init"></a>jreleaser-init</h2>
<h2 id="_install"><a class="anchor" href="#_install"></a>Install</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Download jreleaser-ant-tasks ZIP bundle from the
<a href="https://github.com/jreleaser/jreleaser/releases">releases page</a> and unzip it in your project. Place all JARs inside
the <code>lib</code> folder. Create this folder if there is none. Add the following elements to your <code>build.xml</code> file</p>
</div>
<div class="listingblock">
<div class="title">build.xml</div>
<div class="content">
<pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml">&lt;path id="jreleaser.classpath"&gt;
&lt;fileset dir="lib"&gt;
&lt;include name="jreleaser-ant-tasks-0.3.0/*.jar"/&gt;
&lt;/fileset&gt;
&lt;/path&gt;
&lt;import&gt;
&lt;javaresource name="org/jreleaser/ant/targets.xml"
classpathref="jreleaser.classpath"/&gt;
&lt;/import&gt;</code></pre>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_configuration"><a class="anchor" href="#_configuration"></a>Configuration</h2>
<div class="sectionbody">
<div class="paragraph">
<p>JReleaser must be configured using the YAML, TOML, or JSON DSLs shown at <a href="../configuration/index.html" class="page">Configuration</a>.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_tasks"><a class="anchor" href="#_tasks"></a>Tasks</h2>
<div class="sectionbody">
<div class="paragraph">
<p>The following tasks are provided:</p>
</div>
<div class="sect2">
<h3 id="_jreleaser_init"><a class="anchor" href="#_jreleaser_init"></a>jreleaser-init</h3>
<div class="paragraph">
<p>Create a jreleaser config file.</p>
</div>
<div class="paragraph">
@@ -452,10 +512,8 @@ Description
</table>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_jreleaser_config"><a class="anchor" href="#_jreleaser_config"></a>jreleaser-config</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_jreleaser_config"><a class="anchor" href="#_jreleaser_config"></a>jreleaser-config</h3>
<div class="paragraph">
<p>Display current configuration.</p>
</div>
@@ -651,10 +709,8 @@ Description
</table>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_jreleaser_template"><a class="anchor" href="#_jreleaser_template"></a>jreleaser-template</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_jreleaser_template"><a class="anchor" href="#_jreleaser_template"></a>jreleaser-template</h3>
<div class="paragraph">
<p>Generate a tool/announcer template.</p>
</div>
@@ -994,12 +1050,10 @@ Description
</table>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_jreleaser_assemble"><a class="anchor" href="#_jreleaser_assemble"></a>jreleaser-assemble</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_jreleaser_assemble"><a class="anchor" href="#_jreleaser_assemble"></a>jreleaser-assemble</h3>
<div class="paragraph">
<p>Upload all distributions.</p>
<p>Assemble all distributions.</p>
</div>
<div class="paragraph">
<p><strong>configFile</strong></p>
@@ -1193,10 +1247,8 @@ Description
</table>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_jreleaser_changelog"><a class="anchor" href="#_jreleaser_changelog"></a>jreleaser-changelog</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_jreleaser_changelog"><a class="anchor" href="#_jreleaser_changelog"></a>jreleaser-changelog</h3>
<div class="paragraph">
<p>Calculate the changelog.</p>
</div>
@@ -1296,10 +1348,8 @@ Description
</table>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_jreleaser_checksum"><a class="anchor" href="#_jreleaser_checksum"></a>jreleaser-checksum</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_jreleaser_checksum"><a class="anchor" href="#_jreleaser_checksum"></a>jreleaser-checksum</h3>
<div class="paragraph">
<p>Calculate checksums.</p>
</div>
@@ -1399,10 +1449,8 @@ Description
</table>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_jreleaser_sign"><a class="anchor" href="#_jreleaser_sign"></a>jreleaser-sign</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_jreleaser_sign"><a class="anchor" href="#_jreleaser_sign"></a>jreleaser-sign</h3>
<div class="paragraph">
<p>Sign release artifacts.</p>
</div>
@@ -1502,10 +1550,246 @@ Description
</table>
</div>
</div>
<div class="sect2">
<h3 id="_jreleaser_upload"><a class="anchor" href="#_jreleaser_upload"></a>jreleaser-upload</h3>
<div class="paragraph">
<p>Uploads all files.</p>
</div>
<div class="sect1">
<h2 id="_jreleaser_release"><a class="anchor" href="#_jreleaser_release"></a>jreleaser-release</h2>
<div class="sectionbody">
<div class="paragraph">
<p><strong>configFile</strong></p>
</div>
<div class="hdlist">
<table>
<tr>
<td class="hdlist1">
Type
</td>
<td class="hdlist2">
<p>File</p>
</td>
</tr>
<tr>
<td class="hdlist1">
Default value
</td>
<td class="hdlist2">
<p>&lt;none&gt;</p>
</td>
</tr>
<tr>
<td class="hdlist1">
Property
</td>
<td class="hdlist2">
<p>jreleaser.config.file</p>
</td>
</tr>
<tr>
<td class="hdlist1">
Required
</td>
<td class="hdlist2">
<p>true</p>
</td>
</tr>
<tr>
<td class="hdlist1">
Description
</td>
<td class="hdlist2">
<p>The config file.</p>
</td>
</tr>
</table>
</div>
<hr>
<div class="paragraph">
<p><strong>distributionName</strong></p>
</div>
<div class="hdlist">
<table>
<tr>
<td class="hdlist1">
Type
</td>
<td class="hdlist2">
<p>String</p>
</td>
</tr>
<tr>
<td class="hdlist1">
Default value
</td>
<td class="hdlist2">
<p>&lt;none&gt;</p>
</td>
</tr>
<tr>
<td class="hdlist1">
Property
</td>
<td class="hdlist2">
<p>jreleaser.uploader.type</p>
</td>
</tr>
<tr>
<td class="hdlist1">
Required
</td>
<td class="hdlist2">
<p>false</p>
</td>
</tr>
<tr>
<td class="hdlist1">
Description
</td>
<td class="hdlist2">
<p>The type of the uploader to use.</p>
</td>
</tr>
</table>
</div>
<hr>
<div class="paragraph">
<p><strong>toolName</strong></p>
</div>
<div class="hdlist">
<table>
<tr>
<td class="hdlist1">
Type
</td>
<td class="hdlist2">
<p>String</p>
</td>
</tr>
<tr>
<td class="hdlist1">
Default value
</td>
<td class="hdlist2">
<p>&lt;none&gt;</p>
</td>
</tr>
<tr>
<td class="hdlist1">
Property
</td>
<td class="hdlist2">
<p>jreleaser.uploader.name</p>
</td>
</tr>
<tr>
<td class="hdlist1">
Required
</td>
<td class="hdlist2">
<p>false</p>
</td>
</tr>
<tr>
<td class="hdlist1">
Description
</td>
<td class="hdlist2">
<p>The name of the uploader to use.</p>
</td>
</tr>
</table>
</div>
<hr>
<div class="paragraph">
<p><strong>dryrun</strong></p>
</div>
<div class="hdlist">
<table>
<tr>
<td class="hdlist1">
Type
</td>
<td class="hdlist2">
<p>boolean</p>
</td>
</tr>
<tr>
<td class="hdlist1">
Default value
</td>
<td class="hdlist2">
<p>false</p>
</td>
</tr>
<tr>
<td class="hdlist1">
Property
</td>
<td class="hdlist2">
<p>jreleaser.dryrun</p>
</td>
</tr>
<tr>
<td class="hdlist1">
Required
</td>
<td class="hdlist2">
<p>false
Description: Skips remote operations.</p>
</td>
</tr>
</table>
</div>
<hr>
<div class="paragraph">
<p><strong>skip</strong></p>
</div>
<div class="hdlist">
<table>
<tr>
<td class="hdlist1">
Type
</td>
<td class="hdlist2">
<p>boolean</p>
</td>
</tr>
<tr>
<td class="hdlist1">
Default value
</td>
<td class="hdlist2">
<p>false</p>
</td>
</tr>
<tr>
<td class="hdlist1">
Property
</td>
<td class="hdlist2">
<p>jreleaser.skip</p>
</td>
</tr>
<tr>
<td class="hdlist1">
Required
</td>
<td class="hdlist2">
<p>false</p>
</td>
</tr>
<tr>
<td class="hdlist1">
Description
</td>
<td class="hdlist2">
<p>Skips execution of this task.</p>
</td>
</tr>
</table>
</div>
</div>
<div class="sect2">
<h3 id="_jreleaser_release"><a class="anchor" href="#_jreleaser_release"></a>jreleaser-release</h3>
<div class="paragraph">
<p>Create or update a release.</p>
</div>
@@ -1646,10 +1930,8 @@ Description
</table>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_jreleaser_prepare"><a class="anchor" href="#_jreleaser_prepare"></a>jreleaser-prepare</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_jreleaser_prepare"><a class="anchor" href="#_jreleaser_prepare"></a>jreleaser-prepare</h3>
<div class="paragraph">
<p>Prepare all distributions.</p>
</div>
@@ -1845,10 +2127,8 @@ Description
</table>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_jreleaser_package"><a class="anchor" href="#_jreleaser_package"></a>jreleaser-package</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_jreleaser_package"><a class="anchor" href="#_jreleaser_package"></a>jreleaser-package</h3>
<div class="paragraph">
<p>Package all distributions.</p>
</div>
@@ -2085,12 +2365,10 @@ Description
</table>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_jreleaser_upload"><a class="anchor" href="#_jreleaser_upload"></a>jreleaser-upload</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_jreleaser_publish"><a class="anchor" href="#_jreleaser_publish"></a>jreleaser-publish</h3>
<div class="paragraph">
<p>Upload all distributions.</p>
<p>Publish all distributions.</p>
</div>
<div class="paragraph">
<p><strong>configFile</strong></p>
@@ -2182,7 +2460,7 @@ Required
Description
</td>
<td class="hdlist2">
<p>The name of the distribution to be upload.</p>
<p>The name of the distribution to be published.</p>
</td>
</tr>
</table>
@@ -2230,7 +2508,7 @@ Required
Description
</td>
<td class="hdlist2">
<p>The name of the tool for uploading distributions.</p>
<p>The name of the tool for publishing distributions.</p>
</td>
</tr>
</table>
@@ -2325,10 +2603,8 @@ Description
</table>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_jreleaser_announce"><a class="anchor" href="#_jreleaser_announce"></a>jreleaser-announce</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_jreleaser_announce"><a class="anchor" href="#_jreleaser_announce"></a>jreleaser-announce</h3>
<div class="paragraph">
<p>Announce a release.</p>
</div>
@@ -2517,10 +2793,8 @@ Description
</table>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_jreleaser_full_release"><a class="anchor" href="#_jreleaser_full_release"></a>jreleaser-full-release</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_jreleaser_full_release"><a class="anchor" href="#_jreleaser_full_release"></a>jreleaser-full-release</h3>
<div class="paragraph">
<p>Perform a full release.</p>
</div>
@@ -2662,6 +2936,7 @@ Description
</div>
</div>
</div>
</div>
</article>
</div>
</main>

357
guide/latest/tools/cli.html → guide/latest/tools/jreleaser-cli.html
View File

@@ -4,7 +4,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>JReleaser CLI :: JReleaser</title>
<link rel="canonical" href="https://jreleaser.org/guide/latest/tools/cli.html">
<link rel="canonical" href="https://jreleaser.org/guide/latest/tools/jreleaser-cli.html">
<meta name="generator" content="Antora 2.3.4">
<link rel="stylesheet" href="../../../_/css/site.css">
<link rel="stylesheet" href="../../../_/css/admonitions.css">
@@ -94,7 +94,7 @@
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../artifacts.html">Artifacts</a>
<a class="nav-link" href="../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
@@ -162,6 +162,15 @@
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/packagers/snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../configuration/upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
@@ -243,6 +252,12 @@
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
@@ -254,43 +269,53 @@
<a class="nav-link" href="index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item is-current-page" data-depth="2">
<a class="nav-link" href="cli.html">JReleaser CLI</a>
<a class="nav-link" href="jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="maven.html">JReleaser Maven Plugin</a>
<a class="nav-link" href="jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="gradle.html">JReleaser Gradle Plugin</a>
<a class="nav-link" href="jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="ant.html">JReleaser Ant Tasks</a>
<a class="nav-link" href="jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="tool-provider.html">JReleaser Tool Provider</a>
<a class="nav-link" href="jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="docker.html">JReleaser Docker Image</a>
<a class="nav-link" href="jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Examples</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
@@ -330,10 +355,10 @@
<ul>
<li><a href="../index.html">JReleaser</a></li>
<li><a href="index.html">Tools</a></li>
<li><a href="cli.html">JReleaser CLI</a></li>
<li><a href="jreleaser-cli.html">JReleaser CLI</a></li>
</ul>
</nav>
<div class="edit-this-page"><a href="https://github.com/jreleaser/jreleaser.github.io/edit/main/docs/modules/tools/pages/cli.adoc">Edit this Page</a></div>
<div class="edit-this-page"><a href="https://github.com/jreleaser/jreleaser.github.io/edit/main/docs/modules/tools/pages/jreleaser-cli.adoc">Edit this Page</a></div>
</div>
<div class="content">
<aside class="toc sidebar" data-title="Contents" data-levels="2">
@@ -361,22 +386,114 @@ Commands:
changelog Calculate the changelog.
checksum Calculate checksums.
sign Sign release artifacts.
upload Uploads all artifacts.
release Create or update a release..
prepare Prepare all distributions.
package Package all distributions.
upload Upload all distributions.
publish Publish all distributions.
announce Announce a release.
full-release Perform a full release.</code></pre>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_install"><a class="anchor" href="#_install"></a>Install</h2>
<div class="sectionbody">
<div class="tabset is-loading">
<div class="ulist tabs">
<ul>
<li>
<p><a id="tabset1_windows"></a>Windows</p>
</li>
<li>
<p><a id="tabset1_linux"></a>Linux</p>
</li>
<li>
<p><a id="tabset1_mac"></a>Mac</p>
</li>
</ul>
</div>
<div class="content">
<div class="tab-pane" aria-labelledby="tabset1_windows">
<div class="paragraph">
<p>The following commands are supported:</p>
<p><strong>sdkman</strong></p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code>sdk install jreleaser</code></pre>
</div>
</div>
<div class="paragraph">
<p><strong>manually</strong></p>
</div>
<div class="paragraph">
<p>Download the pre-compiled binary from the <a href="https://github.com/jreleaser/jreleaser/releases">releases page</a>,
uncompress and copy to the desired location.</p>
</div>
</div>
<div class="tab-pane" aria-labelledby="tabset1_linux">
<div class="paragraph">
<p><strong>sdkman</strong></p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code>sdk install jreleaser</code></pre>
</div>
</div>
<div class="paragraph">
<p><strong>manually</strong></p>
</div>
<div class="paragraph">
<p>Download the pre-compiled binary from the <a href="https://github.com/jreleaser/jreleaser/releases">releases page</a>,
uncompress and copy to the desired location.</p>
</div>
</div>
<div class="tab-pane" aria-labelledby="tabset1_mac">
<div class="paragraph">
<p><strong>homebrew tap</strong></p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code>brew install jreleaser/tap/jreleaser</code></pre>
</div>
</div>
<div class="paragraph">
<p><strong>sdkman</strong></p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code>sdk install jreleaser</code></pre>
</div>
</div>
<div class="paragraph">
<p><strong>manually</strong></p>
</div>
<div class="paragraph">
<p>Download the pre-compiled binary from the <a href="https://github.com/jreleaser/jreleaser/releases">releases page</a>,
uncompress and copy to the desired location.</p>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_init"><a class="anchor" href="#_init"></a>init</h2>
<h2 id="_configuration"><a class="anchor" href="#_configuration"></a>Configuration</h2>
<div class="sectionbody">
<div class="paragraph">
<p>JReleaser must be configured using the YAML, TOML, or JSON DSLs shown at <a href="../configuration/index.html" class="page">Configuration</a>.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_commands"><a class="anchor" href="#_commands"></a>Commands</h2>
<div class="sectionbody">
<div class="paragraph">
<p>The following commands are supported:</p>
</div>
<div class="sect2">
<h3 id="_init"><a class="anchor" href="#_init"></a>init</h3>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ jreleaser init -h
@@ -400,10 +517,8 @@ Create a jreleaser config file.
<p>The file will be generated at <code>&lt;basedir&gt;</code> if specified, otherwise at the current directory.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_config"><a class="anchor" href="#_config"></a>config</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_config"><a class="anchor" href="#_config"></a>config</h3>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ jreleaser config -h
@@ -430,10 +545,8 @@ found at the current directory.</p>
<p>If <code>--basedir</code> is undefined then the command assumes it&#8217;s the same directory that contains the resolved config file.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_template"><a class="anchor" href="#_template"></a>template</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_template"><a class="anchor" href="#_template"></a>template</h3>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ jreleaser template -h
@@ -483,10 +596,8 @@ Tool templates
<p>The value of <code>--tool-name</code> must match any of the available <a href="../configuration/packagers/index.html" class="page">Packagers</a>.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_assemble"><a class="anchor" href="#_assemble"></a>assemble</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_assemble"><a class="anchor" href="#_assemble"></a>assemble</h3>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ jreleaser assemble -h
@@ -526,10 +637,8 @@ found at the current directory.</p>
<p>This command must be invoked separatedly from the others as some of the assmeblers are platform specific.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_changelog"><a class="anchor" href="#_changelog"></a>changelog</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_changelog"><a class="anchor" href="#_changelog"></a>changelog</h3>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ jreleaser changelog -h
@@ -554,10 +663,8 @@ found at the current directory.</p>
<p>If <code>--basedir</code> is undefined then the command assumes it&#8217;s the same directory that contains the resolved config file.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_checksum"><a class="anchor" href="#_checksum"></a>checksum</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_checksum"><a class="anchor" href="#_checksum"></a>checksum</h3>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ jreleaser checksum -h
@@ -582,10 +689,8 @@ found at the current directory.</p>
<p>If <code>--basedir</code> is undefined then the command assumes it&#8217;s the same directory that contains the resolved config file.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_sign"><a class="anchor" href="#_sign"></a>sign</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_sign"><a class="anchor" href="#_sign"></a>sign</h3>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ jreleaser sign -h
@@ -610,17 +715,101 @@ found at the current directory.</p>
<p>If <code>--basedir</code> is undefined then the command assumes it&#8217;s the same directory that contains the resolved config file.</p>
</div>
</div>
<div class="sect2">
<h3 id="_upload"><a class="anchor" href="#_upload"></a>upload</h3>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">Usage: jreleaser upload [-dhiqVwy] [-b=&lt;basedir&gt;] [-c=&lt;configFile&gt;]
[-un=&lt;uploaderName&gt;] [-ut=&lt;uploaderType&gt;]
Uploads all artifacts.
-b, --basedir=&lt;basedir&gt; Base directory.
-c, --config-file=&lt;configFile&gt;
The config file
-d, --debug Set log level to debug.
-h, --help Show this help message and exit.
-i, --info Set log level to info.
-q, --quiet Log errors only.
-un, --uploader-name=&lt;uploaderName&gt;
The name of the uploader.
-ut, --uploader-type=&lt;uploaderType&gt;
The type of the uploader.
-V, --version Print version information and exit.
-w, --warn Set log level to warn.
-y, --dryrun Skip remote operations.</code></pre>
</div>
<div class="sect1">
<h2 id="_release"><a class="anchor" href="#_release"></a>release</h2>
<div class="sectionbody">
</div>
<div class="paragraph">
<p>If <code>--config-file</code> is undefined then the command assumes the file is named <code>jreleaser.[yml|toml|json]</code> and it&#8217;s
found at the current directory.</p>
</div>
<div class="paragraph">
<p>If <code>--basedir</code> is undefined then the command assumes it&#8217;s the same directory that contains the resolved config file.</p>
</div>
<div class="paragraph">
<p>The value of <code>--uploader-type</code> must match the type of a configured <a href="../configuration/upload/index.html" class="page">uploader</a>.</p>
</div>
<div class="paragraph">
<p>The value of <code>--uploader-name</code> must match any of the available <a href="../configuration/upload/index.html" class="page">uploaders</a>.</p>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
Use <code>-y</code> or <code>--dryrun</code> during development to verify your configuration settings. No network uploads nor repository
mutations should occur when this mode is activated.
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>You may invoke this command in the following ways:</p>
</div>
<div class="paragraph">
<p>Upload all artifacts:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ jreleaser upload</code></pre>
</div>
</div>
<div class="paragraph">
<p>Upload all artifacts to all configured Artifactory uploaders:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ jreleaser upload --uploader-type artifactory</code></pre>
</div>
</div>
<div class="paragraph">
<p>Upload all artifacts with all uploaders with matching name:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ jreleaser upload --uploader-name mine</code></pre>
</div>
</div>
<div class="paragraph">
<p>Upload all artifacts to a matching Artifactory uploader:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ jreleaser upload --uploader-type artifactory --uploader-name mine</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_release"><a class="anchor" href="#_release"></a>release</h3>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ jreleaser release -h
Usage: jreleaser release [-dhiqVwy] [--auto-config] [--overwrite]
[--prerelease] [--signing-armored] [--signing-enabled]
[--skip-tag] [--update] [-b=&lt;basedir&gt;]
[-c=&lt;configFile&gt;] [--changelog=&lt;changelog&gt;]
Usage: jreleaser release [-dhiqVwy] [--auto-config] [--changelog-formatted]
[--draft] [--overwrite] [--prerelease]
[--signing-armored] [--signing-enabled] [--skip-tag]
[--update] [-b=&lt;basedir&gt;] [-c=&lt;configFile&gt;]
[--changelog=&lt;changelog&gt;]
[--commit-author-email=&lt;commitAuthorEmail&gt;]
[--commit-author-name=&lt;commitAuthorName&gt;]
[--milestone-name=&lt;milestoneName&gt;]
@@ -631,15 +820,18 @@ Usage: jreleaser release [-dhiqVwy] [--auto-config] [--overwrite]
Create or update a release..
--auto-config Model auto configuration..
-b, --basedir=&lt;basedir&gt; Base directory.
--branch=&lt;branch&gt; The release branch.
-c, --config-file=&lt;configFile&gt;
The config file
--changelog=&lt;changelog&gt;
Path to changelog file.
--changelog-formatted Format generated changelog.
--commit-author-email=&lt;commitAuthorEmail&gt;
Commit author e-mail.
--commit-author-name=&lt;commitAuthorName&gt;
Commit author name.
-d, --debug Set log level to debug.
--draft If the release is a draft.
--file=&lt;files&gt; Input file(s) to be uploaded.
-h, --help Show this help message and exit.
-i, --info Set log level to info.
@@ -648,9 +840,9 @@ Create or update a release..
--overwrite Overwrite an existing release.
--prerelease If the release is a prerelease.
--project-name=&lt;projectName&gt;
The projects name.
The project name.
--project-version=&lt;projectVersion&gt;
The projects version.
The project version.
-q, --quiet Log errors only.
--release-name=&lt;releaseName&gt;
The release name.
@@ -662,7 +854,7 @@ Create or update a release..
--username=&lt;username&gt; Git username.
-V, --version Print version information and exit.
-w, --warn Set log level to warn.
-y, --dryrun Skips remote operations.</code></pre>
-y, --dryrun Skip remote operations.</code></pre>
</div>
</div>
<div class="paragraph">
@@ -723,10 +915,8 @@ mutations should occur when this mode is activated.
</table>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_prepare"><a class="anchor" href="#_prepare"></a>prepare</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_prepare"><a class="anchor" href="#_prepare"></a>prepare</h3>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ jreleaser prepare -h
@@ -797,10 +987,8 @@ found at the current directory.</p>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_package"><a class="anchor" href="#_package"></a>package</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_package"><a class="anchor" href="#_package"></a>package</h3>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ jreleaser package -h
@@ -820,7 +1008,7 @@ Package all distributions.
The name of the tool.
-V, --version Print version information and exit.
-w, --warn Set log level to warn.
-y, --dryrun Skips remote operations.</code></pre>
-y, --dryrun Skip remote operations.</code></pre>
</div>
</div>
<div class="paragraph">
@@ -885,16 +1073,14 @@ mutations should occur when this mode is activated.
</table>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_upload"><a class="anchor" href="#_upload"></a>upload</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_publish"><a class="anchor" href="#_publish"></a>publish</h3>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ jreleaser upload -h
Usage: jreleaser upload [-dhiqVwy] [-b=&lt;basedir&gt;] [-c=&lt;configFile&gt;]
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ jreleaser publish -h
Usage: jreleaser publish [-dhiqVwy] [-b=&lt;basedir&gt;] [-c=&lt;configFile&gt;]
[-dn=&lt;distributionName&gt;] [-tn=&lt;toolName&gt;]
Upload all distributions.
Publish all distributions.
-b, --basedir=&lt;basedir&gt; Base directory.
-c, --config-file=&lt;configFile&gt;
The config file
@@ -908,7 +1094,7 @@ Upload all distributions.
The name of the tool.
-V, --version Print version information and exit.
-w, --warn Set log level to warn.
-y, --dryrun Skips remote operations.</code></pre>
-y, --dryrun Skip remote operations.</code></pre>
</div>
</div>
<div class="paragraph">
@@ -928,35 +1114,35 @@ found at the current directory.</p>
<p>You may invoke this command in the following ways:</p>
</div>
<div class="paragraph">
<p>Upload all distributions:</p>
<p>Publish all distributions:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ jreleaser upload</code></pre>
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ jreleaser publish</code></pre>
</div>
</div>
<div class="paragraph">
<p>Upload a single distribution with all configured tools:</p>
<p>Publish a single distribution with all configured tools:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ jreleaser upload --distribution-name app</code></pre>
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ jreleaser publish --distribution-name app</code></pre>
</div>
</div>
<div class="paragraph">
<p>Upload all distributions with a single tool:</p>
<p>Publish all distributions with a single tool:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ jreleaser upload --tool-name brew</code></pre>
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ jreleaser publish --tool-name brew</code></pre>
</div>
</div>
<div class="paragraph">
<p>Upload a single distribution with a single tool:</p>
<p>Publish a single distribution with a single tool:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ jreleaser upload --distribution-name app --tool-name brew</code></pre>
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ jreleaser publish --distribution-name app --tool-name brew</code></pre>
</div>
</div>
<div class="admonitionblock note">
@@ -973,10 +1159,8 @@ mutations should occur when this mode is activated.
</table>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_announce"><a class="anchor" href="#_announce"></a>announce</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_announce"><a class="anchor" href="#_announce"></a>announce</h3>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ jreleaser announce -h
@@ -994,7 +1178,7 @@ Announce a release.
-q, --quiet Log errors only.
-V, --version Print version information and exit.
-w, --warn Set log level to warn.
-y, --dryrun Skips remote operations.</code></pre>
-y, --dryrun Skip remote operations.</code></pre>
</div>
</div>
<div class="paragraph">
@@ -1040,10 +1224,8 @@ mutations should occur when this mode is activated.
</table>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_full_release"><a class="anchor" href="#_full_release"></a>full-release</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_full_release"><a class="anchor" href="#_full_release"></a>full-release</h3>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ jreleaser full-release -h
@@ -1058,7 +1240,7 @@ Perform a full release.
-q, --quiet Log errors only.
-V, --version Print version information and exit.
-w, --warn Set log level to warn.
-y, --dryrun Skips remote operations.</code></pre>
-y, --dryrun Skip remote operations.</code></pre>
</div>
</div>
<div class="paragraph">
@@ -1083,6 +1265,7 @@ mutations should occur when this mode is activated.
</div>
</div>
</div>
</div>
</article>
</div>
</main>

65
guide/latest/tools/docker.html → guide/latest/tools/jreleaser-docker.html
View File

@@ -4,7 +4,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>JReleaser Docker Image :: JReleaser</title>
<link rel="canonical" href="https://jreleaser.org/guide/latest/tools/docker.html">
<link rel="canonical" href="https://jreleaser.org/guide/latest/tools/jreleaser-docker.html">
<meta name="generator" content="Antora 2.3.4">
<link rel="stylesheet" href="../../../_/css/site.css">
<link rel="stylesheet" href="../../../_/css/admonitions.css">
@@ -94,7 +94,7 @@
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../artifacts.html">Artifacts</a>
<a class="nav-link" href="../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
@@ -162,6 +162,15 @@
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/packagers/snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../configuration/upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
@@ -243,6 +252,12 @@
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
@@ -254,43 +269,53 @@
<a class="nav-link" href="index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="cli.html">JReleaser CLI</a>
<a class="nav-link" href="jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="maven.html">JReleaser Maven Plugin</a>
<a class="nav-link" href="jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="gradle.html">JReleaser Gradle Plugin</a>
<a class="nav-link" href="jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="ant.html">JReleaser Ant Tasks</a>
<a class="nav-link" href="jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="tool-provider.html">JReleaser Tool Provider</a>
<a class="nav-link" href="jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item is-current-page" data-depth="2">
<a class="nav-link" href="docker.html">JReleaser Docker Image</a>
<a class="nav-link" href="jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Examples</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
@@ -330,10 +355,10 @@
<ul>
<li><a href="../index.html">JReleaser</a></li>
<li><a href="index.html">Tools</a></li>
<li><a href="docker.html">JReleaser Docker Image</a></li>
<li><a href="jreleaser-docker.html">JReleaser Docker Image</a></li>
</ul>
</nav>
<div class="edit-this-page"><a href="https://github.com/jreleaser/jreleaser.github.io/edit/main/docs/modules/tools/pages/docker.adoc">Edit this Page</a></div>
<div class="edit-this-page"><a href="https://github.com/jreleaser/jreleaser.github.io/edit/main/docs/modules/tools/pages/jreleaser-docker.adoc">Edit this Page</a></div>
</div>
<div class="content">
<aside class="toc sidebar" data-title="Contents" data-levels="2">
@@ -342,7 +367,10 @@
<article class="doc">
<h1 class="page">JReleaser Docker Image</h1>
<div class="paragraph">
<p>Wraps the <a href="cli.html" class="page">JReleaser CLI</a> with an Ubuntu based docker image:
<p><span class="image"><a class="image" href="https://hub.docker.com/r/jreleaser/jreleaser-slim"><img src="https://dockeri.co/image/jreleaser/jreleaser-slim" alt="jreleaser slim"></a></span></p>
</div>
<div class="paragraph">
<p>Wraps the <a href="jreleaser-cli.html" class="page">JReleaser CLI</a> with an Ubuntu based docker image:
<a href="https://hub.docker.com/r/jreleaser/jreleaser-slim">jreleaser/jreleaser-slim</a>. This image may be used to run
JReleaser without having a pre-installed Java runtime on your system.</p>
</div>
@@ -360,7 +388,7 @@ Additional packaging options such as <a href="../configuration/packagers/snap.ht
</table>
</div>
<div class="paragraph">
<p>Every command exposed by <a href="cli.html" class="page">JReleaser CLI</a> can be invoked with this image.</p>
<p>Every command exposed by <a href="jreleaser-cli.html" class="page">JReleaser CLI</a> can be invoked with this image.</p>
</div>
<div class="paragraph">
<p>You must mount the working directory at the <code>/workspace</code> volume, for example assuming the current directory is the
@@ -387,6 +415,9 @@ The <code>--basedir</code> argument will be automatically set to <code>--basedir
<p>You may also need to map environment variables to the container, such as <code>JRELEASER_PROJECT_VERSION</code>,
<code>JRELEASER_GITHUB_TOKEN</code>, or others depending on your setup.</p>
</div>
<div class="paragraph">
<p>You can find the tag listing <a href="hub.docker.com/r/jreleaser/jreleaser-slim/tags">here</a>.</p>
</div>
</article>
</div>
</main>

1208
guide/latest/tools/gradle.html → guide/latest/tools/jreleaser-gradle.html
View File

File diff suppressed because it is too large Load Diff

1002
guide/latest/tools/jreleaser-maven.html Normal file
View File

File diff suppressed because it is too large Load Diff

59
guide/latest/tools/tool-provider.html → guide/latest/tools/jreleaser-tool-provider.html
View File

@@ -4,7 +4,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>JReleaser Tool Provider :: JReleaser</title>
<link rel="canonical" href="https://jreleaser.org/guide/latest/tools/tool-provider.html">
<link rel="canonical" href="https://jreleaser.org/guide/latest/tools/jreleaser-tool-provider.html">
<meta name="generator" content="Antora 2.3.4">
<link rel="stylesheet" href="../../../_/css/site.css">
<link rel="stylesheet" href="../../../_/css/admonitions.css">
@@ -94,7 +94,7 @@
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../artifacts.html">Artifacts</a>
<a class="nav-link" href="../artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
@@ -162,6 +162,15 @@
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/packagers/snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../configuration/upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../configuration/upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
@@ -243,6 +252,12 @@
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../continuous-integration/drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
@@ -254,43 +269,53 @@
<a class="nav-link" href="index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="cli.html">JReleaser CLI</a>
<a class="nav-link" href="jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="maven.html">JReleaser Maven Plugin</a>
<a class="nav-link" href="jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="gradle.html">JReleaser Gradle Plugin</a>
<a class="nav-link" href="jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="ant.html">JReleaser Ant Tasks</a>
<a class="nav-link" href="jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item is-current-page" data-depth="2">
<a class="nav-link" href="tool-provider.html">JReleaser Tool Provider</a>
<a class="nav-link" href="jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="docker.html">JReleaser Docker Image</a>
<a class="nav-link" href="jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Examples</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
@@ -330,10 +355,10 @@
<ul>
<li><a href="../index.html">JReleaser</a></li>
<li><a href="index.html">Tools</a></li>
<li><a href="tool-provider.html">JReleaser Tool Provider</a></li>
<li><a href="jreleaser-tool-provider.html">JReleaser Tool Provider</a></li>
</ul>
</nav>
<div class="edit-this-page"><a href="https://github.com/jreleaser/jreleaser.github.io/edit/main/docs/modules/tools/pages/tool-provider.adoc">Edit this Page</a></div>
<div class="edit-this-page"><a href="https://github.com/jreleaser/jreleaser.github.io/edit/main/docs/modules/tools/pages/jreleaser-tool-provider.adoc">Edit this Page</a></div>
</div>
<div class="content">
<aside class="toc sidebar" data-title="Contents" data-levels="2">
@@ -342,12 +367,12 @@
<article class="doc">
<h1 class="page">JReleaser Tool Provider</h1>
<div class="paragraph">
<p>Wraps the <a href="cli.html" class="page">JReleaser CLI</a> with an implementation of the
<p>Wraps the <a href="jreleaser-cli.html" class="page">JReleaser CLI</a> with an implementation of the
<a href="https://docs.oracle.com/javase/9/docs/api/java/util/spi/ToolProvider.html">java.util.spi.ToolProvider</a>
interface.</p>
</div>
<div class="paragraph">
<p>Every command exposed by <a href="cli.html" class="page">JReleaser CLI</a> can be invoked by this <code>ToolProvider</code>.</p>
<p>Every command exposed by <a href="jreleaser-cli.html" class="page">JReleaser CLI</a> can be invoked by this <code>ToolProvider</code>.</p>
</div>
</article>
</div>

2054
guide/latest/tools/maven.html
View File

File diff suppressed because it is too large Load Diff

75
guide/latest/workflow.html
View File

@@ -94,7 +94,7 @@
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<a class="nav-link" href="artifacts.html">Artifacts</a>
<a class="nav-link" href="artifacts.html">Artifacts &amp; Globs</a>
</li>
</ul>
</li>
@@ -162,6 +162,15 @@
<li class="nav-item" data-depth="3">
<a class="nav-link" href="configuration/packagers/snap.html">Snap</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="configuration/upload/index.html">Upload</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="configuration/upload/artifactory.html">Artifactory</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
@@ -243,6 +252,12 @@
<li class="nav-item" data-depth="2">
<a class="nav-link" href="continuous-integration/gitlab-ci.html">GitLab CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="continuous-integration/cirrus-ci.html">Cirrus CI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="continuous-integration/drone.html">Drone</a>
</li>
</ul>
</li>
</ul>
@@ -254,43 +269,53 @@
<a class="nav-link" href="tools/index.html">Tools</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="tools/cli.html">JReleaser CLI</a>
<a class="nav-link" href="tools/jreleaser-cli.html">JReleaser CLI</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="tools/maven.html">JReleaser Maven Plugin</a>
<a class="nav-link" href="tools/jreleaser-maven.html">JReleaser Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="tools/gradle.html">JReleaser Gradle Plugin</a>
<a class="nav-link" href="tools/jreleaser-gradle.html">JReleaser Gradle Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="tools/ant.html">JReleaser Ant Tasks</a>
<a class="nav-link" href="tools/jreleaser-ant.html">JReleaser Ant Tasks</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="tools/tool-provider.html">JReleaser Tool Provider</a>
<a class="nav-link" href="tools/jreleaser-tool-provider.html">JReleaser Tool Provider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="tools/docker.html">JReleaser Docker Image</a>
<a class="nav-link" href="tools/jreleaser-docker.html">JReleaser Docker Image</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="tools/jdks-maven.html">JDKs Maven Plugin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="tools/jdks-gradle.html">JDKs Gradle Plugin</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
<button class="nav-item-toggle"></button>
<span class="nav-text">Examples</span>
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="examples/index.html">Examples</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="examples/jreleaser.html">JReleaser&#8217;s Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="examples/simple-release.html">Simple Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="examples/auto-config-release.html">AutoConfig Release</a>
</li>
<li class="nav-item" data-depth="1">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="examples/cross-platform-jlink.html">Cross Platform Jlink</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="0">
@@ -381,7 +406,7 @@ The preferred option is to invoke <a href="#_full_release">Full Release</a> as i
<div class="sectionbody">
<div class="paragraph">
<p>Assembles distributions such as Jlink and Native Image. Outputs will automatically configure/update matching named
distributions for <a href="#_prepare">Prepare</a>, <a href="#_package">Package</a>, and <a href="#_upload">Upload</a>.</p>
distributions for <a href="#_prepare">Prepare</a>, <a href="#_package">Package</a>, and <a href="#_publish">Publish</a>.</p>
</div>
<div class="paragraph">
<p>Given the nature of platform specific distributions this step must be invoked separatedly from the others.</p>
@@ -410,9 +435,6 @@ file configured in the <a href="configuration/files.html" class="page">Files</a>
<div class="paragraph">
<p>Checksums will be placed at <code>${basedir}/out/jreleaser/checksums</code>.</p>
</div>
<div class="paragraph">
<p>Depends on <a href="#_changelog">Changelog</a>.</p>
</div>
</div>
</div>
<div class="sect1">
@@ -433,6 +455,18 @@ section found in the configuration.</p>
</div>
</div>
<div class="sect1">
<h2 id="_upload"><a class="anchor" href="#_upload"></a>Upload</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Uploads artifacts and files to the configured destinations. This step uploads signatures (if enabled), all distribution
artifacts, and every matching file configured in the <a href="configuration/files.html" class="page">Files</a> section. This step is optional.</p>
</div>
<div class="paragraph">
<p>Depends on <a href="#_sign">Sign</a>.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_release"><a class="anchor" href="#_release"></a>Release</h2>
<div class="sectionbody">
<div class="paragraph">
@@ -441,7 +475,7 @@ all checksums, signatures (if enabled), all distribution artifacts, and every ma
<a href="configuration/files.html" class="page">Files</a> section. Automatically calculates a changelog &amp; tags the release.</p>
</div>
<div class="paragraph">
<p>Depends on <a href="#_sign">Sign</a>.</p>
<p>Depends on <a href="#_upload">Upload</a>.</p>
</div>
</div>
</div>
@@ -480,7 +514,7 @@ matching prepared directory to their respective package directory.</p>
</div>
</div>
<div class="sect1">
<h2 id="_upload"><a class="anchor" href="#_upload"></a>Upload</h2>
<h2 id="_publish"><a class="anchor" href="#_publish"></a>Publish</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Publishes packaged files to their respective destinations. For example, for <a href="configuration/packagers/homebrew.html" class="page">Homebrew</a>
@@ -527,6 +561,9 @@ files had been released.</p>
<p><a href="#_sign">Sign</a></p>
</li>
<li>
<p><a href="#_upload">Upload</a></p>
</li>
<li>
<p><a href="#_release">Release</a></p>
</li>
<li>
@@ -536,7 +573,7 @@ files had been released.</p>
<p><a href="#_package">Package</a></p>
</li>
<li>
<p><a href="#_upload">Upload</a></p>
<p><a href="#_publish">Publish</a></p>
</li>
<li>
<p><a href="#_announce">Announce</a></p>

6
index.html
View File

@@ -109,7 +109,7 @@
<div class="service-content">
<h4><a href="#">Release to git</a></h4>
<p>
Tag and release to popular git services such as GitHub.
Tag and release to popular git services such as GitHub, GitLab, and Gitea.
</p>
</div>
</div>
@@ -184,7 +184,7 @@
<div class="col-md-7">
<h2 class="featurette-heading">Quick configuration.</h2>
<p class="lead">Configure the essentials and let JReleaser do the heavy lifting. Convention over configuration is a thing!<br/><br/>
YAML is not your cup of Java? We've got other formats like JSON, a Maven DSL, and a Gradle DSL.</p>
YAML is not your preferred format? We've got other formats like TOML, JSON, a Maven DSL, and a Gradle DSL.</p>
</div>
<div class="col-md-5">
<img class="bd-placeholder-img bd-placeholder-img-lg featurette-image img-fluid mx-auto" width="500" src="images/app-jreleaser-config.png"></img>
@@ -198,7 +198,7 @@
<div class="col-md-7 order-md-2">
<h2 class="featurette-heading">Publish and announce a release.</h2>
<p class="lead">Publishing a release is as simple as executing a single command using the <code>jreleaser</code> CLI.<br/><br/>
We also offer Maven and Gradle plugins, Ant tasks, and Jbang integration to boot!</p>
We also offer Maven and Gradle plugins, Ant tasks, Jbang integration, and a Docker image to boot!</p>
</div>
<div class="col-md-5 order-md-1">
<img class="bd-placeholder-img bd-placeholder-img-lg featurette-image img-fluid mx-auto" width="500" src="images/app-full-release-command.png"></img><br/><br/>

186
sitemap.xml
View File

@@ -2,262 +2,290 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://jreleaser.org/guide/latest/artifacts.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/configuration/announce/discord.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/configuration/announce/discussions.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/configuration/announce/gitter.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/configuration/announce/index.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/configuration/announce/mail.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/configuration/announce/sdkman.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/configuration/announce/slack.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/configuration/announce/teams.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/configuration/announce/twitter.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/configuration/announce/zulip.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/configuration/assemble/index.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/configuration/assemble/jlink.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/configuration/assemble/native-image.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/configuration/distributions.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/configuration/environment.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/configuration/files.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/configuration/index.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/configuration/name-templates.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/configuration/packagers/chocolatey.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/configuration/packagers/docker.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/configuration/packagers/homebrew.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/configuration/packagers/index.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/configuration/packagers/jbang.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/configuration/packagers/scoop.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/configuration/packagers/snap.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/configuration/project.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/configuration/release/gitea.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/configuration/release/github.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/configuration/release/gitlab.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/configuration/release/index.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/configuration/signing.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/configuration/upload/artifactory.html</loc>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/configuration/upload/index.html</loc>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/continuous-integration/circle-ci.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/continuous-integration/cirrus-ci.html</loc>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/continuous-integration/codefresh.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/continuous-integration/drone.html</loc>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/continuous-integration/github-actions.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/continuous-integration/gitlab-ci.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/continuous-integration/index.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/continuous-integration/jenkins.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/distributions/index.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/distributions/java-binary.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/distributions/jlink.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/distributions/native-image.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/distributions/single-jar.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/examples/auto-config-release.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/examples/cross-platform-jlink.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/examples/index.html</loc>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/examples/jreleaser.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/examples/simple-release.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/index.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/install.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/links.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/quick-start/ant.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/quick-start/cli.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/quick-start/gradle.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/quick-start/index.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/quick-start/maven.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/templates/mustache.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/templates/templates.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/tools/ant.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/tools/cli.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/tools/docker.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/tools/gradle.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/tools/index.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/tools/maven.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
<loc>https://jreleaser.org/guide/latest/tools/jdks-gradle.html</loc>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/tools/tool-provider.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
<loc>https://jreleaser.org/guide/latest/tools/jdks-maven.html</loc>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/tools/jreleaser-ant.html</loc>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/tools/jreleaser-cli.html</loc>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/tools/jreleaser-docker.html</loc>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/tools/jreleaser-gradle.html</loc>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/tools/jreleaser-maven.html</loc>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/tools/jreleaser-tool-provider.html</loc>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
<url>
<loc>https://jreleaser.org/guide/latest/workflow.html</loc>
<lastmod>2021-04-24T08:45:32.056Z</lastmod>
<lastmod>2021-05-08T08:17:53.926Z</lastmod>
</url>
</urlset>