jlengrand/jreleaser.github.io
1
0
Fork 0
mirror of https://github.com/jlengrand/jreleaser.github.io.git synced 2026-03-10 08:31:25 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
641861eff5fc87f71ca5c3f8319195990fbfada6
jreleaser.github.io/docs/modules/configuration/pages/release/gitlab.adoc
Andres Almiray 641861eff5 Document slack webhook
2021-04-20 21:54:35 +02:00

985 lines
32 KiB
Plaintext
Raw Blame History

= GitLab
include::partial$legend.adoc[]
[tabs]
====
YAML::
+
[source,yaml]
[subs="+macros"]
----
# icon:exclamation-triangle[]
release:
# Repo in which the release will be created.
# icon:exclamation-triangle[]
gitlab:
# Disables or enables publication to GitLab.
# defaults to `true`.
# icon:dot-circle[]
enabled: true
# Defines the connection timeout in seconds.
# Defaults to `20`.
# icon:dot-circle[]
connectTimeout: 20
# Defines the read timeout in seconds.
# Defaults to `60`.
# icon:dot-circle[]
readTimeout: 60
# The user or organization that owns the repository.
# If unspecified, will read it from the 'origin' git remote.
# icon:dot-circle[]
owner: duke
# The name of the repository.
# If unspecified, will read it from the 'origin' git remote.
# icon:dot-circle[]
name: app
# The GitLab host url.
# Defaults to `gitlab.com`.
# icon:exclamation-triangle[]
host: gitlab.com
# Username used for authoring commits. Must have write access to the repository.
# icon:exclamation-triangle[]
username: duke
# Password or OAuth token with write access to the repository.
# If left unspecified, the `JRELEASER_GITLAB_TOKEN`
# environment variable must be defined.
# icon:exclamation-triangle[] icon:eye-slash[]
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}}`.
# icon:dot-circle[] icon:eye-slash[] icon:file-alt[]
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}}`.
# icon:dot-circle[] icon:eye-slash[] icon:file-alt[]
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: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[] icon:eye-slash[]
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`.
# 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.
# Defaults to `pass:[https://gitlab.com]`.
# icon:dot-circle[]
apiEndpoint: pass:[https://gitlab.com]
# Git author used to commit to the repository.
# icon:dot-circle[]
commitAuthor:
# Name used when authoring commits.
# Defaults to `jreleaser-bot`.
# icon:dot-circle[]
name: jreleaser-bot
# E-mail used when authoring commits.
# Defaults to `pass:[jreleaser-bot@jreleaser.org]`.
# icon:dot-circle[]
email: pass:[jreleaser-bot@jreleaser.org]
# Signs commits with the configured credentials.
# The xref:configuration:signing.adoc[] section must be configured as well.
# Defaults to `false`.
# icon:dot-circle[]
sign: false
# Changelog customization.
# icon:dot-circle[]
changelog:
# Disables or enables the changelog.
# defaults to `true`.
# icon:dot-circle[]
enabled: true
# Sorts commits in ascending (oldest first) or descending (newer first).
# Valid values are: `ASC`, `DESC`.
# Defaults to `DESC`.
# icon:dot-circle[]
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.
# icon:dot-circle[]
external: path/to/changelog.md
# Create explicit markdown links for commit hashes.
# Defaults to `false`.
# icon:dot-circle[]
links: false
# A milestone associated with the release
# icon:dot-circle[]
milestone:
# Close the milestone (if it exists and still active) upon release.
# Defaults to `true`.
# icon:dot-circle[]
close: true
# The name/title of the milestone.
# May define a `JRELEASER_MILESTONE_NAME` environment variable instead.
# Defaults to `{{tagName}}`.
# icon:dot-circle[] icon:eye-slash[] icon:file-alt[]
name: {{tagName}}
# The target branch to use.
# May define a `JRELEASER_BRANCH` environment variable instead.
# Defaults to the branch pointed by HEAD.
# icon:dot-circle[] icon:eye-slash[]
ref: main
# The following properties define icon:dot-circle[] URL formats.
# Defaults are shown.
# Review the available xref:configuration:name-templates.adoc[].
# icon:dot-circle[] icon:file-alt[]
repoUrlFormat: pass:[https://{{repoHost}}/{{repoOwner}}/{{repoName}}]
# icon:dot-circle[] icon:file-alt[]
repoCloneUrlFormat: pass:[https://{{repoHost}}/{{repoOwner}}/{{repoName}}.git]
# icon:dot-circle[] icon:file-alt[]
commitUrlFormat: pass:[https://{{repoHost}}/{{repoOwner}}/{{repoName}}/-/commits]
# icon:dot-circle[] icon:file-alt[]
downloadUrlFormat: pass:[https://{{repoHost}}/{{repoOwner}}/{{repoName}}/-/releases/{{tagName}}/downloads/{{artifactFileName}}]
# icon:dot-circle[] icon:file-alt[]
releaseNotesUrlFormat: pass:[https://{{repoHost}}/{{repoOwner}}/{{repoName}}/-/releases/{{tagName}}]
# icon:dot-circle[] icon:file-alt[]
latestReleaseUrlFormat: pass:[https://{{repoHost}}/{{repoOwner}}/{{repoName}}/-/releases/{{tagName}}]
# icon:dot-circle[] icon:file-alt[]
issueTrackerUrlFormat: pass:[https://{{repoHost}}/{{repoOwner}}/{{repoName}}/-/issues]
----
TOML::
+
[source,toml]
[subs="+macros"]
----
# Repo in which the release will be created.
# icon:exclamation-triangle[]
[release.gitlab]
# Disables or enables publication to Gitea.
# defaults to `true`.
# icon:dot-circle[]
enabled = true
# Defines the connection timeout in seconds.
# Defaults to `20`.
# icon:dot-circle[]
connectTimeout = 20
# Defines the read timeout in seconds.
# Defaults to `60`.
# icon:dot-circle[]
readTimeout = 60
# The user or organization that owns the repository.
# icon:exclamation-triangle[]
owner = "duke"
# The name of the repository.
# If unspecified, will use ${project.name}.
# icon:dot-circle[]
name = "app"
# The GitLab host url.
# Defaults to `gitlab.com`.
# icon:exclamation-triangle[]
host = "gitlab.com"
# Username used for authoring commits. Must have write access to the repository.
# icon:exclamation-triangle[]
username = "duke"
# Password or OAuth token with write access to the repository.
# If left unspecified, the `JRELEASER_GITLAB_TOKEN`
# environment variable must be defined.
# icon:exclamation-triangle[] icon:eye-slash[]
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}}`.
# icon:dot-circle[] icon:eye-slash[] icon:file-alt[]
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.
# icon:dot-circle[] icon:eye-slash[] icon:file-alt[]
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:eye-slash[]
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`.
# icon:dot-circle[] icon:eye-slash[]
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`.
# 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.
# Defaults to `pass:[https://gitlab.com]`.
# icon:dot-circle[]
apiEndpoint = "pass:[https://gitlab.com]"
# Git author used to commit to the repository.
# Name used when authoring commits.
# Defaults to `jreleaser-bot`.
# icon:dot-circle[]
commitAuthor.name = "jreleaser-bot"
# E-mail used when authoring commits.
# Defaults to `pass:[jreleaser-bot@jreleaser.org]`.
# icon:dot-circle[]
commitAuthor.email = "pass:[jreleaser-bot@jreleaser.org]"
# Signs commits with the configured credentials.
# The xref:configuration:signing.adoc[] section must be configured as well.
# Defaults to `false`.
# icon:dot-circle[]
sign = false
# Changelog customization.
# Disables or enables the changelog.
# defaults to `true`.
# icon:dot-circle[]
changelog.enabled = true
# Sorts commits in ascending (oldest first) or descending (newer first).
# Valid values are: `ASC`, `DESC`.
# Defaults to `DESC`.
# icon:dot-circle[]
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.
# icon:dot-circle[]
changelog.external = "path/to/changelog.md"
# Create explicit markdown links for commit hashes.
# Defaults to `false`.
# icon:dot-circle[]
changelog.links = false
# A milestone associated with the release
# Close the milestone (if it exists and still open) upon release.
# Defaults to `true`.
# icon:dot-circle[]
milestone.close = true
# The name/title of the milestone.
# May define a `JRELEASER_MILESTONE_NAME` environment variable instead.
# Defaults to `{{tagName}}`.
# icon:dot-circle[] icon:eye-slash[] icon:file-alt[]
milestone.name = "{{tagName}}"
# The target branch to use.
# May define a `JRELEASER_BRANCH` environment variable instead.
# Defaults to the branch pointed by HEAD.
# icon:dot-circle[] icon:eye-slash[]
ref = "main"
# The following properties define icon:dot-circle[] URL formats.
# Defaults are shown.
# Review the available xref:configuration:name-templates.adoc[].
# icon:dot-circle[] icon:file-alt[]
repoUrlFormat = "pass:[https://{{repoHost}}/{{repoOwner}}/{{repoName}}]"
# icon:dot-circle[] icon:file-alt[]
repoCloneUrlFormat = "pass:[https://{{repoHost}}/{{repoOwner}}/{{repoName}}.git]"
# icon:dot-circle[] icon:file-alt[]
commitUrlFormat = "pass:[https://{{repoHost}}/{{repoOwner}}/{{repoName}}/-/commits]"
# icon:dot-circle[] icon:file-alt[]
downloadUrlFormat = "pass:[https://{{repoHost}}/{{repoOwner}}/{{repoName}}/-/releases/{{tagName}}/downloads/{{artifactFileName}}]"
# icon:dot-circle[] icon:file-alt[]
releaseNotesUrlFormat = "pass:[https://{{repoHost}}/{{repoOwner}}/{{repoName}}/-/releases/{{tagName}}]"
# icon:dot-circle[] icon:file-alt[]
latestReleaseUrlFormat = "pass:[https://{{repoHost}}/{{repoOwner}}/{{repoName}}/-/releases/{{tagName}}]"
# icon:dot-circle[] icon:file-alt[]
issueTrackerUrlFormat = "pass:[https://{{repoHost}}/{{repoOwner}}/{{repoName}}/-/issues]"
----
JSON::
+
[source,json]
[subs="+macros"]
----
{
// icon:exclamation-triangle[]
"release": {
// Repo in which the release will be created.
// icon:exclamation-triangle[]
"gitlab": {
// Disables or enables publication to GitLab.
// defaults to `true`.
// icon:dot-circle[]
"enabled": true,
// Defines the connection timeout in seconds.
// Defaults to `20`.
// icon:dot-circle[]
"connectTimeout": 20,
// Defines the read timeout in seconds.
// Defaults to `60`.
// icon:dot-circle[]
"readTimeout": 60,
// The user or organization that owns the repository.
// If unspecified, will read it from the 'origin' git remote.
// icon:dot-circle[]
"owner": "duke",
// The name of the repository.
// If unspecified, will read it from the 'origin' git remote.
// icon:dot-circle[]
"name": "app",
// The GitLab host url.
// Defaults to `gitlab.com`.
// icon:exclamation-triangle[]
"host": "gitlab.com",
// Username used for authoring commits. Must have write access to the repository.
// icon:exclamation-triangle[]
"username": "duke",
// Password or OAuth token with write access to the repository.
// If left unspecified, the `JRELEASER_GITLAB_TOKEN`
// environment variable must be defined.
// icon:exclamation-triangle[] icon:eye-slash[]
"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}}`.
// icon:dot-circle[] icon:eye-slash[] icon:file-alt[]
"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}}`.
// icon:dot-circle[] icon:eye-slash[] icon:file-alt[]
"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: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[] icon:eye-slash[]
"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`.
// 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.
// Defaults to `pass:[https://gitlab.com]`.
// icon:dot-circle[]
"apiEndpoint": "pass:[https://gitlab.com]",
// Git author used to commit to the repository.
// icon:dot-circle[]
"commitAuthor": {
// Name used when authoring commits.
// Defaults to `jreleaser-bot`.
// icon:dot-circle[]
"name": "jreleaser-bot",
// E-mail used when authoring commits.
// Defaults to `pass:[jreleaser-bot@jreleaser.org]`.
// icon:dot-circle[]
"email": "pass:[jreleaser-bot@jreleaser.org]"
},
// Signs commits with the configured credentials.
// The xref:configuration:signing.adoc[] section must be configured as well.
// Defaults to `false`.
// icon:dot-circle[]
"sign": false,
// Changelog customization.
// icon:dot-circle[]
"changelog": {
// Disables or enables the changelog.
// defaults to `true`.
// icon:dot-circle[]
"enabled": true,
// Sorts commits in ascending (oldest first) or descending (newer first).
// Valid values are: `ASC`, `DESC`.
// Defaults to `DESC`.
// icon:dot-circle[]
"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.
// icon:dot-circle[]
"external": "path/to/changelog.md",
// Create explicit markdown links for commit hashes.
// Defaults to `false`.
// icon:dot-circle[]
"links": false
},
// A milestone associated with the release
// icon:dot-circle[]
"milestone": {
// Close the milestone (if it exists and still open) upon release.
// Defaults to `true`.
// icon:dot-circle[]
"close": true,
// The name/title of the milestone.
// May define a `JRELEASER_MILESTONE_NAME` environment variable instead.
// Defaults to `{{tagName}}`.
// icon:dot-circle[] icon:eye-slash[] icon:file-alt[]
"name": "{{tagName}}"
},
// The target branch to use.
// May define a `JRELEASER_BRANCH` environment variable instead.
// Defaults to the branch pointed by HEAD.
// icon:dot-circle[] icon:eye-slash[]
"ref": "main",
// The following properties define icon:dot-circle[] URL formats.
// Defaults are shown.
// Review the available xref:configuration:name-templates.adoc[].
// icon:dot-circle[] icon:file-alt[]
"repoUrlFormat": "pass:[https://{{repoHost}}/{{repoOwner}}/{{repoName}}]",
// icon:dot-circle[] icon:file-alt[]
"repoCloneUrlFormat": "pass:[https://{{repoHost}}/{{repoOwner}}/{{repoName}}.git]",
// icon:dot-circle[] icon:file-alt[]
"commitUrlFormat": "pass:[https://{{repoHost}}/{{repoOwner}}/{{repoName}}/-/commits]",
// icon:dot-circle[] icon:file-alt[]
"downloadUrlFormat": "pass:[https://{{repoHost}}/{{repoOwner}}/{{repoName}}/-/releases/{{tagName}}/downloads/{{artifactFileName}}]",
// icon:dot-circle[] icon:file-alt[]
"releaseNotesUrlFormat": "pass:[https://{{repoHost}}/{{repoOwner}}/{{repoName}}/-/releases/{{tagName}}]",
// icon:dot-circle[] icon:file-alt[]
"latestReleaseUrlFormat": "pass:[https://{{repoHost}}/{{repoOwner}}/{{repoName}}/-/releases/{{tagName}}]",
// icon:dot-circle[] icon:file-alt[]
"issueTrackerUrlFormat": "pass:[https://{{repoHost}}/{{repoOwner}}/{{repoName}}/-/issues]"
}
}
}
----
Maven::
+
[source,xml]
[subs="+macros,verbatim"]
----
<jreleaser>
<!--
icon:exclamation-triangle[]
-->
<release>
<!--
Repo in which the release will be created.
icon:exclamation-triangle[]
-->
<gitlab>
<!--
Disables or enables publication to GitLab.
defaults to `true`.
icon:dot-circle[]
-->
<enabled>true</enabled>
<!--
Defines the connection timeout in seconds.
Defaults to `20`.
icon:dot-circle[]
-->
<connectTimeout>20</connectTimeout>
<!--
Defines the read timeout in seconds.
Defaults to `60`.
icon:dot-circle[]
-->
<readTimeout>60</readTimeout>
<!--
The user or organization that owns the repository.
If unspecified, will read it from the 'origin' git remote.
icon:dot-circle[]
-->
<owner>duke</owner>
<!--
The name of the repository.
If unspecified, will read it from the 'origin' git remote.
icon:dot-circle[]
-->
<name>app</name>
<!--
The GitLab host url.
Defaults to `gitlab.com`.
icon:exclamation-triangle[]
-->
<host>gitlab.com</host>
<!--
Username used for authoring commits. Must have write access to the repository.
icon:exclamation-triangle[]
-->
<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.
icon:exclamation-triangle[] icon:eye-slash[]
-->
<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}}`.
icon:dot-circle[] icon:eye-slash[] icon:file-alt[]
-->
<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}}`.
icon:dot-circle[] icon:eye-slash[] icon:file-alt[]
-->
<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`.
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:eye-slash[]
-->
<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`.
icon:dot-circle[] icon:eye-slash[]
-->
<skipTag>false</skipTag>
<!--
The GitLab API endpoint to use.
You can skip `/api/v4` as it will be added by default.
Defaults to `pass:[https://gitlab.com]`.
icon:dot-circle[]
-->
<apiEndpoint>pass:[https://gitlab.com]</apiEndpoint>
<!--
Git author used to commit to the repository.
icon:dot-circle[]
-->
<commitAuthor>
<!--
Name used when authoring commits.
Defaults to `jreleaser-bot`.
icon:dot-circle[]
-->
<name>jreleaser-bot</name>
<!--
E-mail used when authoring commits.
Defaults to `pass:[jreleaser-bot@jreleaser.org]`.
icon:dot-circle[]
-->
<email>pass:[jreleaser-bot@jreleaser.org]</email>
</commitAuthor>
<!--
Signs commits with the configured credentials.
The xref:configuration:signing.adoc[] section must be configured as well.
Defaults to `false`.
icon:dot-circle[]
-->
<sign>false</sign>
<!--
Changelog customization.
icon:dot-circle[]
-->
<changelog>
<!--
Disables or enables the changelog.
defaults to `true`.
icon:dot-circle[]
-->
<enabled>true</enabled>
<!--
Sorts commits in ascending (oldest first) or descending (newer first).
Valid values are>`ASC`, `DESC`.
Defaults to `DESC`.
icon:dot-circle[]
-->
<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.
icon:dot-circle[]
-->
<external>path/to/changelog.md</external>
<!--
Create explicit markdown links for commit hashes.
Defaults to `false`.
icon:dot-circle[]
-->
<links>false</links>
</changelog>
<!--
A milestone associated with the release
icon:dot-circle[]
-->
<milestone>
<!--
Close the milestone (if it exists and still open) upon release.
Defaults to `true`.
icon:dot-circle[]
-->
<close>true</close>
<!--
The name/title of the milestone.
May define a `JRELEASER_MILESTONE_NAME` environment variable instead.
Defaults to `{{tagName}}`.
icon:dot-circle[] icon:eye-slash[] icon:file-alt[]
-->
<name>{{tagName}}</name>
</milestone>
<!--
The target branch to use.
May define a `JRELEASER_BRANCH` environment variable instead.
Defaults to the branch pointed by HEAD.
icon:dot-circle[] icon:eye-slash[]
-->
<ref>main</ref>
<!--
The following properties define icon:dot-circle[] URL formats.
Defaults are shown.
Review the available xref:configuration:name-templates.adoc[].
-->
<!--
icon:dot-circle[] icon:file-alt[]
-->
<repoUrlFormat>pass:[https://{{repoHost}}/{{repoOwner}}/{{repoName}}]</repoUrlFormat>
<!--
icon:dot-circle[] icon:file-alt[]
-->
<repoCloneUrlFormat>pass:[https://{{repoHost}}/{{repoOwner}}/{{repoName}}.git]</repoCloneUrlFormat>
<!--
icon:dot-circle[] icon:file-alt[]
-->
<commitUrlFormat>pass:[https://{{repoHost}}/{{repoOwner}}/{{repoName}}/-/commits]</commitUrlFormat>
<!--
icon:dot-circle[] icon:file-alt[]
-->
<downloadUrlFormat>pass:[https://{{repoHost}}/{{repoOwner}}/{{repoName}}/-/releases/{{tagName}}/downloads/{{artifactFileName}}]</downloadUrlFormat>
<!--
icon:dot-circle[] icon:file-alt[]
-->
<releaseNotesUrlFormat>pass:[https://{{repoHost}}/{{repoOwner}}/{{repoName}}/-/releases/{{tagName}}]</releaseNotesUrlFormat>
<!--
icon:dot-circle[] icon:file-alt[]
-->
<latestReleaseUrlFormat>pass:[https://{{repoHost}}/{{repoOwner}}/{{repoName}}/-/releases/{{tagName}}]</latestReleaseUrlFormat>
<!--
icon:dot-circle[] icon:file-alt[]
-->
<issueTrackerUrlFormat>pass:[https://{{repoHost}}/{{repoOwner}}/{{repoName}}/-/issues]</issueTrackerUrlFormat>
</gitlab>
</release>
</jreleaser>
----
Gradle::
+
[source,groovy]
[subs="+macros"]
----
jreleaser {
// icon:exclamation-triangle[]
release {
// Repo in which the release will be created.
// icon:exclamation-triangle[]
gitlab {
// Disables or enables publication to GitLab.
// defaults to `true`.
// icon:dot-circle[]
enabled = true
// Defines the connection timeout in seconds.
// Defaults to `20`.
// icon:dot-circle[]
connectTimeout = 20
// Defines the read timeout in seconds.
// Defaults to `60`.
// icon:dot-circle[]
readTimeout = 60
// The user or organization that owns the repository.
// If unspecified, will read it from the 'origin' git remote.
// icon:dot-circle[]
owner = 'duke'
// The name of the repository.
// If unspecified, will read it from the 'origin' git remote.
// icon:dot-circle[]
name = 'app'
// The GitLab host url.
// Defaults to `gitlab.com`.
// icon:exclamation-triangle[]
host = 'gitlab.com'
// Username used for authoring commits. Must have write access to the repository.
// icon:exclamation-triangle[]
username = 'duke'
// Password or OAuth token with write access to the repository.
// If left unspecified, the `JRELEASER_GITLAB_TOKEN`
// environment variable must be defined.
// icon:exclamation-triangle[] icon:eye-slash[]
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}}`.
// icon:dot-circle[] icon:eye-slash[] icon:file-alt[]
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}}`.
// icon:dot-circle[] icon:eye-slash[] icon:file-alt[]
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: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[] icon:eye-slash[]
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`.
// 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.
// Defaults to `pass:[https://gitlab.com]`.
// icon:dot-circle[]
apiEndpoint = 'pass:[https://gitlab.com]'
// Git author used to commit to the repository.
// icon:dot-circle[]
commitAuthor {
// Name used when authoring commits.
// Defaults to `jreleaser-bot`.
// icon:dot-circle[]
name = 'jreleaser-bot'
// E-mail used when authoring commits.
// Defaults to `pass:[jreleaser-bot@jreleaser.org]`.
// icon:dot-circle[]
email = 'pass:[jreleaser-bot@jreleaser.org]'
}
// Signs commits with the configured credentials.
// The xref:configuration:signing.adoc[] section must be configured as well.
// Defaults to `false`.
// icon:dot-circle[]
sign = false
// Changelog customization.
// icon:dot-circle[]
changelog {
// Disables or enables the changelog.
// defaults to `true`.
// icon:dot-circle[]
enabled = true
// Sorts commits in ascending (oldest first) or descending (newer first).
// Valid values are = `ASC`, `DESC`.
// Defaults to `DESC`.
// icon:dot-circle[]
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.
// icon:dot-circle[]
external = 'path/to/changelog.md'
// Create explicit markdown links for commit hashes.
// Defaults to `false`.
// icon:dot-circle[]
links = false
}
// A milestone associated with the release
// icon:dot-circle[]
milestone {
// Close the milestone (if it exists and still active) upon release.
// Defaults to `true`.
// icon:dot-circle[]
close = true
// The name/title of the milestone.
// May define a `JRELEASER_MILESTONE_NAME` environment variable instead.
// Defaults to `{{tagName}}`.
// icon:dot-circle[] icon:eye-slash[] icon:file-alt[]
name = '{{tagName}}'
}
// The target branch to use.
// May define a `JRELEASER_BRANCH` environment variable instead.
// Defaults to the branch pointed by HEAD.
// icon:dot-circle[] icon:eye-slash[]
ref = 'main'
// The following properties define icon:dot-circle[] URL formats.
// Defaults are shown.
// Review the available xref:configuration:name-templates.adoc[].
// icon:dot-circle[] icon:file-alt[]
repoUrlFormat = 'pass:[https://{{repoHost}}/{{repoOwner}}/{{repoName}}]'
// icon:dot-circle[] icon:file-alt[]
repoCloneUrlFormat = 'pass:[https://{{repoHost}}/{{repoOwner}}/{{repoName}}.git]'
// icon:dot-circle[] icon:file-alt[]
commitUrlFormat = 'pass:[https://{{repoHost}}/{{repoOwner}}/{{repoName}}/-/commits]'
// icon:dot-circle[] icon:file-alt[]
downloadUrlFormat = 'pass:[https://{{repoHost}}/{{repoOwner}}/{{repoName}}/-/releases/{{tagName}}/downloads/{{artifactFileName}}]'
// icon:dot-circle[] icon:file-alt[]
releaseNotesUrlFormat = 'pass:[https://{{repoHost}}/{{repoOwner}}/{{repoName}}/-/releases/{{tagName}}]'
// icon:dot-circle[] icon:file-alt[]
latestReleaseUrlFormat = 'pass:[https://{{repoHost}}/{{repoOwner}}/{{repoName}}/-/releases/{{tagName}}]'
// icon:dot-circle[] icon:file-alt[]
issueTrackerUrlFormat = 'pass:[https://{{repoHost}}/{{repoOwner}}/{{repoName}}/-/issues]'
}
----
====
Reference in New Issue View Git Blame Copy Permalink