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

Document model updates

Browse Source
This commit is contained in:
Andres Almiray
2021-04-12 18:52:09 +02:00
parent a0957c09e2
commit 1c19f5a7f2
10 changed files with 258 additions and 111 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/modules/ROOT/pages/distributions/single-jar.adoc
View File

@@ -34,7 +34,7 @@ Make sure to make the JAR executable by setting the `Main-Class` manifest entry.
| xref:configuration:packagers/docker.adoc[] | {icon_req_y}
| xref:configuration:packagers/homebrew.adoc[] | {icon_req_y}
| xref:configuration:packagers/jbang.adoc[] | {icon_req_y}
| xref:configuration:packagers/scoop.adoc[] | {icon_req_n}
| xref:configuration:packagers/scoop.adoc[] | {icon_req_y}
| xref:configuration:packagers/snap.adoc[] | {icon_req_y}
|===

6
docs/modules/configuration/pages/environment.adoc
View File

@@ -89,6 +89,7 @@ jreleaser {
[%header, cols="<1,<1", width="100%"]
|===
| Key | Description
| JRELEASER_PROJECT_NAME | the project name
| JRELEASER_PROJECT_VERSION | the project version
| JRELEASER_SNAPSHOT_PATTERN | a regex to determine if the project version is snapshot
|===
@@ -101,6 +102,11 @@ jreleaser {
| JRELEASER_TAG_NAME | the release tag name
| JRELEASER_RELEASE_NAME | the release name
| JRELEASER_MILESTONE_NAME | the milestone name/title
| JRELEASER_BRANCH | the release branch (targetCommitish/ref)
| JRELEASER_OVERWRITE | overwrite an existing release
| JRELEASER_UPDATE | update an existing release
| JRELEASER_SKIP_TAG | skip tagging the release
| JRELEASER_PRERELEASE | release is a prerelease (github/gitea)
| JRELEASER_GITHUB_TOKEN | a GitHub token with `repo` scope
| JRELEASER_GITLAB_TOKEN | a Gitlab token with `api` scope
| JRELEASER_GITEA_TOKEN | a Gitea personal token

5
docs/modules/configuration/pages/name-templates.adoc
View File

@@ -375,6 +375,7 @@ The following names are related to xref:configuration:packagers/homebrew.adoc[]
| Key | Description
| brewTapRepoUrl | the tap repository URL, `pass:[https://{{repoHost}}/{{repoOwner}}/{{repoName}}]`
| brewTapRepoCloneUrl | the tap repository clone URL, `pass:[https://{{repoHost}}/{{repoOwner}}/{{repoName}}.git]`
| brewFormulaName | the formula name. Defaults to `{{projectNameCapitalized}}`
| brewDependencies | a map of key/value pairs
|===
@@ -620,8 +621,8 @@ The following names are related to xref:configuration:packagers/jbang.adoc[]
| Key | Description
| jbangCatalogRepoUrl | the catalog repository URL, `pass:[https://{{repoHost}}/{{repoOwner}}/{{repoName}}]`
| jbangCatalogRepoCloneUrl | the catalog repository clone URL, `pass:[https://{{repoHost}}/{{repoOwner}}/{{repoName}}.git]`
| jbangAliasName | the name of the jbang alias, `{{distributionName}}` or `{{distributionName}}-snapshot`
| jbangAliasClassName | the name of the Jbang executable, `{{distributionName}}` or `{{distributionName}}_snapshot`
| jbangAliasName | the name of the jbang alias, `{{distributionExecutable}}` or `{{distributionExecutable}}-snapshot`
| jbangScriptName | the name of the Jbang executable, `{{distributionExecutable}}` or `{{distributionExecutable}}_snapshot`
| jbangDistributionGA a| calculated Maven coordinates for link:https://jitpack.io[]
single:: `{{reverseRepoHost}}.{{repoOwner}}:{{distributionArtifactId}` +

24
docs/modules/configuration/pages/packagers/homebrew.adoc
View File

@@ -32,6 +32,11 @@ packagers:
# icon:dot-circle[]
templateDirectory: path/to/brew/templates
# The class name of the generated formula.
# If left unspecified, will use `{{projectNameCapitalized}}`.
# icon:dot-circle[] icon:file-alt[]
formulaName: App
# A map of Homebrew dependencies.
# The key `openjdk@${java.version}` will be added automatically if not defined.
# icon:dot-circle[]
@@ -118,6 +123,11 @@ JSON::
// icon:dot-circle[]
"templateDirectory": "path/to/brew/templates",
// The class name of the generated formula.
// If left unspecified, will use `{{projectNameCapitalized}}`.
// icon:dot-circle[] icon:file-alt[]
"formulaName": "App",
// A map of Homebrew dependencies.
// The key `openjdk@${java.version}` will be added automatically if not defined.
// icon:dot-circle[]
@@ -219,6 +229,13 @@ Maven::
-->
<templateDirectory>>path/to/brew/templates</templateDirectory>
<!--
The class name of the generated formula.
If left unspecified, will use `{{projectNameCapitalized}}`.
icon:dot-circle[] icon:file-alt[]
-->
<formulaName>App</formulaName>
<!--
A map of Homebrew dependencies.
The key `openjdk@${java.version}` will be added automatically if not defined.
@@ -353,6 +370,11 @@ jreleaser {
// icon:dot-circle[]
templateDirectory = 'path/to/brew/templates'
// The class name of the generated formula.
// If left unspecified, will use `{{projectNameCapitalized}}`.
// icon:dot-circle[] icon:file-alt[]
formulaName = 'App'
// A map of Homebrew dependencies.
// The key `openjdk@${java.version}` will be added automatically if not defined.
// icon:dot-circle[]
@@ -428,6 +450,8 @@ jreleaser {
NOTE: The tap token environment variable must match with the chosen xref:release/index.adoc[] service, that is, it must
be one of [`JRELEASER_HOMEBREW_GITHUB_TOKEN`, `JRELEASER_HOMEBREW_GITLAB_TOKEN`, `JRELEASER_HOMEBREW_GITEA_TOKEN`].
IMPORTANT: Formula names must be unique!
Assuming that the current version is `1.2.3`, and a distribution named `app`, the above configuration will generate
a `app.rb` formula in the `duke/homebrew-tap` repository:

10
docs/modules/configuration/pages/packagers/jbang.adoc
View File

@@ -39,7 +39,7 @@ packagers:
foo: bar
# The jbang executable alias.
# If left undefined, will use `${distribution.name}`
# If left undefined, will use `${distribution.executable}`
# icon:dot-circle[]
alias: cli
@@ -111,7 +111,7 @@ JSON::
},
// The jbang executable alias.
// If left undefined, will use `${distribution.name}`
// If left undefined, will use `${distribution.executable}`
// icon:dot-circle[]
"alias": "cli",
@@ -201,7 +201,7 @@ Maven::
<!--
The jbang executable alias.
If left undefined, will use `${distribution.name}`
If left undefined, will use `${distribution.executable}`
icon:dot-circle[]
-->
<alias>cli</alias>
@@ -294,7 +294,7 @@ jreleaser {
extraProperties.put('foo', 'bar')
// The jbang executable alias.
// If left undefined, will use `${distribution.name}`
// If left undefined, will use `${distribution.executable}`
// icon:dot-circle[]
alias = 'cli'
@@ -352,6 +352,8 @@ NOTE: You must define a value for `java.mainClass` in the owning distribution.
NOTE: When the project's version is snapshot, unless manually updated, the default prepared template assumes JARs may be
resolved from link:https://jitpack.io[].
IMPORTANT: Aliases must be unique!
Assuming that the current version is `1.2.3`, and a distribution named `app`, the above configuration will generate
a `app.java` file in the `duke/jbang-catalog` repository:

2
docs/modules/configuration/pages/packagers/scoop.adoc
View File

@@ -4,7 +4,7 @@ JReleaser can generate and publish a _Scoop App Manifest_ into a repository that
The `scoop` section specifies how the manifest should be created.
NOTE: At the moment, only artifacts with `.zip` extension may be packaged with Scoop.
NOTE: Only artifacts with `.zip`, `.jar` extension may be packaged with Homebrew.
WARNING: Snapshots are *not* supported.

55
docs/modules/configuration/pages/project.adoc
View File

@@ -14,7 +14,8 @@ YAML::
# icon:exclamation-triangle[]
project:
# The name of the project.
# icon:exclamation-triangle[]
# May define a `JRELEASER_PROJECT_NAME` environment variable instead.
# icon:exclamation-triangle[] icon:eye-slash[]
name: app
# The version to be released.
@@ -28,22 +29,22 @@ project:
snapShotPattern: .*-SNAPSHOT
# A short description (60 chars max).
# icon:exclamation-triangle[]
# icon:exclamation-triangle[] Only if configured distributions or announcers.
description: My awesome app
# A more thorough explanation of the project's capabilities.
# May use markdown syntax.
# If left unspecified, will use the value of `description`.
# icon:dot-circle[]
# icon:dot-circle[] Only if configured distributions or announcers.
longDescription: |
My Awesome app is the bees knees
# The project's website.
# icon:exclamation-triangle[]
# icon:exclamation-triangle[] Only if configured distributions or announcers.
website: pass:[https://acme.com/app]
# A list of author names.
# icon:exclamation-triangle[]
# icon:exclamation-triangle[] Only if configured distributions or announcers.
authors:
- Duke
@@ -56,7 +57,7 @@ project:
# The project's license.
# It's recommended to use a valid SPDX identifier if the project is Open Source.
# See link:https://spdx.org/licenses[].
# icon:exclamation-triangle[]
# icon:exclamation-triangle[] Only if configured distributions or announcers.
license: Apache-2.0
# Additional properties used when evaluating templates.
@@ -100,8 +101,8 @@ JSON::
{
// icon:exclamation-triangle[]
"project": {
// The name of the project.
// icon:exclamation-triangle[]
// May define a `JRELEASER_PROJECT_NAME` environment variable instead.
// icon:exclamation-triangle[] icon:eye-slash[]
"name": "app",
// The version to be released.
@@ -115,21 +116,21 @@ JSON::
"snapShotPattern": ".*-SNAPSHOT",
// A short description (60 chars max).
// icon:exclamation-triangle[]
// icon:exclamation-triangle[] Only if configured distributions or announcers.
"description": "My awesome app",
// A more thorough explanation of the project's capabilities.
// May use markdown syntax.
// If left unspecified, will use the value of `description`.
// icon:dot-circle[]
// icon:dot-circle[] Only if configured distributions or announcers.
"longDescription": "My Awesome app is the bees knees",
// The project's website.
// icon:exclamation-triangle[]
// icon:exclamation-triangle[] Only if configured distributions or announcers.
"website": "pass:[https://acme.com/app]",
// A list of author names.
// icon:exclamation-triangle[]
// icon:exclamation-triangle[] Only if configured distributions or announcers.
"authors": [
"Duke"
],
@@ -144,7 +145,7 @@ JSON::
// The project's license.
// It's recommended to use a valid SPDX identifier if the project is Open Source.
// See link:https://spdx.org/licenses[].
// icon:exclamation-triangle[]
// icon:exclamation-triangle[] Only if configured distributions or announcers.
"license": "Apache-2.0",
// Additional properties used when evaluating templates.
@@ -195,8 +196,8 @@ Maven::
-->
<project>
<!--
The name of the project.
icon:exclamation-triangle[]
May define a `JRELEASER_PROJECT_NAME` environment variable instead.
icon:exclamation-triangle[] icon:eye-slash[]
-->
<name>app</name>
@@ -218,7 +219,7 @@ Maven::
<!--
A short description (60 chars max).
If undefined, will use ${project.description} from Maven.
icon:exclamation-triangle[]
icon:exclamation-triangle[] Only if configured distributions or announcers.
-->
<description>My awesome app</description>
@@ -226,7 +227,7 @@ Maven::
A more thorough explanation of the project's capabilities.
May use markdown syntax.
If left unspecified, will use the value of `description`.
icon:dot-circle[]
icon:dot-circle[] Only if configured distributions or announcers.
-->
<longDescription>
My Awesome app is the bees knees
@@ -235,7 +236,7 @@ Maven::
<!--
The project's website.
If undefined, will use ${project.url} from Maven.
icon:exclamation-triangle[]
icon:exclamation-triangle[] Only if configured distributions or announcers.
-->
<website>pass:[https://acme.com/app]</website>
@@ -243,7 +244,7 @@ Maven::
A list of author names.
If undefined, will use ${project.developers} from Maven, looking for
matches of <role>author</role>
icon:exclamation-triangle[]
icon:exclamation-triangle[] Only if configured distributions or announcers.
-->
<authors>
<author>Duke</author>
@@ -263,7 +264,7 @@ Maven::
If undefined, will use ${project.licenses} from Maven.
It's recommended to use a valid SPDX identifier if the project is Open Source.
See link:https://spdx.org/licenses[].
icon:exclamation-triangle[]
icon:exclamation-triangle[] Only if configured distributions or announcers.
-->
<license>Apache-2.0</license>
@@ -334,8 +335,8 @@ Gradle::
----
jreleaser {
project {
// The name of the project.
// icon:exclamation-triangle[]
// May define a `JRELEASER_PROJECT_NAME` environment variable instead.
// icon:exclamation-triangle[] icon:eye-slash[]
name = 'app'
// The version to be released.
@@ -350,21 +351,21 @@ jreleaser {
snapShotPattern = '.*-SNAPSHOT'
// A short description (60 chars max).
// icon:exclamation-triangle[]
// icon:exclamation-triangle[] Only if configured distributions or announcers.
description = 'My awesome app'
// A more thorough explanation of the project's capabilities.
// May use markdown syntax.
// If left unspecified, will use the value of `description`.
// icon:dot-circle[]
// icon:dot-circle[] Only if configured distributions or announcers.
longDescription = 'My Awesome app is the bees knees'
// The project's website.
// icon:exclamation-triangle[]
// icon:exclamation-triangle[] Only if configured distributions or announcers.
website = 'pass:[https://acme.com/app]'
// A list of author names.
// icon:exclamation-triangle[]
// icon:exclamation-triangle[] Only if configured distributions or announcers.
authors = ['Duke']
// A list of tags.
@@ -374,7 +375,7 @@ jreleaser {
// The project's license.
// It's recommended to use a valid SPDX identifier if the project is Open Source.
// See link:https://spdx.org/licenses[].
// icon:exclamation-triangle[]
// icon:exclamation-triangle[] Only if configured distributions or announcers.
license = 'Apache-2.0'
// Additional properties used when evaluating templates.

117
docs/modules/configuration/pages/release/gitea.adoc
View File

@@ -55,20 +55,24 @@ release:
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`.
# icon:dot-circle[]
# icon:dot-circle[] icon:eye-slash[]
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`.
# icon:dot-circle[]
allowUploadToExisting: true
# icon:dot-circle[] icon:eye-slash[]
update: true
# Skips creating a tag.
# Useful when the tag was created externally.
# icon:dot-circle[]
skipTagging: false
# May define a `JRELEASER_SKIP_TAG` environment variable instead.
# Defaults to `false`.
# icon:dot-circle[] icon:eye-slash[]
skipTag: false
# The Gitea API endpoint to use.
# You can skip `/api/v4` as it will be added by default.
@@ -134,9 +138,21 @@ release:
name: {{tagName}}
# The target branch to use.
# May define a `JRELEASER_BRANCH` environment variable instead.
# Defaults to `main`.
# icon:dot-circle[] icon:eye-slash[]
targetCommitish: main
# Marks the release as a draft.
# Defaults to `false`.
# icon:dot-circle[]
ref: main
draft: false
# Marks the release as prerelease.
# May define a `JRELEASER_PRERELEASE` environment variable instead.
# Defaults to `false`.
# icon:dot-circle[] icon:eye-slash[]
prerelease: false
# The following properties define icon:dot-circle[] URL formats.
# Defaults are shown.
@@ -215,20 +231,24 @@ JSON::
"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`.
// icon:dot-circle[]
// icon:dot-circle[] icon:eye-slash[]
"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`.
// icon:dot-circle[]
"allowUploadToExisting": true,
// icon:dot-circle[] icon:eye-slash[]
"update": true,
// Skips creating a tag.
// Useful when the tag was created externally.
// icon:dot-circle[]
"skipTagging": false,
// May define a `JRELEASER_SKIP_TAG` environment variable instead.
// Defaults to `false`.
// icon:dot-circle[] icon:eye-slash[]
"skipTag": false,
// The Gitea API endpoint to use.
// You can skip `/api/v4` as it will be added by default.
@@ -297,9 +317,21 @@ JSON::
},
// The target branch to use.
// May define a `JRELEASER_BRANCH` environment variable instead.
// Defaults to `main`.
// icon:dot-circle[] icon:eye-slash[]
"targetCommitish": "main",
// Marks the release as a draft.
// Defaults to `false`.
// icon:dot-circle[]
"ref": "main",
"draft": false,
// Marks the release as prerelease.
// May define a `JRELEASER_PRERELEASE` environment variable instead.
// Defaults to `false`.
// icon:dot-circle[] icon:eye-slash[]
"prerelease": false,
// The following properties define icon:dot-circle[] URL formats.
// Defaults are shown.
@@ -403,25 +435,29 @@ Maven::
<!--
Drops and creates an existing release with matching tag.
May define a `JRELEASER_OVERWRITE` environment variable instead.
Defaults to `false`.
icon:dot-circle[]
icon:dot-circle[] icon:eye-slash[]
-->
<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`.
icon:dot-circle[]
icon:dot-circle[] icon:eye-slash[]
-->
<allowUploadToExisting>true</allowUploadToExisting>
<update>true</update>
<!--
Skips creating a tag.
Useful when the tag was created externally.
icon:dot-circle[]
May define a `JRELEASER_SKIP_TAG` environment variable instead.
Defaults to `false`.
icon:dot-circle[] icon:eye-slash[]
-->
<skipTagging>false</skipTagging>
<skipTag>false</skipTag>
<!--
The Gitea API endpoint to use.
@@ -517,12 +553,29 @@ Maven::
-->
<name>{{tagName}}</name>
</milestone>
<!--
The target branch to use.
May define a `JRELEASER_BRANCH` environment variable instead.
Defaults to `main`.
icon:dot-circle[] icon:eye-slash[]
-->
<targetCommitish>main</targetCommitish>
<!--
Marks the release as a draft.
Defaults to `false`.
icon:dot-circle[]
-->
<ref>main</ref>
<draft>false</draft>
<!--
Marks the release as prerelease.
May define a `JRELEASER_PRERELEASE` environment variable instead.
Defaults to `false`.
icon:dot-circle[] icon:eye-slash[]
-->
<prerelease>false</prerelease>
<!--
The following properties define icon:dot-circle[] URL formats.
@@ -620,20 +673,24 @@ jreleaser {
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`.
// icon:dot-circle[]
// icon:dot-circle[] icon:eye-slash[]
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`.
// icon:dot-circle[]
allowUploadToExisting = true
// icon:dot-circle[] icon:eye-slash[]
update = true
// Skips creating a tag.
// Useful when the tag was created externally.
// icon:dot-circle[]
skipTagging = false
// May define a `JRELEASER_SKIP_TAG` environment variable instead.
// Defaults to `false`.
// icon:dot-circle[] icon:eye-slash[]
skipTag = false
// The Gitea API endpoint to use.
// You can skip `/api/v4` as it will be added by default.
@@ -702,9 +759,21 @@ jreleaser {
}
// The target branch to use.
// May define a `JRELEASER_BRANCH` environment variable instead.
// Defaults to `main`.
// icon:dot-circle[]v
targetCommitish = 'main'
// Marks the release as a draft.
// Defaults to `false`.
// icon:dot-circle[]
ref = 'main'
draft = false
// Marks the release as prerelease.
// May define a `JRELEASER_PRERELEASE` environment variable instead.
// Defaults to `false`.
// icon:dot-circle[] icon:eye-slash[]
prerelease = false
// The following properties define icon:dot-circle[] URL formats.
// Defaults are shown.

80
docs/modules/configuration/pages/release/github.adoc
View File

@@ -56,20 +56,24 @@ release:
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`.
# icon:dot-circle[]
# icon:dot-circle[] icon:eye-slash[]
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`.
# icon:dot-circle[]
allowUploadToExisting: true
# icon:dot-circle[] icon:eye-slash[]
update: true
# Skips creating a tag.
# Useful when the tag was created externally.
# icon:dot-circle[]
skipTagging: false
# May define a `JRELEASER_SKIP_TAG` environment variable instead.
# Defaults to `false`.
# icon:dot-circle[] icon:eye-slash[]
skipTag: false
# The GitHub API endpoint to use.
# Update it if using GitHub Enterprise.
@@ -136,8 +140,9 @@ release:
name: {{tagName}}
# The target branch to use.
# May define a `JRELEASER_BRANCH` environment variable instead.
# Defaults to `main`.
# icon:dot-circle[]
# icon:dot-circle[] icon:eye-slash[]
targetCommitish: main
# Marks the release as a draft.
@@ -146,8 +151,9 @@ release:
draft: false
# Marks the release as prerelease.
# May define a `JRELEASER_PRERELEASE` environment variable instead.
# Defaults to `false`.
# icon:dot-circle[]
# icon:dot-circle[] icon:eye-slash[]
prerelease: false
# The following properties define icon:dot-circle[] URL formats.
@@ -228,20 +234,24 @@ JSON::
"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`.
// icon:dot-circle[]
// icon:dot-circle[] icon:eye-slash[]
"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`.
// icon:dot-circle[]
"allowUploadToExisting": true,
// icon:dot-circle[] icon:eye-slash[]
"update": true,
// Skips creating a tag.
// Useful when the tag was created externally.
// icon:dot-circle[]
"skipTagging": false,
// May define a `JRELEASER_SKIP_TAG` environment variable instead.
// Defaults to `false`.
// icon:dot-circle[] icon:eye-slash[]
"skipTag": false,
// The GitHub API endpoint to use.
// Update it if using GitHub Enterprise.
@@ -311,8 +321,9 @@ JSON::
},
// The target branch to use.
// May define a `JRELEASER_BRANCH` environment variable instead.
// Defaults to `main`.
// icon:dot-circle[]
// icon:dot-circle[] icon:eye-slash[]
"targetCommitish": "main",
// Marks the release as a draft.
@@ -321,8 +332,9 @@ JSON::
"draft": false,
// Marks the release as prerelease.
// May define a `JRELEASER_PRERELEASE` environment variable instead.
// Defaults to `false`.
// icon:dot-circle[]
// icon:dot-circle[] icon:eye-slash[]
"prerelease": false,
// The following properties define icon:dot-circle[] URL formats.
@@ -428,25 +440,29 @@ Maven::
<!--
Drops and creates an existing release with matching tag.
May define a `JRELEASER_OVERWRITE` environment variable instead.
Defaults to `false`.
icon:dot-circle[]
icon:dot-circle[] icon:eye-slash[]
-->
<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`.
icon:dot-circle[]
icon:dot-circle[] icon:eye-slash[]
-->
<allowUploadToExisting>true</allowUploadToExisting>
<update>true</update>
<!--
Skips creating a tag.
Useful when the tag was created externally.
icon:dot-circle[]
May define a `JRELEASER_SKIP_TAG` environment variable instead.
Defaults to `false`.
icon:dot-circle[] icon:eye-slash[]
-->
<skipTagging>false</skipTagging>
<skipTag>false</skipTag>
<!--
The GitHub API endpoint to use.
@@ -546,8 +562,9 @@ Maven::
<!--
The target branch to use.
May define a `JRELEASER_BRANCH` environment variable instead.
Defaults to `main`.
icon:dot-circle[]
icon:dot-circle[] icon:eye-slash[]
-->
<targetCommitish>main</targetCommitish>
@@ -560,8 +577,9 @@ Maven::
<!--
Marks the release as prerelease.
May define a `JRELEASER_PRERELEASE` environment variable instead.
Defaults to `false`.
icon:dot-circle[]
icon:dot-circle[] icon:eye-slash[]
-->
<prerelease>false</prerelease>
@@ -662,20 +680,24 @@ jreleaser {
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`.
// icon:dot-circle[]
// icon:dot-circle[] icon:eye-slash[]
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`.
// icon:dot-circle[]
allowUploadToExisting = true
// icon:dot-circle[] icon:eye-slash[]
update = true
// Skips creating a tag.
// Useful when the tag was created externally.
// icon:dot-circle[]
skipTagging = false
// May define a `JRELEASER_SKIP_TAG` environment variable instead.
// Defaults to `false`.
// icon:dot-circle[] icon:eye-slash[]
skipTag = false
// The GitHub API endpoint to use.
// Update it if using GitHub Enterprise.
@@ -745,8 +767,9 @@ jreleaser {
}
// The target branch to use.
// May define a `JRELEASER_BRANCH` environment variable instead.
// Defaults to `main`.
// icon:dot-circle[]
// icon:dot-circle[]v
targetCommitish = 'main'
// Marks the release as a draft.
@@ -755,8 +778,9 @@ jreleaser {
draft = false
// Marks the release as prerelease.
// May define a `JRELEASER_PRERELEASE` environment variable instead.
// Defaults to `false`.
// icon:dot-circle[]
// icon:dot-circle[] icon:eye-slash[]
prerelease = false
// The following properties define icon:dot-circle[] URL formats.

68
docs/modules/configuration/pages/release/gitlab.adoc
View File

@@ -56,20 +56,24 @@ release:
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`.
# icon:dot-circle[]
# icon:dot-circle[] icon:eye-slash[]
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`.
# icon:dot-circle[]
allowUploadToExisting: true
# icon:dot-circle[] icon:eye-slash[]
update: true
# Skips creating a tag.
# Useful when the tag was created externally.
# icon:dot-circle[]
skipTagging: false
# May define a `JRELEASER_SKIP_TAG` environment variable instead.
# Defaults to `false`.
# icon:dot-circle[] icon:eye-slash[]
skipTag: false
# The Gitlab API endpoint to use.
# You can skip `/api/v4` as it will be added by default.
@@ -136,8 +140,9 @@ release:
name: {{tagName}}
# The target branch to use.
# May define a `JRELEASER_BRANCH` environment variable instead.
# Defaults to `main`.
# icon:dot-circle[]
# icon:dot-circle[] icon:eye-slash[]
ref: main
# The following properties define icon:dot-circle[] URL formats.
@@ -218,20 +223,24 @@ JSON::
"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`.
// icon:dot-circle[]
// icon:dot-circle[] icon:eye-slash[]
"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`.
// icon:dot-circle[]
"allowUploadToExisting": true,
// icon:dot-circle[] icon:eye-slash[]
"update": true,
// Skips creating a tag.
// Useful when the tag was created externally.
// icon:dot-circle[]
"skipTagging": false,
// May define a `JRELEASER_SKIP_TAG` environment variable instead.
// Defaults to `false`.
// icon:dot-circle[] icon:eye-slash[]
"skipTag": false,
// The Gitlab API endpoint to use.
// You can skip `/api/v4` as it will be added by default.
@@ -301,8 +310,9 @@ JSON::
},
// The target branch to use.
// May define a `JRELEASER_BRANCH` environment variable instead.
// Defaults to `main`.
// icon:dot-circle[]
// icon:dot-circle[] icon:eye-slash[]
"ref": "main",
// The following properties define icon:dot-circle[] URL formats.
@@ -408,25 +418,29 @@ Maven::
<!--
Drops and creates an existing release with matching tag.
May define a `JRELEASER_OVERWRITE` environment variable instead.
Defaults to `false`.
icon:dot-circle[]
icon:dot-circle[] icon:eye-slash[]
-->
<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`.
icon:dot-circle[]
icon:dot-circle[] icon:eye-slash[]
-->
<allowUploadToExisting>true</allowUploadToExisting>
<update>true</update>
<!--
Skips creating a tag.
Useful when the tag was created externally.
icon:dot-circle[]
May define a `JRELEASER_SKIP_TAG` environment variable instead.
Defaults to `false`.
icon:dot-circle[] icon:eye-slash[]
-->
<skipTagging>false</skipTagging>
<skipTag>false</skipTag>
<!--
The Gitlab API endpoint to use.
@@ -525,8 +539,9 @@ Maven::
</milestone>
<!--
The target branch to use.
May define a `JRELEASER_BRANCH` environment variable instead.
Defaults to `main`.
icon:dot-circle[]
icon:dot-circle[] icon:eye-slash[]
-->
<ref>main</ref>
@@ -627,20 +642,24 @@ jreleaser {
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`.
// icon:dot-circle[]
// icon:dot-circle[] icon:eye-slash[]
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`.
// icon:dot-circle[]
allowUploadToExisting = true
// icon:dot-circle[] icon:eye-slash[]
update = true
// Skips creating a tag.
// Useful when the tag was created externally.
// icon:dot-circle[]
skipTagging = false
// May define a `JRELEASER_SKIP_TAG` environment variable instead.
// Defaults to `false`.
// icon:dot-circle[] icon:eye-slash[]
skipTag = false
// The Gitlab API endpoint to use.
// You can skip `/api/v4` as it will be added by default.
@@ -710,8 +729,9 @@ jreleaser {
}
// The target branch to use.
// May define a `JRELEASER_BRANCH` environment variable instead.
// Defaults to `main`.
// icon:dot-circle[]
// icon:dot-circle[] icon:eye-slash[]
ref = 'main'
// The following properties define icon:dot-circle[] URL formats.