mirror of
https://github.com/jlengrand/jreleaser.github.io.git
synced 2026-03-10 08:31:25 +00:00
1946 lines
78 KiB
HTML
1946 lines
78 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
|
<title>GitLab :: JReleaser</title>
|
|
<link rel="canonical" href="https://jreleaser.org/guide/latest/configuration/release/gitlab.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 & 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="index.html">Release</a>
|
|
<ul class="nav-list">
|
|
<li class="nav-item" data-depth="3">
|
|
<a class="nav-link" href="github.html">GitHub</a>
|
|
</li>
|
|
<li class="nav-item is-current-page" data-depth="3">
|
|
<a class="nav-link" href="gitlab.html">GitLab</a>
|
|
</li>
|
|
<li class="nav-item" data-depth="3">
|
|
<a class="nav-link" href="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="../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">
|
|
<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’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">Release</a></li>
|
|
<li><a href="gitlab.html">GitLab</a></li>
|
|
</ul>
|
|
</nav>
|
|
<div class="edit-this-page"><a href="https://github.com/jreleaser/jreleaser.github.io/edit/main/docs/modules/configuration/pages/release/gitlab.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">GitLab</h1>
|
|
<div id="preamble">
|
|
<div class="sectionbody">
|
|
<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-exclamation-triangle"></i></span>
|
|
release:
|
|
# Repo in which the release will be created.
|
|
# <span class="icon"><i class="fa fa-exclamation-triangle"></i></span>
|
|
gitlab:
|
|
# Disables or enables publication to GitLab.
|
|
# defaults to `true`.
|
|
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
enabled: true
|
|
|
|
# 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
|
|
|
|
# The user or organization that owns the repository.
|
|
# If unspecified, will read it from the 'origin' git remote.
|
|
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
owner: duke
|
|
|
|
# The name of the repository.
|
|
# If unspecified, will read it from the 'origin' git remote.
|
|
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
name: app
|
|
|
|
# The GitLab host url.
|
|
# Defaults to `gitlab.com`.
|
|
# <span class="icon"><i class="fa fa-exclamation-triangle"></i></span>
|
|
host: gitlab.com
|
|
|
|
# Username used for authoring commits. Must have write access to the repository.
|
|
# <span class="icon"><i class="fa fa-exclamation-triangle"></i></span>
|
|
username: duke
|
|
|
|
# Password or OAuth token with write access to the repository.
|
|
# If left unspecified, the `JRELEASER_GITLAB_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__
|
|
|
|
# The tag associated with the release.
|
|
# May define a `JRELEASER_TAG_NAME` environment variable instead.
|
|
# If left unspecified, will use `v{{projectVersion}}`.
|
|
# <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>
|
|
tagName: v1.0.0
|
|
|
|
# The name of the release.
|
|
# May define a `JRELEASER_RELEASE_NAME` environment variable instead.
|
|
# If left unspecified, will use `Release {{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>
|
|
releaseName: Release v1.0.0
|
|
|
|
# Drops and creates an existing release with matching tag.
|
|
# May define a `JRELEASER_OVERWRITE` environment variable instead.
|
|
# Defaults to `false`.
|
|
# <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-eye-slash"></i></span>
|
|
overwrite: true
|
|
|
|
# Appends artifacts to an existing release with matching tag,
|
|
# useful if `overwrite` is set to `false`.
|
|
# May define a `JRELEASER_UPDATE` environment variable instead.
|
|
# Defaults to `false`.
|
|
# <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-eye-slash"></i></span>
|
|
update: true
|
|
|
|
# Skips creating a tag.
|
|
# Useful when the tag was created externally.
|
|
# May define a `JRELEASER_SKIP_TAG` environment variable instead.
|
|
# Defaults to `false`.
|
|
# <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-eye-slash"></i></span>
|
|
skipTag: false
|
|
|
|
# The GitLab API endpoint to use.
|
|
# You can skip `/api/v4` as it will be added by default.
|
|
# Defaults to `https://gitlab.com`.
|
|
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
apiEndpoint: https://gitlab.com
|
|
|
|
# Git author used to commit to the repository.
|
|
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
commitAuthor:
|
|
# Name used when authoring commits.
|
|
# Defaults to `jreleaserbot`.
|
|
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
name: jreleaserbot
|
|
|
|
# E-mail used when authoring commits.
|
|
# Defaults to `jreleaser@kordamp.org`.
|
|
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
email: jreleaser@kordamp.org
|
|
|
|
# Signs commits with the configured credentials.
|
|
# The <a href="../signing.html" class="page">Signing</a> section must be configured as well.
|
|
# Defaults to `false`.
|
|
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
sign: false
|
|
|
|
# Changelog customization.
|
|
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
changelog:
|
|
# Disables or enables the changelog.
|
|
# defaults to `true`.
|
|
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
enabled: true
|
|
|
|
# Sorts commits in ascending (oldest first) or descending (newer first).
|
|
# Valid values are: `ASC`, `DESC`.
|
|
# Defaults to `DESC`.
|
|
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
sort: DESC
|
|
|
|
# Path to an external file that contains the changelog, read as is.
|
|
# May be a relative path to the configuration file or an absolute path.
|
|
# If unspecified, JReleaser will automatically calculate the changelog.
|
|
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
external: path/to/changelog.md
|
|
|
|
# Create explicit markdown links for commit hashes.
|
|
# 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
|
|
|
|
{{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:
|
|
# Close the milestone (if it exists and still active) upon release.
|
|
# Defaults to `true`.
|
|
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
close: true
|
|
|
|
# The name/title of the milestone.
|
|
# 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}}'
|
|
|
|
# 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>
|
|
branch: main
|
|
|
|
# The following properties define <span class="icon"><i class="fa fa-dot-circle"></i></span> URL formats.
|
|
# Defaults are shown.
|
|
# Review the available <a href="../name-templates.html" class="page">Name Templates</a>.
|
|
|
|
# <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
|
|
repoUrlFormat: https://{{repoHost}}/{{repoOwner}}/{{repoName}}
|
|
|
|
# <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
|
|
repoCloneUrlFormat: https://{{repoHost}}/{{repoOwner}}/{{repoName}}.git
|
|
|
|
# <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
|
|
commitUrlFormat: https://{{repoHost}}/{{repoOwner}}/{{repoName}}/-/commits
|
|
|
|
# <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
|
|
downloadUrlFormat: https://{{repoHost}}/{{repoOwner}}/{{repoName}}/-/releases/{{tagName}}/downloads/{{artifactFileName}}
|
|
|
|
# <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
|
|
releaseNotesUrlFormat: https://{{repoHost}}/{{repoOwner}}/{{repoName}}/-/releases/{{tagName}}
|
|
|
|
# <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
|
|
latestReleaseUrlFormat: https://{{repoHost}}/{{repoOwner}}/{{repoName}}/-/releases/{{tagName}}
|
|
|
|
# <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
|
|
issueTrackerUrlFormat: https://{{repoHost}}/{{repoOwner}}/{{repoName}}/-/issues</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"># Repo in which the release will be created.
|
|
# <span class="icon"><i class="fa fa-exclamation-triangle"></i></span>
|
|
[release.gitlab]
|
|
# Disables or enables publication to Gitea.
|
|
# defaults to `true`.
|
|
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
enabled = true
|
|
|
|
# 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
|
|
|
|
# The user or organization that owns the repository.
|
|
# <span class="icon"><i class="fa fa-exclamation-triangle"></i></span>
|
|
owner = "duke"
|
|
|
|
# The name of the repository.
|
|
# If unspecified, will use ${project.name}.
|
|
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
name = "app"
|
|
|
|
# The GitLab host url.
|
|
# Defaults to `gitlab.com`.
|
|
# <span class="icon"><i class="fa fa-exclamation-triangle"></i></span>
|
|
host = "gitlab.com"
|
|
|
|
# Username used for authoring commits. Must have write access to the repository.
|
|
# <span class="icon"><i class="fa fa-exclamation-triangle"></i></span>
|
|
username = "duke"
|
|
|
|
# Password or OAuth token with write access to the repository.
|
|
# If left unspecified, the `JRELEASER_GITLAB_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__"
|
|
|
|
# The tag associated with the release.
|
|
# May define a `JRELEASER_TAG_NAME` environment variable instead.
|
|
# If left unspecified, will use `v{{projectVersion}}`.
|
|
# <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>
|
|
tagName = "v1.0.0"
|
|
|
|
# The name of the release.
|
|
# If left unspecified, will use `Release {{tagName}}`.
|
|
# May define a `JRELEASER_RELEASE_NAME` 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> <span class="icon"><i class="fa fa-file-alt"></i></span>
|
|
releaseName = "Release v1.0.0"
|
|
|
|
# Drops and creates an existing release with matching tag.
|
|
# May define a `JRELEASER_OVERWRITE` environment variable instead.
|
|
# Defaults to `false`.
|
|
# <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-eye-slash"></i></span>
|
|
overwrit = true
|
|
|
|
# Appends artifacts to an existing release with matching tag,
|
|
# useful if `overwrite` is set to `false`.
|
|
# May define a `JRELEASER_UPDATE` environment variable instead.
|
|
# Defaults to `false`.
|
|
# <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-eye-slash"></i></span>
|
|
update = true
|
|
|
|
# Skips creating a tag.
|
|
# Useful when the tag was created externally.
|
|
# May define a `JRELEASER_SKIP_TAG` environment variable instead.
|
|
# Defaults to `false`.
|
|
# <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-eye-slash"></i></span>
|
|
skipTag = false
|
|
|
|
# The GitLab API endpoint to use.
|
|
# You can skip `/api/v4` as it will be added by default.
|
|
# Defaults to `https://gitlab.com`.
|
|
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
apiEndpoint = "https://gitlab.com"
|
|
|
|
# Git author used to commit to the repository.
|
|
|
|
# Name used when authoring commits.
|
|
# Defaults to `jreleaserbot`.
|
|
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
commitAuthor.name = "jreleaserbot"
|
|
|
|
# E-mail used when authoring commits.
|
|
# Defaults to `jreleaser@kordamp.org`.
|
|
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
commitAuthor.email = "jreleaser@kordamp.org"
|
|
|
|
# Signs commits with the configured credentials.
|
|
# The <a href="../signing.html" class="page">Signing</a> section must be configured as well.
|
|
# Defaults to `false`.
|
|
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
sign = false
|
|
|
|
# Changelog customization.
|
|
|
|
# Disables or enables the changelog.
|
|
# defaults to `true`.
|
|
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
changelog.enabled = true
|
|
|
|
# Sorts commits in ascending (oldest first) or descending (newer first).
|
|
# Valid values are: `ASC`, `DESC`.
|
|
# Defaults to `DESC`.
|
|
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
changelog.sort = "DESC"
|
|
|
|
# Path to an external file that contains the changelog, read as is.
|
|
# May be a relative path to the configuration file or an absolute path.
|
|
# If unspecified, JReleaser will automatically calculate the changelog.
|
|
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
changelog.external = "path/to/changelog.md"
|
|
|
|
# Create explicit markdown links for commit hashes.
|
|
# Defaults to `false`.
|
|
# <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.
|
|
# Defaults to `true`.
|
|
# <span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
milestone.close = true
|
|
|
|
# The name/title of the milestone.
|
|
# 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>
|
|
milestone.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>
|
|
branch = "main"
|
|
|
|
# The following properties define <span class="icon"><i class="fa fa-dot-circle"></i></span> URL formats.
|
|
# Defaults are shown.
|
|
# Review the available <a href="../name-templates.html" class="page">Name Templates</a>.
|
|
|
|
# <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
|
|
repoUrlFormat = "https://{{repoHost}}/{{repoOwner}}/{{repoName}}"
|
|
|
|
# <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
|
|
repoCloneUrlFormat = "https://{{repoHost}}/{{repoOwner}}/{{repoName}}.git"
|
|
|
|
# <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
|
|
commitUrlFormat = "https://{{repoHost}}/{{repoOwner}}/{{repoName}}/-/commits"
|
|
|
|
# <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
|
|
downloadUrlFormat = "https://{{repoHost}}/{{repoOwner}}/{{repoName}}/-/releases/{{tagName}}/downloads/{{artifactFileName}}"
|
|
|
|
# <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
|
|
releaseNotesUrlFormat = "https://{{repoHost}}/{{repoOwner}}/{{repoName}}/-/releases/{{tagName}}"
|
|
|
|
# <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
|
|
latestReleaseUrlFormat = "https://{{repoHost}}/{{repoOwner}}/{{repoName}}/-/releases/{{tagName}}"
|
|
|
|
# <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
|
|
issueTrackerUrlFormat = "https://{{repoHost}}/{{repoOwner}}/{{repoName}}/-/issues"</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-exclamation-triangle"></i></span>
|
|
"release": {
|
|
// Repo in which the release will be created.
|
|
// <span class="icon"><i class="fa fa-exclamation-triangle"></i></span>
|
|
"gitlab": {
|
|
// Disables or enables publication to GitLab.
|
|
// defaults to `true`.
|
|
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
"enabled": true,
|
|
|
|
// 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,
|
|
|
|
// The user or organization that owns the repository.
|
|
// If unspecified, will read it from the 'origin' git remote.
|
|
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
"owner": "duke",
|
|
|
|
// The name of the repository.
|
|
// If unspecified, will read it from the 'origin' git remote.
|
|
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
"name": "app",
|
|
|
|
// The GitLab host url.
|
|
// Defaults to `gitlab.com`.
|
|
// <span class="icon"><i class="fa fa-exclamation-triangle"></i></span>
|
|
"host": "gitlab.com",
|
|
|
|
// Username used for authoring commits. Must have write access to the repository.
|
|
// <span class="icon"><i class="fa fa-exclamation-triangle"></i></span>
|
|
"username": "duke",
|
|
|
|
// Password or OAuth token with write access to the repository.
|
|
// If left unspecified, the `JRELEASER_GITLAB_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__",
|
|
|
|
// The tag associated with the release.
|
|
// May define a `JRELEASER_TAG_NAME` environment variable instead.
|
|
// If left unspecified, will use `v{{projectVersion}}`.
|
|
// <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>
|
|
"tagName": "v1.0.0",
|
|
|
|
// The name of the release.
|
|
// May define a `JRELEASER_RELEASE_NAME` environment variable instead.
|
|
// If left unspecified, will use `Release {{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>
|
|
"releaseName": "Release v1.0.0",
|
|
|
|
// Drops and creates an existing release with matching tag.
|
|
// May define a `JRELEASER_OVERWRITE` environment variable instead.
|
|
// Defaults to `false`.
|
|
// <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-eye-slash"></i></span>
|
|
"overwrite": true,
|
|
|
|
// Appends artifacts to an existing release with matching tag,
|
|
// useful if `overwrite` is set to `false`.
|
|
// May define a `JRELEASER_UPDATE` environment variable instead.
|
|
// Defaults to `false`.
|
|
// <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-eye-slash"></i></span>
|
|
"update": true,
|
|
|
|
// Skips creating a tag.
|
|
// Useful when the tag was created externally.
|
|
// May define a `JRELEASER_SKIP_TAG` environment variable instead.
|
|
// Defaults to `false`.
|
|
// <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-eye-slash"></i></span>
|
|
"skipTag": false,
|
|
|
|
// The GitLab API endpoint to use.
|
|
// You can skip `/api/v4` as it will be added by default.
|
|
// Defaults to `https://gitlab.com`.
|
|
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
"apiEndpoint": "https://gitlab.com",
|
|
|
|
// Git author used to commit to the repository.
|
|
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
"commitAuthor": {
|
|
// Name used when authoring commits.
|
|
// Defaults to `jreleaserbot`.
|
|
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
"name": "jreleaserbot",
|
|
|
|
// E-mail used when authoring commits.
|
|
// Defaults to `jreleaser@kordamp.org`.
|
|
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
"email": "jreleaser@kordamp.org"
|
|
},
|
|
|
|
// Signs commits with the configured credentials.
|
|
// The <a href="../signing.html" class="page">Signing</a> section must be configured as well.
|
|
// Defaults to `false`.
|
|
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
"sign": false,
|
|
|
|
// Changelog customization.
|
|
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
"changelog": {
|
|
// Disables or enables the changelog.
|
|
// defaults to `true`.
|
|
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
"enabled": true,
|
|
|
|
// Sorts commits in ascending (oldest first) or descending (newer first).
|
|
// Valid values are: `ASC`, `DESC`.
|
|
// Defaults to `DESC`.
|
|
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
"sort": "DESC",
|
|
|
|
// Path to an external file that contains the changelog, read as is.
|
|
// May be a relative path to the configuration file or an absolute path.
|
|
// If unspecified, JReleaser will automatically calculate the changelog.
|
|
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
"external": "path/to/changelog.md",
|
|
|
|
// Create explicit markdown links for commit hashes.
|
|
// 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>
|
|
"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": {
|
|
// Close the milestone (if it exists and still open) upon release.
|
|
// Defaults to `true`.
|
|
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
"close": true,
|
|
|
|
// The name/title of the milestone.
|
|
// 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}}"
|
|
},
|
|
|
|
// 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>
|
|
"branch": "main",
|
|
|
|
// The following properties define <span class="icon"><i class="fa fa-dot-circle"></i></span> URL formats.
|
|
// Defaults are shown.
|
|
// Review the available <a href="../name-templates.html" class="page">Name Templates</a>.
|
|
|
|
// <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
|
|
"repoUrlFormat": "https://{{repoHost}}/{{repoOwner}}/{{repoName}}",
|
|
|
|
// <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
|
|
"repoCloneUrlFormat": "https://{{repoHost}}/{{repoOwner}}/{{repoName}}.git",
|
|
|
|
// <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
|
|
"commitUrlFormat": "https://{{repoHost}}/{{repoOwner}}/{{repoName}}/-/commits",
|
|
|
|
// <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
|
|
"downloadUrlFormat": "https://{{repoHost}}/{{repoOwner}}/{{repoName}}/-/releases/{{tagName}}/downloads/{{artifactFileName}}",
|
|
|
|
// <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
|
|
"releaseNotesUrlFormat": "https://{{repoHost}}/{{repoOwner}}/{{repoName}}/-/releases/{{tagName}}",
|
|
|
|
// <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
|
|
"latestReleaseUrlFormat": "https://{{repoHost}}/{{repoOwner}}/{{repoName}}/-/releases/{{tagName}}",
|
|
|
|
// <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
|
|
"issueTrackerUrlFormat": "https://{{repoHost}}/{{repoOwner}}/{{repoName}}/-/issues"
|
|
}
|
|
}
|
|
}</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"><jreleaser>
|
|
<!--
|
|
<span class="icon"><i class="fa fa-exclamation-triangle"></i></span>
|
|
-->
|
|
<release>
|
|
<!--
|
|
Repo in which the release will be created.
|
|
<span class="icon"><i class="fa fa-exclamation-triangle"></i></span>
|
|
-->
|
|
<gitlab>
|
|
|
|
<!--
|
|
Disables or enables publication to GitLab.
|
|
defaults to `true`.
|
|
<span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
-->
|
|
<enabled>true</enabled>
|
|
|
|
<!--
|
|
Defines the connection timeout in seconds.
|
|
Defaults to `20`.
|
|
<span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
-->
|
|
<connectTimeout>20</connectTimeout>
|
|
|
|
<!--
|
|
Defines the read timeout in seconds.
|
|
Defaults to `60`.
|
|
<span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
-->
|
|
<readTimeout>60</readTimeout>
|
|
|
|
<!--
|
|
The user or organization that owns the repository.
|
|
If unspecified, will read it from the 'origin' git remote.
|
|
<span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
-->
|
|
<owner>duke</owner>
|
|
|
|
<!--
|
|
The name of the repository.
|
|
If unspecified, will read it from the 'origin' git remote.
|
|
<span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
-->
|
|
<name>app</name>
|
|
|
|
<!--
|
|
The GitLab host url.
|
|
Defaults to `gitlab.com`.
|
|
<span class="icon"><i class="fa fa-exclamation-triangle"></i></span>
|
|
-->
|
|
<host>gitlab.com</host>
|
|
|
|
<!--
|
|
Username used for authoring commits. Must have write access to the repository.
|
|
<span class="icon"><i class="fa fa-exclamation-triangle"></i></span>
|
|
-->
|
|
<username>duke</username>
|
|
|
|
<!--
|
|
Password or OAuth token with write access to the repository.
|
|
If left unspecified, the `JRELEASER_GITLAB_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__</token>
|
|
|
|
<!--
|
|
The tag associated with the release.
|
|
May define a `JRELEASER_TAG_NAME` environment variable instead.
|
|
If left unspecified, will use `v{{projectVersion}}`.
|
|
<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>
|
|
-->
|
|
<tagName>v1.0.0</tagName>
|
|
|
|
<!--
|
|
The name of the release.
|
|
May define a `JRELEASER_RELEASE_NAME` environment variable instead.
|
|
If left unspecified, will use `Release {{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>
|
|
-->
|
|
<releaseName>Release v1.0.0</releaseName>
|
|
|
|
<!--
|
|
Drops and creates an existing release with matching tag.
|
|
May define a `JRELEASER_OVERWRITE` environment variable instead.
|
|
Defaults to `false`.
|
|
<span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-eye-slash"></i></span>
|
|
-->
|
|
<overwrite>true</overwrite>
|
|
|
|
<!--
|
|
Appends artifacts to an existing release with matching tag,
|
|
useful if `overwrite` is set to `false`.
|
|
May define a `JRELEASER_UPDATE` environment variable instead.
|
|
Defaults to `false`.
|
|
<span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-eye-slash"></i></span>
|
|
-->
|
|
<update>true</update>
|
|
|
|
<!--
|
|
Skips creating a tag.
|
|
Useful when the tag was created externally.
|
|
May define a `JRELEASER_SKIP_TAG` environment variable instead.
|
|
Defaults to `false`.
|
|
<span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-eye-slash"></i></span>
|
|
-->
|
|
<skipTag>false</skipTag>
|
|
|
|
<!--
|
|
The GitLab API endpoint to use.
|
|
You can skip `/api/v4` as it will be added by default.
|
|
Defaults to `https://gitlab.com`.
|
|
<span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
-->
|
|
<apiEndpoint>https://gitlab.com</apiEndpoint>
|
|
|
|
<!--
|
|
Git author used to commit to the repository.
|
|
<span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
-->
|
|
<commitAuthor>
|
|
|
|
<!--
|
|
Name used when authoring commits.
|
|
Defaults to `jreleaserbot`.
|
|
<span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
-->
|
|
<name>jreleaserbot</name>
|
|
|
|
<!--
|
|
E-mail used when authoring commits.
|
|
Defaults to `jreleaser@kordamp.org`.
|
|
<span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
-->
|
|
<email>jreleaser@kordamp.org</email>
|
|
</commitAuthor>
|
|
|
|
<!--
|
|
Signs commits with the configured credentials.
|
|
The <a href="../signing.html" class="page">Signing</a> section must be configured as well.
|
|
Defaults to `false`.
|
|
<span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
-->
|
|
<sign>false</sign>
|
|
|
|
<!--
|
|
Changelog customization.
|
|
<span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
-->
|
|
<changelog>
|
|
|
|
<!--
|
|
Disables or enables the changelog.
|
|
defaults to `true`.
|
|
<span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
-->
|
|
<enabled>true</enabled>
|
|
|
|
<!--
|
|
Sorts commits in ascending (oldest first) or descending (newer first).
|
|
Valid values are>`ASC`, `DESC`.
|
|
Defaults to `DESC`.
|
|
<span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
-->
|
|
<sort>DESC</sort>
|
|
|
|
<!--
|
|
Path to an external file that contains the changelog, read as is.
|
|
May be a relative path to the configuration file or an absolute path.
|
|
If unspecified, JReleaser will automatically calculate the changelog.
|
|
<span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
-->
|
|
<external>path/to/changelog.md</external>
|
|
|
|
<!--
|
|
Create explicit markdown links for commit hashes.
|
|
Defaults to `false`.
|
|
<span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
-->
|
|
<links>false</links>
|
|
|
|
<!--
|
|
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</formatted>
|
|
|
|
<!--
|
|
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}}</change>
|
|
|
|
<!--
|
|
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}}
|
|
</content>
|
|
|
|
<!--
|
|
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</contentTemplate>
|
|
|
|
<!--
|
|
Hide uncategorized commits.
|
|
Defaults to `false`.
|
|
<span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
-->
|
|
<hideUncategorized>true</hideUncategorized>
|
|
|
|
<!--
|
|
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>
|
|
<includeLabel>issue</includeLabel>
|
|
</includeLabels>
|
|
|
|
<!--
|
|
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>
|
|
<excludeLabel>issue</excludeLabel>
|
|
</excludeLabels>
|
|
|
|
<!--
|
|
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>
|
|
<labeler>
|
|
<!--
|
|
The label to be applied.
|
|
<span class="icon"><i class="fa fa-exclamation-triangle"></i></span>
|
|
-->
|
|
<label>issue</label>
|
|
|
|
<!--
|
|
Matches the text of the first commit line.
|
|
<span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
-->
|
|
<title>^fix:</title>
|
|
|
|
<!--
|
|
Matches the full text of the commit.
|
|
<span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
-->
|
|
<body>Fixes #</body>
|
|
</labeler>
|
|
</labelers>
|
|
|
|
<!--
|
|
Groups changes by category.
|
|
Defaults are shown.
|
|
<span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
-->
|
|
<categories>
|
|
<category>
|
|
<title>🚀 Features</title>
|
|
<labelsAsString>feature,enhancement</labelsAsString>
|
|
</category>
|
|
<category>
|
|
<title>🐛 Bug Fixes</title>
|
|
<labelsAsString>bug,fix</labelsAsString>
|
|
</category>
|
|
</categories>
|
|
|
|
<!--
|
|
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>
|
|
<replacer>
|
|
<search>\[chore\]\s</search>
|
|
</replacer>
|
|
<replacer>
|
|
<search>/CVE-(\d{4})-(\d+)/g</search>
|
|
<replace>https: cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-$1-$2</replace>
|
|
</replacer>
|
|
</replacers>
|
|
</changelog>
|
|
|
|
<!--
|
|
A milestone associated with the release
|
|
<span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
-->
|
|
<milestone>
|
|
|
|
<!--
|
|
Close the milestone (if it exists and still open) upon release.
|
|
Defaults to `true`.
|
|
<span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
-->
|
|
<close>true</close>
|
|
|
|
<!--
|
|
The name/title of the milestone.
|
|
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>
|
|
</milestone>
|
|
<!--
|
|
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>
|
|
-->
|
|
<branch>main</branch>
|
|
|
|
<!--
|
|
The following properties define <span class="icon"><i class="fa fa-dot-circle"></i></span> URL formats.
|
|
Defaults are shown.
|
|
Review the available <a href="../name-templates.html" class="page">Name Templates</a>.
|
|
-->
|
|
|
|
<!--
|
|
<span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
|
|
-->
|
|
<repoUrlFormat>https://{{repoHost}}/{{repoOwner}}/{{repoName}}</repoUrlFormat>
|
|
|
|
<!--
|
|
<span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
|
|
-->
|
|
<repoCloneUrlFormat>https://{{repoHost}}/{{repoOwner}}/{{repoName}}.git</repoCloneUrlFormat>
|
|
|
|
<!--
|
|
<span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
|
|
-->
|
|
<commitUrlFormat>https://{{repoHost}}/{{repoOwner}}/{{repoName}}/-/commits</commitUrlFormat>
|
|
|
|
<!--
|
|
<span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
|
|
-->
|
|
<downloadUrlFormat>https://{{repoHost}}/{{repoOwner}}/{{repoName}}/-/releases/{{tagName}}/downloads/{{artifactFileName}}</downloadUrlFormat>
|
|
|
|
<!--
|
|
<span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
|
|
-->
|
|
<releaseNotesUrlFormat>https://{{repoHost}}/{{repoOwner}}/{{repoName}}/-/releases/{{tagName}}</releaseNotesUrlFormat>
|
|
|
|
<!--
|
|
<span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
|
|
-->
|
|
<latestReleaseUrlFormat>https://{{repoHost}}/{{repoOwner}}/{{repoName}}/-/releases/{{tagName}}</latestReleaseUrlFormat>
|
|
|
|
<!--
|
|
<span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
|
|
-->
|
|
<issueTrackerUrlFormat>https://{{repoHost}}/{{repoOwner}}/{{repoName}}/-/issues</issueTrackerUrlFormat>
|
|
</gitlab>
|
|
</release>
|
|
</jreleaser></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-exclamation-triangle"></i></span>
|
|
release {
|
|
// Repo in which the release will be created.
|
|
// <span class="icon"><i class="fa fa-exclamation-triangle"></i></span>
|
|
gitlab {
|
|
// Disables or enables publication to GitLab.
|
|
// defaults to `true`.
|
|
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
enabled = true
|
|
|
|
// 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
|
|
|
|
// The user or organization that owns the repository.
|
|
// If unspecified, will read it from the 'origin' git remote.
|
|
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
owner = 'duke'
|
|
|
|
// The name of the repository.
|
|
// If unspecified, will read it from the 'origin' git remote.
|
|
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
name = 'app'
|
|
|
|
// The GitLab host url.
|
|
// Defaults to `gitlab.com`.
|
|
// <span class="icon"><i class="fa fa-exclamation-triangle"></i></span>
|
|
host = 'gitlab.com'
|
|
|
|
// Username used for authoring commits. Must have write access to the repository.
|
|
// <span class="icon"><i class="fa fa-exclamation-triangle"></i></span>
|
|
username = 'duke'
|
|
|
|
// Password or OAuth token with write access to the repository.
|
|
// If left unspecified, the `JRELEASER_GITLAB_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__'
|
|
|
|
// The tag associated with the release.
|
|
// May define a `JRELEASER_TAG_NAME` environment variable instead.
|
|
// If left unspecified, will use `v{{projectVersion}}`.
|
|
// <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>
|
|
tagName = 'v1.0.0'
|
|
|
|
// The name of the release.
|
|
// May define a `JRELEASER_RELEASE_NAME` environment variable instead.
|
|
// If left unspecified, will use `Release {{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>
|
|
releaseName = 'Release v1.0.0'
|
|
|
|
// Drops and creates an existing release with matching tag.
|
|
// May define a `JRELEASER_OVERWRITE` environment variable instead.
|
|
// Defaults to `false`.
|
|
// <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-eye-slash"></i></span>
|
|
overwrite = true
|
|
|
|
// Appends artifacts to an existing release with matching tag,
|
|
// useful if `overwrite` is set to `false`.
|
|
// May define a `JRELEASER_UPDATE` environment variable instead.
|
|
// Defaults to `false`.
|
|
// <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-eye-slash"></i></span>
|
|
update = true
|
|
|
|
// Skips creating a tag.
|
|
// Useful when the tag was created externally.
|
|
// May define a `JRELEASER_SKIP_TAG` environment variable instead.
|
|
// Defaults to `false`.
|
|
// <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-eye-slash"></i></span>
|
|
skipTag = false
|
|
|
|
// The GitLab API endpoint to use.
|
|
// You can skip `/api/v4` as it will be added by default.
|
|
// Defaults to `https://gitlab.com`.
|
|
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
apiEndpoint = 'https://gitlab.com'
|
|
|
|
// Git author used to commit to the repository.
|
|
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
commitAuthor {
|
|
// Name used when authoring commits.
|
|
// Defaults to `jreleaserbot`.
|
|
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
name = 'jreleaserbot'
|
|
|
|
// E-mail used when authoring commits.
|
|
// Defaults to `jreleaser@kordamp.org`.
|
|
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
email = 'jreleaser@kordamp.org'
|
|
}
|
|
|
|
// Signs commits with the configured credentials.
|
|
// The <a href="../signing.html" class="page">Signing</a> section must be configured as well.
|
|
// Defaults to `false`.
|
|
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
sign = false
|
|
|
|
// Changelog customization.
|
|
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
changelog {
|
|
// Disables or enables the changelog.
|
|
// defaults to `true`.
|
|
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
enabled = true
|
|
|
|
// Sorts commits in ascending (oldest first) or descending (newer first).
|
|
// Valid values are = `ASC`, `DESC`.
|
|
// Defaults to `DESC`.
|
|
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
sort = 'DESC'
|
|
|
|
// Path to an external file that contains the changelog, read as is.
|
|
// May be a relative path to the configuration file or an absolute path.
|
|
// If unspecified, JReleaser will automatically calculate the changelog.
|
|
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
external = 'path/to/changelog.md'
|
|
|
|
// Create explicit markdown links for commit hashes.
|
|
// 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
|
|
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
milestone {
|
|
// Close the milestone (if it exists and still active) upon release.
|
|
// Defaults to `true`.
|
|
// <span class="icon"><i class="fa fa-dot-circle"></i></span>
|
|
close = true
|
|
|
|
// The name/title of the milestone.
|
|
// 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}}'
|
|
}
|
|
|
|
// 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>
|
|
branch = 'main'
|
|
|
|
// The following properties define <span class="icon"><i class="fa fa-dot-circle"></i></span> URL formats.
|
|
// Defaults are shown.
|
|
// Review the available <a href="../name-templates.html" class="page">Name Templates</a>.
|
|
|
|
// <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
|
|
repoUrlFormat = 'https://{{repoHost}}/{{repoOwner}}/{{repoName}}'
|
|
|
|
// <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
|
|
repoCloneUrlFormat = 'https://{{repoHost}}/{{repoOwner}}/{{repoName}}.git'
|
|
|
|
// <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
|
|
commitUrlFormat = 'https://{{repoHost}}/{{repoOwner}}/{{repoName}}/-/commits'
|
|
|
|
// <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
|
|
downloadUrlFormat = 'https://{{repoHost}}/{{repoOwner}}/{{repoName}}/-/releases/{{tagName}}/downloads/{{artifactFileName}}'
|
|
|
|
// <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
|
|
releaseNotesUrlFormat = 'https://{{repoHost}}/{{repoOwner}}/{{repoName}}/-/releases/{{tagName}}'
|
|
|
|
// <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
|
|
latestReleaseUrlFormat = 'https://{{repoHost}}/{{repoOwner}}/{{repoName}}/-/releases/{{tagName}}'
|
|
|
|
// <span class="icon"><i class="fa fa-dot-circle"></i></span> <span class="icon"><i class="fa fa-file-alt"></i></span>
|
|
issueTrackerUrlFormat = 'https://{{repoHost}}/{{repoOwner}}/{{repoName}}/-/issues'
|
|
}</code></pre>
|
|
</div>
|
|
</div>
|
|
</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’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>
|
|
</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>
|