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
Files
ba4506b6fe853edfa667a959934ff5973f29bc26
jreleaser.github.io/guide/latest/artifacts.html
aalmiray ba4506b6fe [CI] Publish Documentation for 23a9da81dc
2021-05-08 08:17:55 +00:00

754 lines
25 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<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">
<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 is-current-page" 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" 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="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>
</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">Artifacts &amp; Globs</h1>
<div id="preamble">
<div class="sectionbody">
<div class="paragraph">
<p>Artifacts are at the heart of a release; they define files that may be:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>added to a Git <a href="configuration/release/index.html" class="page">release</a>.</p>
</li>
<li>
<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">
<h2 id="_properties"><a class="anchor" href="#_properties"></a>Properties</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Artifacts have the following properties:</p>
</div>
<div class="ulist">
<ul>
<li>
<p><code>path</code>. Defines the location of the file. Path may be relative or absolute. We recomend defining paths
that are relative to the <code>basedir</code> as much as possible, as that simplifies the setup on
<a href="continuous-integration/index.html" class="page">CI</a>. Its value may use <a href="configuration/name-templates.html" class="page">Name Templates</a>.
This property is <strong>required</strong>.</p>
</li>
<li>
<p><code>transform</code>. Sometimes the source path does not have the exact name you&#8217;d looking for. You may apply a
name transformation using this property. Its value may use <a href="configuration/name-templates.html" class="page">Name Templates</a>.
This property is <strong>optional</strong>.</p>
</li>
<li>
<p><code>platform</code>. Defines the OS specific platform for this file. Some <a href="configuration/assemble/index.html" class="page">assemblers</a>
and <a href="configuration/packagers/index.html" class="page">packagers</a> require that artifacts define a platform.</p>
</li>
</ul>
</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>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">
<h2 id="_examples"><a class="anchor" href="#_examples"></a>Examples</h2>
<div class="sectionbody">
<div class="paragraph">
<p><strong>Platform</strong></p>
</div>
<div class="paragraph">
<p>Generating cross-platform JLink images require that each target JDK define a value for its corresponding platform.
Target JDKs are of type <code>artifact</code>.</p>
</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">assemble:
jlinks:
app:
active: always
jdk:
path: '{{oracleJdks}}/jdk-16_osx-x64/Contents/Home'
platform: osx
targetJdks:
- path: '{{oracleJdks}}/jdk-16_osx-x64/Contents/Home'
platform: osx
- path: '{{oracleJdks}}/jdk-16_linux-x64'
platform: linux
- path: '{{oracleJdks}}/jdk-16_windows-x64'
platform: windows
mainJar:
path: 'target/{{distributionName}}-{{projectVersion}}.jar'</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">[assemble.jlinks.app]
active = "ALWAYS"
mainJar = { path = "target/{{distributionName}}-{{projectVersion}}.jar" }
jdk = { path = "{{oracleJdks}}/jdk-16_osx-x64/Contents/Home", platform = "osx" }
[[assemble.jlinks.app.targetJdks]]
path = "{{oracleJdks}}/jdk-16_osx-x64/Contents/Home"
platform = "osx"
[[assemble.jlinks.app.targetJdks]]
path = "{{oracleJdks}}/jdk-16_linux-x64"
platform = "linux"
[[assemble.jlinks.app.targetJdks]]
path = "{{oracleJdks}}/jdk-16_windows-x64"
platform = "windows"</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">{
"assemble": {
"jlinks": {
"app": {
"active": "ALWAYS",
"mainJar": {
"path": "target/{{distributionName}}-{{projectVersion}}.jar"
},
"jdk": {
"path": "{{oracleJdks}}/jdk-16_osx-x64/Contents/Home",
"platform": "osx"
},
"targetJdks": [
{
"path": "{{oracleJdks}}/jdk-16_osx-x64/Contents/Home",
"platform": "osx"
},
{
"path": "{{oracleJdks}}/jdk-16_linux-x64",
"platform": "linux"
},
{
"path": "{{oracleJdks}}/jdk-16_windows-x64",
"platform": "windows"
}
]
}
}
},
}</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;assemble&gt;
&lt;jlinks&gt;
&lt;jlink&gt;
&lt;name&gt;app&lt;/name&gt;
&lt;active&gt;ALWAYS&lt;/active&gt;
&lt;mainJar&gt;
&lt;path&gt;target/{{distributionName}}-{{projectVersion}}.jar&lt;/path&gt;
&lt;/mainJar&gt;
&lt;jdk&gt;
&lt;path&gt;{{oracleJdks}}/jdk-16_osx-x64/Contents/Home&lt;/path&gt;
&lt;platform&gt;osx&lt;/platform&gt;
&lt;/jdk&gt;
&lt;targetJdks&gt;
&lt;targetJdk&gt;
&lt;path&gt;{{oracleJdks}}/jdk-16_osx-x64/Contents/Home&lt;/path&gt;
&lt;platform&gt;osx&lt;/platform&gt;
&lt;/targetJdk&gt;
&lt;targetJdk&gt;
&lt;path&gt;{{oracleJdks}}/jdk-16_linux-x64&lt;/path&gt;
&lt;platform&gt;linux&lt;/platform&gt;
&lt;/targetJdk&gt;
&lt;targetJdk&gt;
&lt;path&gt;{{oracleJdks}}/jdk-16_windows-x64&lt;/path&gt;
&lt;platform&gt;windows&lt;/platform&gt;
&lt;/targetJdk&gt;
&lt;/targetJdks&gt;
&lt;/jlink&gt;
&lt;/jlinks&gt;
&lt;/assemble&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 {
assemble {
jlinks {
app {
active = 'ALWAYS'
mainJar {
path = 'target/{{distributionName}}-{{projectVersion}}.jar'
}
jdk {
path = '{{oracleJdks}}/jdk-16_osx-x64/Contents/Home'
platform = 'osx'
}
targetJdk {
path = '{{oracleJdks}}/jdk-16_osx-x64/Contents/Home'
platform = 'osx'
}
targetJdk {
path = '{{oracleJdks}}/jdk-16_linux-x64'
platform = 'linux'
}
targetJdk {
path = '{{oracleJdks}}/jdk-16_windows-x64'
platform = 'windows'
}
}
}
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
<div class="paragraph">
<p><strong>Transform</strong></p>
</div>
<div class="paragraph">
<p>JReleaser itself uses the <code>transform</code> property to rename its artifacts depending on the type of release.</p>
</div>
<div class="listingblock">
<div class="title">jreleaser.yml</div>
<div class="content">
<pre class="highlightjs highlight"><code class="language-yaml hljs" data-lang="yaml">distributions:
jreleaser:
artifacts:
- path: apps/{{distributionName}}/build/distributions/{{distributionName}}-{{projectVersion}}.zip
transform: '{{distributionName}}/{{distributionName}}-{{projectEffectiveVersion}}.zip'
jreleaser-ant-tasks:
artifacts:
- path: plugins/{{distributionName}}/build/distributions/{{distributionName}}-{{projectVersion}}.zip
transform: '{{distributionName}}/{{distributionName}}-{{projectEffectiveVersion}}.zip'
jreleaser-tool-provider:
type: SINGLE_JAR
artifacts:
- path: apps/jreleaser-tool-provider/build/libs/jreleaser-tool-provider-{{projectVersion}}.jar
transform: 'jreleaser-tool-provider/jreleaser-tool-provider-{{projectEffectiveVersion}}.jar'</code></pre>
</div>
</div>
<div class="paragraph">
<p>Artifacts point to these files when the project version is snapshot:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-sh hljs" data-lang="sh">out
└── jreleaser
└── artifacts
├── jreleaser
│ └── jreleaser-early-access.zip
├── jreleaser-ant-tasks
│ └── jreleaser-ant-tasks-early-access.zip
└── jreleaser-tool-provider
└── jreleaser-tool-provider-early-access.jar</code></pre>
</div>
</div>
<div class="paragraph">
<p>Whereas the following files will be used when the project is release:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-sh hljs" data-lang="sh">.
├── apps
│ ├── jreleaser
│ │ └── build
│ │ └── distributions
│ │ └── jreleaser-0.3.0.zip
│ └── jreleaser-tool-provider
│ └── build
│ └── libs
│ └── jreleaser-tool-provider-0.3.0.jar
└── plugins
└── jreleaser-ant-tasks
└── build
└── distributions
└── jreleaser-ant-tasks-0.3.0.zip</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>
Reference in New Issue View Git Blame Copy Permalink