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 the active flag

Browse Source
This commit is contained in:
Andres Almiray
2021-04-14 15:32:15 +02:00
parent a83076b730
commit 0eb0050a51
16 changed files with 330 additions and 255 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
docs/modules/configuration/pages/announce/discussions.adoc
View File

@@ -17,9 +17,10 @@ announce:
discussions:
# Enable or disable this announcer.
# Defaults to `true`.
# Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
# Defaults to `NEVER`.
# icon:dot-circle[]
enabled: true
active: ALWAYS
# The GitHub organization that owns the discussion.
# icon:exclamation-triangle[]
@@ -54,9 +55,10 @@ TOML::
[announce.discussions]
# Enable or disable this announcer.
# Defaults to `true`.
# Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
# Defaults to `NEVER`.
# icon:dot-circle[]
enabled = true
active = "ALWAYS"
# The GitHub organization that owns the discussion.
# icon:exclamation-triangle[]
@@ -93,9 +95,10 @@ JSON::
"discussions": {
// Enable or disable this announcer.
// Defaults to `true`.
// Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
// Defaults to `NEVER`.
// icon:dot-circle[]
"enabled": true,
"active": "ALWAYS",
// The GitHub organization that owns the discussion.
// icon:exclamation-triangle[]
@@ -138,10 +141,11 @@ Maven::
<!--
Enable or disable this announcer.
Defaults to `true`.
Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
Defaults to `NEVER`.
icon:dot-circle[]
-->
<enabled>true</enabled>
<active>ALWAYS</active>
<!--
The GitHub organization that owns the discussion.
@@ -191,9 +195,10 @@ jreleaser {
discussions {
// Enable or disable this announcer.
// Defaults to `true`.
// Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
// Defaults to `NEVER`.
// icon:dot-circle[]
enabled = true
active = 'ALWAYS'
// The GitHub organization that owns the discussion.
// icon:exclamation-triangle[]

25
docs/modules/configuration/pages/announce/mail.adoc
View File

@@ -16,9 +16,10 @@ announce:
mail:
# Enable or disable this announcer.
# Defaults to `true`.
# Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
# Defaults to `NEVER`.
# icon:dot-circle[]
enabled: true
active: ALWAYS
# The e-mail transport.
# Supported values are: [SMTP, SMTPS].
@@ -108,9 +109,10 @@ TOML::
[announce.mail]
# Enable or disable this announcer.
# Defaults to `true`.
# Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
# Defaults to `NEVER`.
# icon:dot-circle[]
enabled = true
active = "ALWAYS"
# The e-mail transport.
# Supported values are: [SMTP, SMTPS].
@@ -201,9 +203,10 @@ JSON::
"mail": {
// Enable or disable this announcer.
// Defaults to `true`.
// Defaults to `NEVER`.
// Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
// icon:dot-circle[]
"enabled": true,
"active": "ALWAYS",
// The e-mail transport.
// Supported values are: [SMTP, SMTPS].
@@ -299,10 +302,11 @@ Maven::
<mail>
<!--
Enable or disable this announcer.
Defaults to `true`.
Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
Defaults to `NEVER`.
icon:dot-circle[]
-->
<enabled>true</enabled>
<active>ALWAYS</active>
<!--
The e-mail transport.
@@ -429,9 +433,10 @@ jreleaser {
mail {
// Enable or disable this announcer.
// Defaults to `true`.
// Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
// Defaults to `NEVER`.
// icon:dot-circle[]
enabled = true
active = 'ALWAYS'
// The e-mail transport.
// Supported values are = [SMTP, SMTPS].

25
docs/modules/configuration/pages/announce/sdkman.adoc
View File

@@ -17,9 +17,10 @@ announce:
sdkman:
# Enable or disable this announcer.
# Defaults to `true`.
# Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
# Defaults to `NEVER`.
# icon:dot-circle[]
enabled: true
active: ALWAYS
# The name of the candidate registered in thew SDKMAN! database.
# If unspecified, will use ${project.name}.
@@ -52,9 +53,10 @@ TOML::
[announce.sdkman]
# Enable or disable this announcer.
# Defaults to `true`.
# Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
# Defaults to `NEVER`.
# icon:dot-circle[]
enabled = true
active = "ALWAYS"
# The name of the candidate registered in thew SDKMAN! database.
# If unspecified, will use ${project.name}.
@@ -89,9 +91,10 @@ JSON::
// icon:dot-circle[]
"sdkman": {
// Enable or disable this announcer.
// Defaults to `true`.
// Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
// Defaults to `NEVER`.
// icon:dot-circle[]
"enabled": true,
"active": "ALWAYS",
// The name of the candidate registered in thew SDKMAN! database.
// If unspecified, will use ${project.name}.
@@ -131,10 +134,11 @@ Maven::
<sdkman>
<!--
Enable or disable this announcer.
Defaults to `true`.
Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
Defaults to `NEVER`.
icon:dot-circle[]
-->
<enabled>true</enabled>
<active>ALWAYS</active>
<!--
The name of the candidate registered in thew SDKMAN! database.
@@ -179,9 +183,10 @@ jreleaser {
// icon:dot-circle[]
sdkman {
// Enable or disable this announcer.
// Defaults to `true`.
// Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
// Defaults to `NEVER`.
// icon:dot-circle[]
enabled = true
active = 'ALWAYS'
// The name of the candidate registered in thew SDKMAN! database.
// If unspecified, will use ${project.name}.

25
docs/modules/configuration/pages/announce/slack.adoc
View File

@@ -21,9 +21,10 @@ announce:
slack:
# Enable or disable this announcer.
# Defaults to `true`.
# Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
# Defaults to `NEVER`.
# icon:dot-circle[]
enabled: true
active: ALWAYS
# The ApiKey associated with the given account.
# If left unspecified, the `JRELEASER_SLACK_TOKEN`
@@ -56,9 +57,10 @@ TOML::
[announce.slack]
# Enable or disable this announcer.
# Defaults to `true`.
# Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
# Defaults to `NEVER`.
# icon:dot-circle[]
enabled = true
active = "ALWAYS"
# The ApiKey associated with the given account.
# If left unspecified, the `JRELEASER_SLACK_TOKEN`
@@ -93,9 +95,10 @@ JSON::
"slack": {
// Enable or disable this announcer.
// Defaults to `true`.
// Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
// Defaults to `NEVER`.
// icon:dot-circle[]
"enabled": true,
"active": "ALWAYS",
// The ApiKey associated with the given account.
// If left unspecified, the `JRELEASER_SLACK_TOKEN`
@@ -136,10 +139,11 @@ Maven::
<!--
Enable or disable this announcer.
Defaults to `true`.
Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
Defaults to `NEVER`.
icon:dot-circle[]
-->
<enabled>true</enabled>
<active>ALWAYS</active>
<!--
The ApiKey associated with the given account.
@@ -184,9 +188,10 @@ jreleaser {
slack {
// Enable or disable this announcer.
// Defaults to `true`.
// Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
// Defaults to `NEVER`.
// icon:dot-circle[]
enabled = true
active = 'ALWAYS'
// The ApiKey associated with the given account.
// If left unspecified, the `JRELEASER_SLACK_TOKEN`

31
docs/modules/configuration/pages/announce/twitter.adoc
View File

@@ -17,9 +17,10 @@ announce:
twitter:
# Enable or disable this announcer.
# Defaults to `true`.
# Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
# Defaults to `NEVER`.
# icon:dot-circle[]
enabled: true
active: ALWAYS
# The consumer key.
# If left unspecified, the `JRELEASER_TWITTER_CONSUMER_KEY`
@@ -59,9 +60,10 @@ TOML::
[announce.twitter]
# Enable or disable this announcer.
# Defaults to `true`.
# Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
# Defaults to `NEVER`.
# icon:dot-circle[]
enabled = true
active = "ALWAYS"
# The consumer key.
# If left unspecified, the `JRELEASER_TWITTER_CONSUMER_KEY`
@@ -103,9 +105,10 @@ JSON::
"twitter": {
// Enable or disable this announcer.
// Defaults to `true`.
// Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
// Defaults to `NEVER`.
// icon:dot-circle[]
"enabled": true,
"active": "ALWAYS",
// The consumer key.
// If left unspecified, the `JRELEASER_TWITTER_CONSUMER_KEY`
@@ -153,10 +156,11 @@ Maven::
<!--
Enable or disable this announcer.
Defaults to `true`.
Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
Defaults to `NEVER`.
icon:dot-circle[]
-->
<enabled>true</enabled>
<active>ALWAYS</active>
<!--
The consumer key.
@@ -206,14 +210,15 @@ Gradle::
[subs="+macros"]
----
jreleaser {
announce =
announce {
// icon:dot-circle[]
twitter =
twitter {
// Enable or disable this announcer.
// Defaults to `true`.
// Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
// Defaults to `NEVER`.
// icon:dot-circle[]
enabled = true
active = true
// The consumer key.
// If left unspecified, the `JRELEASER_TWITTER_CONSUMER_KEY`
@@ -243,6 +248,8 @@ jreleaser {
// Review the available xref:configuration:name-templates.adoc[].
// icon:dot-circle[]
status = 'icon:rocket[] {{projectNameCapitalized}} {{projectVersion}} has been released! {{releaseNotesUrl}}'
}
}
}
----
====

25
docs/modules/configuration/pages/announce/zulip.adoc
View File

@@ -17,9 +17,10 @@ announce:
zulip:
# Enable or disable this announcer.
# Defaults to `true`.
# Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
# Defaults to `NEVER`.
# icon:dot-circle[]
enabled: true
active: ALWAYS
# The Zulip account (typically an email address) to use.
# icon:exclamation-triangle[]
@@ -65,9 +66,10 @@ TOML::
[announce.zulip]
# Enable or disable this announcer.
# Defaults to `true`.
# Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
# Defaults to `NEVER`.
# icon:dot-circle[]
enabled = true
active = "ALWAYS"
# The Zulip account (typically an email address) to use.
# icon:exclamation-triangle[]
@@ -115,9 +117,10 @@ JSON::
"zulip": {
// Enable or disable this announcer.
// Defaults to `true`.
// Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
// Defaults to `NEVER`.
// icon:dot-circle[]
"enabled": true,
"active": "ALWAYS",
// The Zulip account (typically an email address) to use.
// icon:exclamation-triangle[]
@@ -171,10 +174,11 @@ Maven::
<!--
Enable or disable this announcer.
Defaults to `true`.
Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
Defaults to `NEVER`.
icon:dot-circle[]
-->
<enabled>true</enabled>
<active>ALWAYS</active>
<!--
The Zulip account (typically an email address) to use.
@@ -238,9 +242,10 @@ jreleaser {
zulip {
// Enable or disable this announcer.
// Defaults to `true`.
// Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
// Defaults to `NEVER`.
// icon:dot-circle[]
enabled = true
active = 'ALWAYS'
// The Zulip account (typically an email address) to use.
// icon:exclamation-triangle[]

25
docs/modules/configuration/pages/distributions.adoc
View File

@@ -24,9 +24,10 @@ distributions:
app:
# Enables or disables the distribution.
# Defaults to `true`.
# Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
# Defaults to `ALWAYS`.
# icon:dot-circle[]
enabled: true
active: ALWAYS
# The distribution type.
# Used to determine packager templates.
@@ -98,9 +99,10 @@ TOML::
[distributions.app]
# Enables or disables the distribution.
# Defaults to `true`.
# Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
# Defaults to `ALWAYS`.
# icon:dot-circle[]
enabled = true
active = "ALWAYS"
# The distribution type.
# Used to determine packager templates.
@@ -169,9 +171,10 @@ JSON::
"app": {
// Enables or disables the distribution.
// Defaults to `true`.
// Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
// Defaults to `ALWAYS`.
// icon:dot-circle[]
"enabled": true,
"active": "ALWAYS",
// The distribution type.
// Used to determine packager templates.
@@ -264,10 +267,11 @@ Maven::
<!--
Enables or disables the distribution.
Defaults to `true`.
Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
Defaults to `ALWAYS`.
icon:dot-circle[]
-->
<enabled>true</enabled>
<active>ALWAYS</active>
<!--
The distribution type.
@@ -379,9 +383,10 @@ jreleaser {
app {
// Enables or disables the distribution.
// Defaults to `true`.
// Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
// Defaults to `ALWAYS`.
// icon:dot-circle[]
enabled = true
active = 'ALWAYS'
// The distribution type.
// Used to determine packager templates.

25
docs/modules/configuration/pages/packagers/chocolatey.adoc
View File

@@ -23,9 +23,10 @@ packagers:
# icon:dot-circle[]
chocolatey:
# Enables or disables Chocolatey.
# Defaults to `false`.
# Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
# Defaults to `NEVER`.
# icon:dot-circle[]
enabled: true
active: ALWAYS
# Directory with file templates used to prepare the Chocolatey distribution
# Defaults to `src/distribution/${distribution.name}/chocolatey`.
@@ -96,9 +97,10 @@ TOML::
# icon:dot-circle[]
[packagers.chocolatey]
# Enables or disables Chocolatey.
# Defaults to `false`.
# Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
# Defaults to `NEVER`.
# icon:dot-circle[]
enabled = true
active = "ALWAYS"
# Directory with file templates used to prepare the Chocolatey distribution
# Defaults to `src/distribution/${distribution.name}/chocolatey`.
@@ -168,9 +170,10 @@ JSON::
// icon:dot-circle[]
"chocolatey": {
// Enables or disables Chocolatey.
// Defaults to `false`.
// Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
// Defaults to `NEVER`.
// icon:dot-circle[]
"enabled": true,
"active": "ALWAYS",
// Directory with file templates used to prepare the Chocolatey distribution
// Defaults to `src/distribution/${distribution.name}/chocolatey`.
@@ -255,10 +258,11 @@ Maven::
<chocolatey>
<!--
Enables or disables Chocolatey.
Defaults to `false`.
Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
Defaults to `NEVER`.
icon:dot-circle[]
-->
<enabled>true</enabled>
<active>ALWAYS</active>
<!--
Directory with file templates used to prepare the Chocolatey distribution
@@ -365,9 +369,10 @@ jreleaser {
// icon:dot-circle[]
chocolatey {
// Enables or disables Chocolatey.
// Defaults to `false`.
// Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
// Defaults to `NEVER`.
// icon:dot-circle[]
enabled = true
active = 'ALWAYS'
// Directory with file templates used to prepare the Chocolatey distribution
// Defaults to `src/distribution/${distribution.name}/chocolatey`.

45
docs/modules/configuration/pages/packagers/docker.adoc
View File

@@ -23,9 +23,10 @@ packagers:
# icon:dot-circle[]
docker:
# Enables or disables Docker.
# Defaults to `false`.
# Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
# Defaults to `NEVER`.
# icon:dot-circle[]
enabled: true
active: ALWAYS
# Directory with file templates used to prepare the Docker distribution
# Defaults to `src/distribution/${distribution.name}/docker`.
@@ -100,9 +101,10 @@ TOML::
# icon:dot-circle[]
[packagers.docker]
# Enables or disables Docker.
# Defaults to `false`.
# Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
# Defaults to `NEVER`.
# icon:dot-circle[]
enabled = true
active = "ALWAYS"
# Directory with file templates used to prepare the Docker distribution
# Defaults to `src/distribution/${distribution.name}/docker`.
@@ -176,9 +178,10 @@ JSON::
// icon:dot-circle[]
"docker": {
// Enables or disables Docker.
// Defaults to `false`.
// Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
// Defaults to `NEVER`.
// icon:dot-circle[]
"enabled": true,
"active": "ALWAYS",
// Directory with file templates used to prepare the Docker distribution
// Defaults to `src/distribution/${distribution.name}/docker`.
@@ -271,10 +274,11 @@ Maven::
<docker>
<!--
Enables or disables Docker.
Defaults to `false`.
Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
Defaults to `NEVER`.
icon:dot-circle[]
-->
<enabled>true</enabled>
<active>ALWAYS</active>
<!--
Directory with file templates used to prepare the Docker distribution
@@ -387,9 +391,10 @@ jreleaser {
// icon:dot-circle[]
docker {
// Enables or disables Docker.
// Defaults to `false`.
// Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
// Defaults to `NEVER`.
// icon:dot-circle[]
enabled = true
active = 'ALWAYS'
// Directory with file templates used to prepare the Docker distribution
// Defaults to `src/distribution/${distribution.name}/docker`.
@@ -516,7 +521,7 @@ project:
packagers:
docker:
enabled: true
active: ALWAYS
imageNames:
- "myuser/{{projectName}}"
----
@@ -529,7 +534,7 @@ TOML::
name = "app"
[packagers.docker]
enabled = true
active = "ALWAYS"
imageNames = ["myuser/{{projectName}}"]
----
JSON::
@@ -544,7 +549,7 @@ JSON::
"packagers": {
"docker": {
"enabled": true,
"active": "ALWAYS",
"imageNames": [
"myuser/{{projectName}}"
]
@@ -561,7 +566,7 @@ Maven::
<jreleaser>
<packagers>
<docker>
<enabled>true</enabled>
<active>ALWAYS</active>
<imageNames>
<imageName>myuser/{{projectName}}</imageName>
</imageNames>
@@ -578,7 +583,7 @@ Gradle::
jreleaser {
packagers {
docker {
enabled = true
active = 'ALWAYS'
addImageName('myuser/{{projectName}}')
}
}
@@ -607,7 +612,7 @@ project:
packagers:
docker:
enabled: true
active: ALWAYS
imageNames:
- "myuser/myimage:{{tagName}}"
- "myuser/myimage:v{{projectVersionMajor}}"
@@ -623,7 +628,7 @@ TOML::
name = "app"
[packagers.docker]
enabled = true
active = "ALWAYS"
imageNames = [
"myuser/myimage:{{tagName}}",
"myuser/myimage:v{{projectVersionMajor}}",
@@ -642,7 +647,7 @@ JSON::
"packagers": {
"docker": {
"enabled": true,
"active": "ALWAYS",
"imageNames": [
"myuser/myimage:{{tagName}}",
"myuser/myimage:v{{projectVersionMajor}}",
@@ -662,7 +667,7 @@ Maven::
<jreleaser>
<packagers>
<docker>
<enabled>true</enabled>
<active>ALWAYS</active>
<imageNames>
<imageName>myuser/myimage:{{tagName}}</imageName>
<imageName>myuser/myimage:v{{projectVersionMajor}}</imageName>
@@ -682,7 +687,7 @@ Gradle::
jreleaser {
packagers {
docker {
enabled = true
active = 'ALWAYS'
addImageName('myuser/myimage:{{tagName}}')
addImageName('myuser/myimage:v{{projectVersionMajor}}')
addImageName('myuser/myimage:v{{projectVersionMajor}}.{{projectVersionMinor}}')

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

@@ -22,9 +22,10 @@ packagers:
# icon:dot-circle[]
brew:
# Enables or disables Homebrew.
# Defaults to `false`.
# Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
# Defaults to `NEVER`.
# icon:dot-circle[]
enabled: true
active: ALWAYS
# Directory with file templates used to prepare the Homebrew distribution
# Defaults to `src/distribution/${distribution.name}/brew`.
@@ -110,9 +111,10 @@ TOML::
# icon:dot-circle[]
[packagers.brew]
# Enables or disables Homebrew.
# Defaults to `false`.
# Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
# Defaults to `NEVER`.
# icon:dot-circle[]
enabled = true
active = "ALWAYS"
# Directory with file templates used to prepare the Homebrew distribution
# Defaults to `src/distribution/${distribution.name}/brew`.
@@ -193,9 +195,10 @@ JSON::
// icon:dot-circle[]
"brew": {
// Enables or disables Homebrew.
// Defaults to `false`.
// Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
// Defaults to `NEVER`.
// icon:dot-circle[]
"enabled": true,
"active": "ALWAYS",
// Directory with file templates used to prepare the Homebrew distribution
// Defaults to `src/distribution/${distribution.name}/brew`.
@@ -296,10 +299,11 @@ Maven::
<brew>
<!--
Enables or disables Homebrew.
Defaults to `false`.
Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
Defaults to `NEVER`.
icon:dot-circle[]
-->
<enabled>true</enabled>
<active>ALWAYS</active>
<!--
Directory with file templates used to prepare the Homebrew distribution
@@ -440,9 +444,10 @@ jreleaser {
// icon:dot-circle[]
brew {
// Enables or disables Homebrew.
// Defaults to `false`.
// Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
// Defaults to `NEVER`.
// icon:dot-circle[]
enabled = true
active = 'ALWAYS'
// Directory with file templates used to prepare the Homebrew distribution
// Defaults to `src/distribution/${distribution.name}/brew`.

52
docs/modules/configuration/pages/packagers/index.adoc
View File

@@ -16,18 +16,18 @@ YAML::
----
packagers:
brew:
enabled: true
active: ALWAYS
scoop:
enabled: true
active: ALWAYS
----
TOML::
+
[source,ytoml]
[source,toml]
[subs="+macros"]
----
[packagers]
brew.enabled = true
scoop.enabled = true
brew.active = "ALWAYS"
scoop.active = "ALWAYS"
----
JSON::
+
@@ -37,10 +37,10 @@ JSON::
{
"packagers": {
"brew": {
"enabled": true
"active": "ALWAYS"
},
"scoop": {
"enabled": true
"active": "ALWAYS"
}
}
}
@@ -53,10 +53,10 @@ Maven::
<jreleaser>
<packagers>
<brew>
<enabled>true</enabled>
<active>ALWAYS</active>
</brew>
<scoop>
<enabled>true</enabled>
<active>ALWAYS</active>
</scoop>
</packagers>
</jreleaser>
@@ -69,10 +69,10 @@ Gradle::
jreleaser {
packagers {
brew {
enabled = true
active = 'ALWAYS'
}
scoop {
enabled = true
active = 'ALWAYS'
}
}
}
@@ -90,14 +90,14 @@ YAML::
----
packagers:
brew:
enabled: true
active: ALWAYS
scoop:
enabled: true
active: ALWAYS
distributions:
app:
scoop:
enabled: false
active: NEVER
----
TOML::
+
@@ -105,11 +105,11 @@ TOML::
[subs="+macros"]
----
[packagers]
brew.enabled = true
scoop.enabled = true
brew.active = "ALWAYS"
scoop.active = "ALWAYS"
[distributions.app]
scoop.enabled = false
scoop.active = "NEVER"
----
JSON::
+
@@ -119,16 +119,16 @@ JSON::
{
"packagers": {
"brew": {
"enabled": true
"active": "ALWAYS"
},
"scoop": {
"enabled": true
"active": "ALWAYS"
}
},
"distributions": {
"app": {
"scoop": {
"enabled": false
"active": "NEVER"
}
}
}
@@ -142,16 +142,16 @@ Maven::
<jreleaser>
<packagers>
<brew>
<enabled>true</enabled>
<active>ALWAYS</active>
</brew>
<scoop>
<enabled>true</enabled>
<active>ALWAYS</active>
</scoop>
</packagers>
<distributions>
<app>
<scoop>
<enabled>false</enabled>
<active>NEVER</active>
</scoop>
</app>
</distributions>
@@ -165,16 +165,16 @@ Gradle::
jreleaser {
packagers {
brew {
enabled = true
active = 'ALWAYS'
}
scoop {
enabled = true
active = 'ALWAYS'
}
}
distributions {
app {
scoop {
enabled = false
active = 'NEVER'
}
}
}

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

@@ -22,9 +22,10 @@ packagers:
# icon:dot-circle[]
jbang:
# Enables or disables Jbang.
# Defaults to `false`.
# Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
# Defaults to `NEVER`.
# icon:dot-circle[]
enabled: true
active: ALWAYS
# Directory with file templates used to prepare the Jbang distribution
# Defaults to `src/distribution/${distribution.name}/jbang`.
@@ -91,9 +92,10 @@ TOML::
[packagers.jbang]
# Enables or disables Jbang.
# Defaults to `false`.
# Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
# Defaults to `NEVER`.
# icon:dot-circle[]
enabled = true
active = "ALWAYS"
# Directory with file templates used to prepare the Jbang distribution
# Defaults to `src/distribution/${distribution.name}/jbang`.
@@ -157,9 +159,10 @@ JSON::
// icon:dot-circle[]
"jbang": {
// Enables or disables Jbang.
// Defaults to `false`.
// Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
// Defaults to `NEVER`.
// icon:dot-circle[]
"enabled": true,
"active": "ALWAYS",
// Directory with file templates used to prepare the Jbang distribution
// Defaults to `src/distribution/${distribution.name}/jbang`.
@@ -239,10 +242,11 @@ Maven::
<jbang>
<!--
Enables or disables Jbang.
Defaults to `false`.
Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
Defaults to `NEVER`.
icon:dot-circle[]
-->
<enabled>true</enabled>
<active>ALWAYS</active>
<!--
Directory with file templates used to prepare the Jbang distribution
@@ -342,9 +346,10 @@ jreleaser {
// icon:dot-circle[]
jbang {
// Enables or disables Jbang.
// Defaults to `false`.
// Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
// Defaults to `NEVER`.
// icon:dot-circle[]
enabled = true
active = 'ALWAYS'
// Directory with file templates used to prepare the Jbang distribution
// Defaults to `src/distribution/${distribution.name}/jbang`.

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

@@ -22,9 +22,10 @@ packagers:
# icon:dot-circle[]
scoop:
# Enables or disables Scoop.
# Defaults to `false`.
# Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
# Defaults to `NEVER`.
# icon:dot-circle[]
enabled: true
active: ALWAYS
# Directory with file templates used to prepare the Scoop distribution
# Defaults to `src/distribution/${distribution.name}/scoop`.
@@ -95,9 +96,10 @@ TOML::
# icon:dot-circle[]
[packagers.scoop]
# Enables or disables Scoop.
# Defaults to `false`.
# Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
# Defaults to `NEVER`.
# icon:dot-circle[]
enabled = true
active = "ALWAYS"
# Directory with file templates used to prepare the Scoop distribution
# Defaults to `src/distribution/${distribution.name}/scoop`.
@@ -166,9 +168,10 @@ JSON::
// icon:dot-circle[]
"scoop": {
// Enables or disables Scoop.
// Defaults to `false`.
// Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
// Defaults to `NEVER`.
// icon:dot-circle[]
"enabled": true,
"active": "ALWAYS",
// Directory with file templates used to prepare the Scoop distribution
// Defaults to `src/distribution/${distribution.name}/scoop`.
@@ -253,10 +256,11 @@ Maven::
<scoop>
<!--
Enables or disables Scoop.
Defaults to `false`.
Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
Defaults to `NEVER`.
icon:dot-circle[]
-->
<enabled>true</enabled>
<active>ALWAYS</active>
<!--
Directory with file templates used to prepare the Scoop distribution
@@ -363,9 +367,10 @@ jreleaser {
// icon:dot-circle[]
scoop {
// Enables or disables Scoop.
// Defaults to `false`.
// Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
// Defaults to `NEVER`.
// icon:dot-circle[]
enabled = true
active = 'ALWAYS'
// Directory with file templates used to prepare the Scoop distribution
// Defaults to `src/distribution/${distribution.name}/scoop`.

25
docs/modules/configuration/pages/packagers/snap.adoc
View File

@@ -27,9 +27,10 @@ packagers:
# icon:dot-circle[]
snap:
# Enables or disables Snap.
# Defaults to `false`.
# Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
# Defaults to `NEVER`.
# icon:dot-circle[]
enabled: true
active: ALWAYS
# Directory with file templates used to prepare the Snap distribution
# Defaults to `src/distribution/${distribution.name}/snap`.
@@ -169,9 +170,10 @@ TOML::
# icon:dot-circle[]
[packagers.snap]
# Enables or disables Snap.
# Defaults to `false`.
# Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
# Defaults to `NEVER`.
# icon:dot-circle[]
enabled = true
active = "ALWAYS"
# Directory with file templates used to prepare the Snap distribution
# Defaults to `src/distribution/${distribution.name}/snap`.
@@ -303,9 +305,10 @@ JSON::
// icon:dot-circle[]
"snap": {
// Enables or disables Snap.
// Defaults to `false`.
// Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
// Defaults to `NEVER`.
// icon:dot-circle[]
"enabled": true,
"active": "ALWAYS",
// Directory with file templates used to prepare the Snap distribution
// Defaults to `src/distribution/${distribution.name}/snap`.
@@ -471,10 +474,11 @@ Maven::
<snap>
<!--
Enables or disables Snap.
Defaults to `false`.
Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
Defaults to `NEVER`.
icon:dot-circle[]
-->
<enabled>true</enabled>
<active>ALWAYS</active>
<!--
Directory with file templates used to prepare the Snap distribution
@@ -678,9 +682,10 @@ jreleaser {
// icon:dot-circle[]
snap {
// Enables or disables Snap.
// Defaults to `false`.
// Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
// Defaults to `NEVER`.
// icon:dot-circle[]
enabled = true
active = 'ALWAYS'
// Directory with file templates used to prepare the Snap distribution
// Defaults to `src/distribution/${distribution.name}/snap`.

26
docs/modules/configuration/pages/signing.adoc
View File

@@ -20,9 +20,10 @@ YAML::
# icon:dot-circle[]
signing:
# Enables or disables file signing.
# Defaults to `false`.
# Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
# Defaults to `NEVER`.
# icon:dot-circle[]
enabled: true
active: ALWAYS
# Generates an armored signature.
# Defaults to `true`.
@@ -55,9 +56,10 @@ TOML::
# icon:dot-circle[]
[signing]
# Enables or disables file signing.
# Defaults to `false`.
# Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
# Defaults to `NEVER`.
# icon:dot-circle[]
enabled = true
active = "ALWAYS"
# Generates an armored signature.
# Defaults to `true`.
@@ -90,10 +92,10 @@ JSON::
{
// icon:dot-circle[]
"signing": {
// Enables or disables file signing.
// Defaults to `false`.
// Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
// Defaults to `NEVER`.
// icon:dot-circle[]
"enabled": true,
"active": "ALWAYS",
// Generates an armored signature.
// Defaults to `true`.
@@ -133,10 +135,11 @@ Maven::
<!--
Enables or disables file signing.
Defaults to `false`.
Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
Defaults to `NEVER`.
icon:dot-circle[]
-->
<enabled>true</enabled>
<active>ALWAYS</active>
<!--
Generates an armored signature.
@@ -180,9 +183,10 @@ jreleaser {
// icon:dot-circle[]
signing {
// Enables or disables file signing.
// Defaults to `false`.
// Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
// Defaults to `NEVER`.
// icon:dot-circle[]
enabled = true
active = "ALWAYS"
// Generates an armored signature.
// Defaults to `true`.

156
docs/modules/tools/pages/cli.adoc
View File

@@ -10,18 +10,18 @@ jreleaser
-h, --help Show this help message and exit.
-V, --version Print version information and exit.
Commands:
init Create a jreleaser config file
config Display current configuration
template Generate a tool template
changelog Calculate the changelog
checksum Calculate checksums
sign Sign release artifacts
release Create or update a release
prepare Prepare all distributions
package Package all distributions
upload Upload all distributions
announce Announce a release
full-release Perform a full release
init Create a jreleaser config file.
config Display current configuration.
template Generate a tool template.
changelog Calculate the changelog.
checksum Calculate checksums.
sign Sign release artifacts.
release Create or update a release..
prepare Prepare all distributions.
package Package all distributions.
upload Upload all distributions.
announce Announce a release.
full-release Perform a full release.
----
The following commands are supported:
@@ -32,13 +32,13 @@ The following commands are supported:
----
$ jreleaser init -h
Usage: jreleaser init [-dhioqVw] [-b=<basedir>] [-f=<format>]
Create a jreleaser config file
-b, --basedir=<basedir> Base directory
Create a jreleaser config file.
-b, --basedir=<basedir> Base directory.
-d, --debug Set log level to debug.
-f, --format=<format> Configuration file format
-f, --format=<format> Configuration file format.
-h, --help Show this help message and exit.
-i, --info Set log level to info.
-o, --overwrite Overwrite existing files
-o, --overwrite Overwrite existing files.
-q, --quiet Log errors only.
-V, --version Print version information and exit.
-w, --warn Set log level to warn.
@@ -53,12 +53,13 @@ The file will be generated at `<basedir>` if specified, otherwise at the current
[source,bash]
----
$ jreleaser config -h
Usage: jreleaser config [-dhiqVw] [-b=<basedir>] [-c=<configFile>]
Display current configuration
-b, --basedir=<basedir> Base directory
Usage: jreleaser config [-dfhiqVw] [-b=<basedir>] [-c=<configFile>]
Display current configuration.
-b, --basedir=<basedir> Base directory.
-c, --config-file=<configFile>
The config file
-d, --debug Set log level to debug.
-f, --full Display full configuration.
-h, --help Show this help message and exit.
-i, --info Set log level to info.
-q, --quiet Log errors only.
@@ -78,20 +79,20 @@ If `--basedir` is undefined then the command assumes it's the same directory tha
$ jreleaser template -h
Usage: jreleaser template [-dhioqsVw] [-b=<basedir>] -dn=<distributionName>
[-dt=<distributionType>] -tn=<toolName>
Generate a tool template
-b, --basedir=<basedir> Base directory
Generate a tool template.
-b, --basedir=<basedir> Base directory.
-d, --debug Set log level to debug.
-dn, --distribution-name=<distributionName>
The name of the distribution
The name of the distribution.
-dt, --distribution-type=<distributionType>
The type of the distribution
The type of the distribution.
-h, --help Show this help message and exit.
-i, --info Set log level to info.
-o, --overwrite Overwrite existing files
-o, --overwrite Overwrite existing files.
-q, --quiet Log errors only.
-s, --snapshot Use snapshot templates
-s, --snapshot Use snapshot templates.
-tn, --tool-name=<toolName>
The name of the tool
The name of the tool.
-V, --version Print version information and exit.
-w, --warn Set log level to warn.
----
@@ -110,10 +111,10 @@ The value of `--tool-name` must match any of the available xref:configuration:pa
[source,bash]
----
jreleaser changelog -h
$ jreleaser changelog -h
Usage: jreleaser changelog [-dhiqVw] [-b=<basedir>] [-c=<configFile>]
Calculate the changelog
-b, --basedir=<basedir> Base directory
Calculate the changelog.
-b, --basedir=<basedir> Base directory.
-c, --config-file=<configFile>
The config file
-d, --debug Set log level to debug.
@@ -133,10 +134,10 @@ If `--basedir` is undefined then the command assumes it's the same directory tha
[source,bash]
----
jreleaser checksum -h
$ jreleaser checksum -h
Usage: jreleaser checksum [-dhiqVw] [-b=<basedir>] [-c=<configFile>]
Calculate checksums
-b, --basedir=<basedir> Base directory
Calculate checksums.
-b, --basedir=<basedir> Base directory.
-c, --config-file=<configFile>
The config file
-d, --debug Set log level to debug.
@@ -156,10 +157,10 @@ If `--basedir` is undefined then the command assumes it's the same directory tha
[source,bash]
----
jreleaser sign -h
$ jreleaser sign -h
Usage: jreleaser sign [-dhiqVw] [-b=<basedir>] [-c=<configFile>]
Sign release artifacts
-b, --basedir=<basedir> Base directory
Sign release artifacts.
-b, --basedir=<basedir> Base directory.
-c, --config-file=<configFile>
The config file
-d, --debug Set log level to debug.
@@ -179,7 +180,7 @@ If `--basedir` is undefined then the command assumes it's the same directory tha
[source,bash]
----
jreleaser release -h
$ jreleaser release -h
Usage: jreleaser release [-dhiqVwy] [--auto-config] [--overwrite]
[--prerelease] [--signing-armored] [--signing-enabled]
[--skip-tag] [--update] [-b=<basedir>]
@@ -190,38 +191,39 @@ Usage: jreleaser release [-dhiqVwy] [--auto-config] [--overwrite]
[--project-name=<projectName>]
[--project-version=<projectVersion>]
[--release-name=<releaseName>] [--tag-name=<tagName>]
[--file=<files>]...
Create or update a release
--auto-config Model auto configuration
-b, --basedir=<basedir> Base directory
[--username=<username>] [--file=<files>]...
Create or update a release..
--auto-config Model auto configuration..
-b, --basedir=<basedir> Base directory.
-c, --config-file=<configFile>
The config file
--changelog=<changelog>
Path to changelog file
Path to changelog file.
--commit-author-email=<commitAuthorEmail>
Commit author e-mail
Commit author e-mail.
--commit-author-name=<commitAuthorName>
Commit author name
Commit author name.
-d, --debug Set log level to debug.
--file=<files> Input file(s) to be uploaded
--file=<files> Input file(s) to be uploaded.
-h, --help Show this help message and exit.
-i, --info Set log level to info.
--milestone-name=<milestoneName>
The milestone name
--overwrite Overwrite an existing release
--prerelease If the release is a prerelease
The milestone name.
--overwrite Overwrite an existing release.
--prerelease If the release is a prerelease.
--project-name=<projectName>
The projects name
The projects name.
--project-version=<projectVersion>
The projects version
The projects version.
-q, --quiet Log errors only.
--release-name=<releaseName>
The release name
--signing-armored Generate ascii armored signatures
--signing-enabled Sign files
--skip-tag Skip tagging the release
--tag-name=<tagName> The release tag
--update Update an existing release
The release name.
--signing-armored Generate ascii armored signatures.
--signing-enabled Sign files.
--skip-tag Skip tagging the release.
--tag-name=<tagName> The release tag.
--update Update an existing release.
--username=<username> Git username.
-V, --version Print version information and exit.
-w, --warn Set log level to warn.
-y, --dryrun Skips remote operations.
@@ -236,6 +238,8 @@ There are two usage modes:
If `--basedir` is undefined then the command assumes it's the same directory where the command is run.
The `--file` parameter is repeatable.
*Explicit Configuration file*
If `--config-file` is undefined then the command assumes the file is named `jreleaser.[yml|toml|json]` and it's
@@ -252,21 +256,21 @@ mutations should occur when this mode is activated.
[source,bash]
----
jreleaser prepare -h
$ jreleaser prepare -h
Usage: jreleaser prepare [-dhiqVw] [-b=<basedir>] [-c=<configFile>]
[-dn=<distributionName>] [-tn=<toolName>]
Prepare all distributions
-b, --basedir=<basedir> Base directory
Prepare all distributions.
-b, --basedir=<basedir> Base directory.
-c, --config-file=<configFile>
The config file
-d, --debug Set log level to debug.
-dn, --distribution-name=<distributionName>
The name of the distribution
The name of the distribution.
-h, --help Show this help message and exit.
-i, --info Set log level to info.
-q, --quiet Log errors only.
-tn, --tool-name=<toolName>
The name of the tool
The name of the tool.
-V, --version Print version information and exit.
-w, --warn Set log level to warn.
----
@@ -313,18 +317,18 @@ $ jreleaser prepare --distribution-name app --tool-name brew
$ jreleaser package -h
Usage: jreleaser package [-dhiqVwy] [-b=<basedir>] [-c=<configFile>]
[-dn=<distributionName>] [-tn=<toolName>]
Package all distributions
-b, --basedir=<basedir> Base directory
Package all distributions.
-b, --basedir=<basedir> Base directory.
-c, --config-file=<configFile>
The config file
-d, --debug Set log level to debug.
-dn, --distribution-name=<distributionName>
The name of the distribution
The name of the distribution.
-h, --help Show this help message and exit.
-i, --info Set log level to info.
-q, --quiet Log errors only.
-tn, --tool-name=<toolName>
The name of the tool
The name of the tool.
-V, --version Print version information and exit.
-w, --warn Set log level to warn.
-y, --dryrun Skips remote operations.
@@ -372,21 +376,21 @@ mutations should occur when this mode is activated.
[source,bash]
----
jreleaser upload -h
$ jreleaser upload -h
Usage: jreleaser upload [-dhiqVwy] [-b=<basedir>] [-c=<configFile>]
[-dn=<distributionName>] [-tn=<toolName>]
Upload all distributions
-b, --basedir=<basedir> Base directory
Upload all distributions.
-b, --basedir=<basedir> Base directory.
-c, --config-file=<configFile>
The config file
-d, --debug Set log level to debug.
-dn, --distribution-name=<distributionName>
The name of the distribution
The name of the distribution.
-h, --help Show this help message and exit.
-i, --info Set log level to info.
-q, --quiet Log errors only.
-tn, --tool-name=<toolName>
The name of the tool
The name of the tool.
-V, --version Print version information and exit.
-w, --warn Set log level to warn.
-y, --dryrun Skips remote operations.
@@ -434,13 +438,13 @@ mutations should occur when this mode is activated.
[source,bash]
----
jreleaser announce -h
$ jreleaser announce -h
Usage: jreleaser announce [-dhiqVwy] [-an=<announcerName>] [-b=<basedir>]
[-c=<configFile>]
Announce a release
Announce a release.
-an, --announcer-name=<announcerName>
The name of the announcer
-b, --basedir=<basedir> Base directory
The name of the announcer.
-b, --basedir=<basedir> Base directory.
-c, --config-file=<configFile>
The config file
-d, --debug Set log level to debug.
@@ -480,10 +484,10 @@ mutations should occur when this mode is activated.
[source,bash]
----
jreleaser full-release -h
$ jreleaser full-release -h
Usage: jreleaser full-release [-dhiqVwy] [-b=<basedir>] [-c=<configFile>]
Perform a full release
-b, --basedir=<basedir> Base directory
Perform a full release.
-b, --basedir=<basedir> Base directory.
-c, --config-file=<configFile>
The config file
-d, --debug Set log level to debug.