From 477ef26de93eec98bfd60cea3556d6fd7509fd39 Mon Sep 17 00:00:00 2001 From: Andres Almiray Date: Sun, 30 May 2021 00:09:05 +0200 Subject: [PATCH] Document latest changes --- .../configuration/pages/announce/discord.adoc | 36 +- .../pages/announce/discussions.adoc | 36 +- .../configuration/pages/announce/gitter.adoc | 36 +- .../configuration/pages/announce/mail.adoc | 34 + .../pages/announce/mastodon.adoc | 36 +- .../pages/announce/mattermost.adoc | 36 +- .../configuration/pages/announce/sdkman.adoc | 36 +- .../configuration/pages/announce/slack.adoc | 36 +- .../configuration/pages/announce/teams.adoc | 36 +- .../configuration/pages/announce/twitter.adoc | 36 +- .../configuration/pages/announce/zulip.adoc | 36 +- .../configuration/pages/assemble/jlink.adoc | 10 +- .../pages/assemble/native-image.adoc | 10 +- .../configuration/pages/distributions.adoc | 10 +- .../configuration/pages/name-templates.adoc | 829 +++++++++++++++++- .../pages/packagers/chocolatey.adoc | 10 +- .../configuration/pages/packagers/docker.adoc | 10 +- .../pages/packagers/homebrew.adoc | 10 +- .../configuration/pages/packagers/jbang.adoc | 10 +- .../configuration/pages/packagers/scoop.adoc | 10 +- .../configuration/pages/packagers/snap.adoc | 10 +- docs/modules/configuration/pages/project.adoc | 65 +- .../modules/tools/pages/jreleaser-gradle.adoc | 1 + docs/modules/tools/pages/jreleaser-maven.adoc | 15 +- 24 files changed, 1324 insertions(+), 70 deletions(-) diff --git a/docs/modules/configuration/pages/announce/discord.adoc b/docs/modules/configuration/pages/announce/discord.adoc index 1e2c4b8..edfc854 100644 --- a/docs/modules/configuration/pages/announce/discord.adoc +++ b/docs/modules/configuration/pages/announce/discord.adoc @@ -57,6 +57,12 @@ announce: # Defaults to `src/jreleaser/templates/discord.tpl`. # icon:dot-circle[] messageTemplate: path/to/template/discord.tpl + + # Additional properties used when evaluating templates. + # icon:dot-circle[] icon:file-alt[] + extraProperties: + # Key will be capitalized and prefixed with `discord`, i.e, `discordFoo`. + foo: bar ---- TOML:: + @@ -98,6 +104,11 @@ TOML:: # Defaults to `src/jreleaser/templates/discord.tpl`. # icon:dot-circle[] messageTemplate = "path/to/template/discord.tpl" + + # Additional properties used when evaluating templates. + # icon:dot-circle[] icon:file-alt[] + extraProperties.foo = "bar" + # Key will be capitalized and prefixed with `discord`, i.e, `discordFoo`. ---- JSON:: + @@ -140,7 +151,14 @@ JSON:: // Review the available xref:configuration:name-templates.adoc[]. // Defaults to `src/jreleaser/templates/discord.tpl`. // icon:dot-circle[] - "messageTemplate": "path/to/template/discord.tpl" + "messageTemplate": "path/to/template/discord.tpl", + + // Additional properties used when evaluating templates. + // icon:dot-circle[] icon:file-alt[] + "extraProperties": { + // Key will be capitalized and prefixed with `discord`, i.e, `discordFoo`. + "foo": "bar" + } } } } @@ -203,6 +221,17 @@ Maven:: icon:dot-circle[] --> path/to/template/discord.tpl + + + + + bar + @@ -249,6 +278,11 @@ jreleaser { // Defaults to `src/jreleaser/templates/discord.tpl`. // icon:dot-circle[] messageTemplate = 'path/to/template/discord.tpl' + + // Additional properties used when evaluating templates. + // Key will be capitalized and prefixed with `discord`, i.e, `discordFoo`. + // icon:dot-circle[] icon:file-alt[] + extraProperties.put('foo', 'bar') } } } diff --git a/docs/modules/configuration/pages/announce/discussions.adoc b/docs/modules/configuration/pages/announce/discussions.adoc index 436c26a..b7ba1ca 100644 --- a/docs/modules/configuration/pages/announce/discussions.adoc +++ b/docs/modules/configuration/pages/announce/discussions.adoc @@ -55,6 +55,12 @@ announce: # Defaults to `src/jreleaser/templates/discussions.tpl`. # icon:dot-circle[] messageTemplate: path/to/template/discussions.tpl + + # Additional properties used when evaluating templates. + # icon:dot-circle[] icon:file-alt[] + extraProperties: + # Key will be capitalized and prefixed with `discussions`, i.e, `discussionsFoo`. + foo: bar ---- TOML:: + @@ -103,6 +109,11 @@ TOML:: # Defaults to `src/jreleaser/templates/discussions.tpl`. # icon:dot-circle[] messageTemplate = "path/to/template/discussions.tpl" + + # Additional properties used when evaluating templates. + # icon:dot-circle[] icon:file-alt[] + extraProperties.foo = "bar" + # Key will be capitalized and prefixed with `discussions`, i.e, `discussionsFoo`. ---- JSON:: + @@ -152,7 +163,14 @@ JSON:: // Review the available xref:configuration:name-templates.adoc[]. // Defaults to `src/jreleaser/templates/discussions.tpl`. // icon:dot-circle[] - "messageTemplate": "path/to/template/discussions.tpl" + "messageTemplate": "path/to/template/discussions.tpl", + + // Additional properties used when evaluating templates. + // icon:dot-circle[] icon:file-alt[] + "extraProperties": { + // Key will be capitalized and prefixed with `discussions`, i.e, `discussionsFoo`. + "foo": "bar" + } } } } @@ -227,6 +245,17 @@ Maven:: icon:dot-circle[] --> path/to/template/discussions.tpl + + + + + bar + @@ -280,6 +309,11 @@ jreleaser { // Defaults to `src/jreleaser/templates/discussions.tpl`. // icon:dot-circle[] messageTemplate = 'path/to/template/discussions.tpl' + + // Additional properties used when evaluating templates. + // Key will be capitalized and prefixed with `discussions`, i.e, `discussionsFoo`. + // icon:dot-circle[] icon:file-alt[] + extraProperties.put('foo', 'bar') } } } diff --git a/docs/modules/configuration/pages/announce/gitter.adoc b/docs/modules/configuration/pages/announce/gitter.adoc index 829e3b7..4bc12b4 100644 --- a/docs/modules/configuration/pages/announce/gitter.adoc +++ b/docs/modules/configuration/pages/announce/gitter.adoc @@ -56,6 +56,12 @@ announce: # Defaults to `src/jreleaser/templates/gitter.tpl`. # icon:dot-circle[] messageTemplate: path/to/template/gitter.tpl + + # Additional properties used when evaluating templates. + # icon:dot-circle[] icon:file-alt[] + extraProperties: + # Key will be capitalized and prefixed with `gitter`, i.e, `gitterFoo`. + foo: bar ---- TOML:: + @@ -97,6 +103,11 @@ TOML:: # Defaults to `src/jreleaser/templates/gitter.tpl`. # icon:dot-circle[] messageTemplate = "path/to/template/gitter.tpl" + + # Additional properties used when evaluating templates. + # icon:dot-circle[] icon:file-alt[] + extraProperties.foo = "bar" + # Key will be capitalized and prefixed with `gitter`, i.e, `gitterFoo`. ---- JSON:: + @@ -139,7 +150,14 @@ JSON:: // Review the available xref:configuration:name-templates.adoc[]. // Defaults to `src/jreleaser/templates/gitter.tpl`. // icon:dot-circle[] - "messageTemplate": "path/to/template/gitter.tpl" + "messageTemplate": "path/to/template/gitter.tpl", + + // Additional properties used when evaluating templates. + // icon:dot-circle[] icon:file-alt[] + "extraProperties": { + // Key will be capitalized and prefixed with `gitter`, i.e, `gitterFoo`. + "foo": "bar" + } } } } @@ -202,6 +220,17 @@ Maven:: icon:dot-circle[] --> path/to/template/gitter.tpl + + + + + bar + @@ -248,6 +277,11 @@ jreleaser { // Defaults to `src/jreleaser/templates/gitter.tpl`. // icon:dot-circle[] messageTemplate = 'path/to/template/gitter.tpl' + + // Additional properties used when evaluating templates. + // Key will be capitalized and prefixed with `gitter`, i.e, `gitterFoo`. + // icon:dot-circle[] icon:file-alt[] + extraProperties.put('foo', 'bar') } } } diff --git a/docs/modules/configuration/pages/announce/mail.adoc b/docs/modules/configuration/pages/announce/mail.adoc index 7a3f2a6..f3e360d 100644 --- a/docs/modules/configuration/pages/announce/mail.adoc +++ b/docs/modules/configuration/pages/announce/mail.adoc @@ -99,6 +99,12 @@ announce: # icon:dot-circle[] properties: 'mail.smtp.starttls.enable': true + + # Additional properties used when evaluating templates. + # icon:dot-circle[] icon:file-alt[] + extraProperties: + # Key will be capitalized and prefixed with `mail`, i.e, `mailFoo`. + foo: bar ---- TOML:: + @@ -191,6 +197,11 @@ TOML:: # Use this field to set properties such as `mail.smtp.starttls.enable`. # icon:dot-circle[] properties."mail.smtp.starttls.enable" = "true" + + # Additional properties used when evaluating templates. + # icon:dot-circle[] icon:file-alt[] + extraProperties.foo = "bar" + # Key will be capitalized and prefixed with `mail`, i.e, `mailFoo`. ---- JSON:: + @@ -284,6 +295,13 @@ JSON:: // icon:dot-circle[] "properties": { "mail.smtp.starttls.enable": true + }, + + // Additional properties used when evaluating templates. + // icon:dot-circle[] icon:file-alt[] + "extraProperties": { + // Key will be capitalized and prefixed with `mail`, i.e, `mailFoo`. + "foo": "bar" } } } @@ -421,6 +439,17 @@ Maven:: true + + + + + bar + @@ -518,6 +547,11 @@ jreleaser { // Use this field to set properties such as `mail.smtp.starttls.enable`. // icon:dot-circle[] properties.put('mail.smtp.starttls.enable', 'true') + + // Additional properties used when evaluating templates. + // Key will be capitalized and prefixed with `mail`, i.e, `mailFoo`. + // icon:dot-circle[] icon:file-alt[] + extraProperties.put('foo', 'bar') } } } diff --git a/docs/modules/configuration/pages/announce/mastodon.adoc b/docs/modules/configuration/pages/announce/mastodon.adoc index c3e56f6..5601653 100644 --- a/docs/modules/configuration/pages/announce/mastodon.adoc +++ b/docs/modules/configuration/pages/announce/mastodon.adoc @@ -45,6 +45,12 @@ announce: # Review the available xref:configuration:name-templates.adoc[]. # icon:dot-circle[] icon:file-alt[] status: icon:rocket[] {{projectNameCapitalized}} {{projectVersion}} has been released! {{releaseNotesUrl}} + + # Additional properties used when evaluating templates. + # icon:dot-circle[] icon:file-alt[] + extraProperties: + # Key will be capitalized and prefixed with `mastodon`, i.e, `mastodonFoo`. + foo: bar ---- TOML:: + @@ -84,6 +90,11 @@ TOML:: # Review the available xref:configuration:name-templates.adoc[]. # icon:dot-circle[] icon:file-alt[] status = "icon:rocket[] {{projectNameCapitalized}} {{projectVersion}} has been released! {{releaseNotesUrl}}" + + # Additional properties used when evaluating templates. + # icon:dot-circle[] icon:file-alt[] + extraProperties.foo = "bar" + # Key will be capitalized and prefixed with `mastodon`, i.e, `mastodonFoo`. ---- JSON:: + @@ -124,7 +135,14 @@ JSON:: // The announcement status. // Review the available xref:configuration:name-templates.adoc[]. // icon:dot-circle[] icon:file-alt[] - "status": "icon:rocket[] {{projectNameCapitalized}} {{projectVersion}} has been released! {{releaseNotesUrl}}" + "status": "icon:rocket[] {{projectNameCapitalized}} {{projectVersion}} has been released! {{releaseNotesUrl}}", + + // Additional properties used when evaluating templates. + // icon:dot-circle[] icon:file-alt[] + "extraProperties": { + // Key will be capitalized and prefixed with `mastodon`, i.e, `mastodonFoo`. + "foo": "bar" + } } } } @@ -186,6 +204,17 @@ Maven:: icon:dot-circle[] icon:file-alt[] --> icon:rocket[] {{projectNameCapitalized}} {{projectVersion}} has been released! {{releaseNotesUrl}} + + + + + bar + @@ -230,6 +259,11 @@ jreleaser { // Review the available xref:configuration:name-templates.adoc[]. // icon:dot-circle[] icon:file-alt[] status = 'icon:rocket[] {{projectNameCapitalized}} {{projectVersion}} has been released! {{releaseNotesUrl}}' + + // Additional properties used when evaluating templates. + // Key will be capitalized and prefixed with `mastodon`, i.e, `mastodonFoo`. + // icon:dot-circle[] icon:file-alt[] + extraProperties.put('foo', 'bar') } } } diff --git a/docs/modules/configuration/pages/announce/mattermost.adoc b/docs/modules/configuration/pages/announce/mattermost.adoc index acb3654..f02b699 100644 --- a/docs/modules/configuration/pages/announce/mattermost.adoc +++ b/docs/modules/configuration/pages/announce/mattermost.adoc @@ -50,6 +50,12 @@ announce: # Defaults to `src/jreleaser/templates/mattermost.tpl`. # icon:dot-circle[] messageTemplate: path/to/template/mattermost.tpl + + # Additional properties used when evaluating templates. + # icon:dot-circle[] icon:file-alt[] + extraProperties: + # Key will be capitalized and prefixed with `mattermost`, i.e, `mattermostFoo`. + foo: bar ---- TOML:: + @@ -91,6 +97,11 @@ TOML:: # Defaults to `src/jreleaser/templates/mattermost.tpl`. # icon:dot-circle[] messageTemplate = "path/to/template/mattermost.tpl" + + # Additional properties used when evaluating templates. + # icon:dot-circle[] icon:file-alt[] + extraProperties.foo = "bar" + # Key will be capitalized and prefixed with `mattermost`, i.e, `mattermostFoo`. ---- JSON:: + @@ -133,7 +144,14 @@ JSON:: // Review the available xref:configuration:name-templates.adoc[]. // Defaults to `src/jreleaser/templates/mattermost.tpl`. // icon:dot-circle[] - "messageTemplate": "path/to/template/mattermost.tpl" + "messageTemplate": "path/to/template/mattermost.tpl", + + // Additional properties used when evaluating templates. + // icon:dot-circle[] icon:file-alt[] + "extraProperties": { + // Key will be capitalized and prefixed with `mattermost`, i.e, `mattermostFoo`. + "foo": "bar" + } } } } @@ -196,6 +214,17 @@ Maven:: icon:dot-circle[] --> path/to/template/mattermost.tpl + + + + + bar + @@ -242,6 +271,11 @@ jreleaser { // Defaults to `src/jreleaser/templates/mattermost.tpl`. // icon:dot-circle[] messageTemplate = 'path/to/template/mattermost.tpl' + + // Additional properties used when evaluating templates. + // Key will be capitalized and prefixed with `mattermost`, i.e, `mattermostFoo`. + // icon:dot-circle[] icon:file-alt[] + extraProperties.put('foo', 'bar') } } } diff --git a/docs/modules/configuration/pages/announce/sdkman.adoc b/docs/modules/configuration/pages/announce/sdkman.adoc index 1b52cd2..7c2401d 100644 --- a/docs/modules/configuration/pages/announce/sdkman.adoc +++ b/docs/modules/configuration/pages/announce/sdkman.adoc @@ -53,6 +53,12 @@ announce: # environment variable must be defined. # icon:exclamation-triangle[] icon:eye-slash[] consumerToken: __DO_NOT_SET_HERE__ + + # Additional properties used when evaluating templates. + # icon:dot-circle[] icon:file-alt[] + extraProperties: + # Key will be capitalized and prefixed with `sdkman`, i.e, `sdkmanFoo`. + foo: bar ---- TOML:: + @@ -99,6 +105,11 @@ TOML:: # environment variable must be defined. # icon:exclamation-triangle[] icon:eye-slash[] consumerToken = "__DO_NOT_SET_HERE__" + + # Additional properties used when evaluating templates. + # icon:dot-circle[] icon:file-alt[] + extraProperties.foo = "bar" + # Key will be capitalized and prefixed with `sdkman`, i.e, `sdkmanFoo`. ---- JSON:: + @@ -146,7 +157,14 @@ JSON:: // If left unspecified, the `JRELEASER_SDKMAN_CONSUMER_TOKEN` // environment variable must be defined. // icon:exclamation-triangle[] icon:eye-slash[] - "consumerToken": "__DO_NOT_SET_HERE__" + "consumerToken": "__DO_NOT_SET_HERE__", + + // Additional properties used when evaluating templates. + // icon:dot-circle[] icon:file-alt[] + "extraProperties": { + // Key will be capitalized and prefixed with `sdkman`, i.e, `sdkmanFoo`. + "foo": "bar" + } } } } @@ -216,6 +234,17 @@ Maven:: icon:exclamation-triangle[] icon:eye-slash[] --> __DO_NOT_SET_HERE__ + + + + + bar + @@ -266,6 +295,11 @@ jreleaser { // environment variable must be defined. // icon:exclamation-triangle[] icon:eye-slash[] consumerToken = "__DO_NOT_SET_HERE__" + + // Additional properties used when evaluating templates. + // Key will be capitalized and prefixed with `sdkman`, i.e, `sdkmanFoo`. + // icon:dot-circle[] icon:file-alt[] + extraProperties.put('foo', 'bar') } } } diff --git a/docs/modules/configuration/pages/announce/slack.adoc b/docs/modules/configuration/pages/announce/slack.adoc index 0ce3525..14ddc73 100644 --- a/docs/modules/configuration/pages/announce/slack.adoc +++ b/docs/modules/configuration/pages/announce/slack.adoc @@ -72,6 +72,12 @@ announce: # Defaults to `src/jreleaser/templates/slack.tpl`. # icon:dot-circle[] messageTemplate: path/to/template/slack.tpl + + # Additional properties used when evaluating templates. + # icon:dot-circle[] icon:file-alt[] + extraProperties: + # Key will be capitalized and prefixed with `slack`, i.e, `slackFoo`. + foo: bar ---- TOML:: + @@ -124,6 +130,11 @@ TOML:: # Defaults to `src/jreleaser/templates/slack.tpl`. # icon:dot-circle[] messageTemplate = "path/to/template/slack.tpl" + + # Additional properties used when evaluating templates. + # icon:dot-circle[] icon:file-alt[] + extraProperties.foo = "bar" + # Key will be capitalized and prefixed with `slack`, i.e, `slackFoo`. ---- JSON:: + @@ -177,7 +188,14 @@ JSON:: // Review the available xref:configuration:name-templates.adoc[]. // Defaults to `src/jreleaser/templates/slack.tpl`. // icon:dot-circle[] - "messageTemplate": "path/to/template/slack.tpl" + "messageTemplate": "path/to/template/slack.tpl", + + // Additional properties used when evaluating templates. + // icon:dot-circle[] icon:file-alt[] + "extraProperties": { + // Key will be capitalized and prefixed with `slack`, i.e, `slackFoo`. + "foo": "bar" + } } } } @@ -254,6 +272,17 @@ Maven:: icon:dot-circle[] --> path/to/template/slack.tpl + + + + + bar + @@ -311,6 +340,11 @@ jreleaser { // Defaults to `src/jreleaser/templates/slack.tpl`. // icon:dot-circle[] messageTemplate = 'path/to/template/slack.tpl' + + // Additional properties used when evaluating templates. + // Key will be capitalized and prefixed with `slack`, i.e, `slackFoo`. + // icon:dot-circle[] icon:file-alt[] + extraProperties.put('foo', 'bar') } } } diff --git a/docs/modules/configuration/pages/announce/teams.adoc b/docs/modules/configuration/pages/announce/teams.adoc index 9e7fb24..f37816e 100644 --- a/docs/modules/configuration/pages/announce/teams.adoc +++ b/docs/modules/configuration/pages/announce/teams.adoc @@ -52,6 +52,12 @@ announce: # Defaults to `src/jreleaser/templates/teams.tpl`. # icon:exclamation-triangle[] messageTemplate: path/to/template/teams.tpl + + # Additional properties used when evaluating templates. + # icon:dot-circle[] icon:file-alt[] + extraProperties: + # Key will be capitalized and prefixed with `teams`, i.e, `teamsFoo`. + foo: bar ---- TOML:: + @@ -88,6 +94,11 @@ TOML:: # Defaults to `src/jreleaser/templates/teams.tpl`. # icon:exclamation-triangle[] messageTemplate = "path/to/template/teams.tpl" + + # Additional properties used when evaluating templates. + # icon:dot-circle[] icon:file-alt[] + extraProperties.foo = "bar" + # Key will be capitalized and prefixed with `teams`, i.e, `teamsFoo`. ---- JSON:: + @@ -125,7 +136,14 @@ JSON:: // Review the available xref:configuration:name-templates.adoc[]. // Defaults to `src/jreleaser/templates/teams.tpl`. // icon:dot-circle[] icon:exclamation-triangle[] - "messageTemplate": "path/to/template/teams.tpl" + "messageTemplate": "path/to/template/teams.tpl", + + // Additional properties used when evaluating templates. + // icon:dot-circle[] icon:file-alt[] + "extraProperties": { + // Key will be capitalized and prefixed with `teams`, i.e, `teamsFoo`. + "foo": "bar" + } } } } @@ -181,6 +199,17 @@ Maven:: icon:dot-circle[] icon:exclamation-triangle[] --> path/to/template/teams.tpl + + + + + bar + @@ -222,6 +251,11 @@ jreleaser { // Defaults to `src/jreleaser/templates/teams.tpl`. // icon:dot-circle[] icon:exclamation-triangle[] messageTemplate = 'path/to/template/teams.tpl' + + // Additional properties used when evaluating templates. + // Key will be capitalized and prefixed with `teams`, i.e, `teamsFoo`. + // icon:dot-circle[] icon:file-alt[] + extraProperties.put('foo', 'bar') } } } diff --git a/docs/modules/configuration/pages/announce/twitter.adoc b/docs/modules/configuration/pages/announce/twitter.adoc index fa65573..ca13f89 100644 --- a/docs/modules/configuration/pages/announce/twitter.adoc +++ b/docs/modules/configuration/pages/announce/twitter.adoc @@ -61,6 +61,12 @@ announce: # Review the available xref:configuration:name-templates.adoc[]. # icon:dot-circle[] icon:file-alt[] status: icon:rocket[] {{projectNameCapitalized}} {{projectVersion}} has been released! {{releaseNotesUrl}} + + # Additional properties used when evaluating templates. + # icon:dot-circle[] icon:file-alt[] + extraProperties: + # Key will be capitalized and prefixed with `twitter`, i.e, `twitterFoo`. + foo: bar ---- TOML:: + @@ -114,6 +120,11 @@ TOML:: # Review the available xref:configuration:name-templates.adoc[]. # icon:dot-circle[] icon:file-alt[] status = "icon:rocket[] {{projectNameCapitalized}} {{projectVersion}} has been released! {{releaseNotesUrl}}" + + # Additional properties used when evaluating templates. + # icon:dot-circle[] icon:file-alt[] + extraProperties.foo = "bar" + # Key will be capitalized and prefixed with `twitter`, i.e, `twitterFoo`. ---- JSON:: + @@ -168,7 +179,14 @@ JSON:: // The announcement message. // Review the available xref:configuration:name-templates.adoc[]. // icon:dot-circle[] icon:file-alt[] - "status": "icon:rocket[] {{projectNameCapitalized}} {{projectVersion}} has been released! {{releaseNotesUrl}}" + "status": "icon:rocket[] {{projectNameCapitalized}} {{projectVersion}} has been released! {{releaseNotesUrl}}", + + // Additional properties used when evaluating templates. + // icon:dot-circle[] icon:file-alt[] + "extraProperties": { + // Key will be capitalized and prefixed with `twitter`, i.e, `twitterFoo`. + "foo": "bar" + } } } } @@ -248,6 +266,17 @@ Maven:: icon:dot-circle[] icon:file-alt[] --> icon:rocket[] {{projectNameCapitalized}} {{projectVersion}} has been released! {{releaseNotesUrl}} + + + + + bar + @@ -306,6 +335,11 @@ jreleaser { // Review the available xref:configuration:name-templates.adoc[]. // icon:dot-circle[] icon:file-alt[] status = 'icon:rocket[] {{projectNameCapitalized}} {{projectVersion}} has been released! {{releaseNotesUrl}}' + + // Additional properties used when evaluating templates. + // Key will be capitalized and prefixed with `twitter`, i.e, `twitterFoo`. + // icon:dot-circle[] icon:file-alt[] + extraProperties.put('foo', 'bar') } } } diff --git a/docs/modules/configuration/pages/announce/zulip.adoc b/docs/modules/configuration/pages/announce/zulip.adoc index c99a88f..6d28aee 100644 --- a/docs/modules/configuration/pages/announce/zulip.adoc +++ b/docs/modules/configuration/pages/announce/zulip.adoc @@ -66,6 +66,12 @@ announce: # Defaults to `src/jreleaser/templates/zulip.tpl`. # icon:dot-circle[] messageTemplate: path/to/template/zulip.tpl + + # Additional properties used when evaluating templates. + # icon:dot-circle[] icon:file-alt[] + extraProperties: + # Key will be capitalized and prefixed with `zulip`, i.e, `zulipFoo`. + foo: bar ---- TOML:: + @@ -125,6 +131,11 @@ TOML:: # Defaults to `src/jreleaser/templates/zulip.tpl`. # icon:dot-circle[] messageTemplate = "path/to/template/zulip.tpl" + + # Additional properties used when evaluating templates. + # icon:dot-circle[] icon:file-alt[] + extraProperties.foo = "bar" + # Key will be capitalized and prefixed with `zulip`, i.e, `zulipFoo`. ---- JSON:: + @@ -185,7 +196,14 @@ JSON:: // Review the available xref:configuration:name-templates.adoc[]. // Defaults to `src/jreleaser/templates/zulip.tpl`. // icon:dot-circle[] - "messageTemplate": "path/to/template/zulip.tpl" + "messageTemplate": "path/to/template/zulip.tpl", + + // Additional properties used when evaluating templates. + // icon:dot-circle[] icon:file-alt[] + "extraProperties": { + // Key will be capitalized and prefixed with `zulip`, i.e, `zulipFoo`. + "foo": "bar" + } } } } @@ -275,6 +293,17 @@ Maven:: icon:dot-circle[] --> path/to/template/zulip.tpl + + + + + bar + @@ -339,6 +368,11 @@ jreleaser { // Defaults to `src/jreleaser/templates/zulip.tpl`. // icon:dot-circle[] messageTemplate = 'path/to/template/zulip.tpl' + + // Additional properties used when evaluating templates. + // Key will be capitalized and prefixed with `zulip`, i.e, `zulipFoo`. + // icon:dot-circle[] icon:file-alt[] + extraProperties.put('foo', 'bar') } } } diff --git a/docs/modules/configuration/pages/assemble/jlink.adoc b/docs/modules/configuration/pages/assemble/jlink.adoc index b05e2cb..6922f79 100644 --- a/docs/modules/configuration/pages/assemble/jlink.adoc +++ b/docs/modules/configuration/pages/assemble/jlink.adoc @@ -112,7 +112,7 @@ assemble: recursive: true # Additional properties used when evaluating templates. - # icon:dot-circle[] + # icon:dot-circle[] icon:file-alt[] extraProperties: # Key will be capitalized and prefixed with `jlink`, i.e, `jlinkFoo`. foo: bar @@ -240,7 +240,7 @@ TOML:: recursive = true # Additional properties used when evaluating templates. - # icon:dot-circle[] + # icon:dot-circle[] icon:file-alt[] extraProperties.foo = "bar" # Key will be capitalized and prefixed with `jlink`, i.e, `jlinkFoo`. @@ -387,7 +387,7 @@ JSON:: ], // Additional properties used when evaluating templates. - // icon:dot-circle[] + // icon:dot-circle[] icon:file-alt[] "extraProperties": { // Key will be capitalized and prefixed with `jlink`, i.e, `jlinkFoo`. "foo": "bar" @@ -589,7 +589,7 @@ Maven:: + bar + + + + +---- +Gradle:: ++ +[source,groovy] +[subs="+macros"] +---- +jreleaser { + announce { + discord { + // Key will be capitalized and prefixed + // with `discord`, i.e, `discordFoo`. + extraProperties.put('foo', 'bar') + } + } +} +---- +==== + +== Discussions + +Every key/value from `discussions.extraProperties` is mapped with `discussions` as key prefix and the capitalized +key, such that + +[tabs] +==== +YAML:: ++ +[source,yaml] +[subs="+macros"] +---- +announce: + discussions: + extraProperties: + # Key will be capitalized and prefixed + # with `discussions`, i.e, `discussionsFoo`. + foo: bar +---- +TOML:: ++ +[source,toml] +[subs="+macros"] +---- +[announce.discussions] + # Key will be capitalized and prefixed + # with `discussions`, i.e, `discussionsFoo`. + extraProperties.foo = "bar" +---- +JSON:: ++ +[source,json] +[subs="+macros"] +---- +{ + "announce": { + "discussions": { + "extraProperties": { + // Key will be capitalized and prefixed + // with `discussions`, i.e, `discussionsFoo`. + "foo": "bar" + } + } + } +} +---- +Maven:: ++ +[source,xml] +[subs="+macros,verbatim"] +---- + + + + + + bar + + + + +---- +Gradle:: ++ +[source,groovy] +[subs="+macros"] +---- +jreleaser { + announce { + discussions { + // Key will be capitalized and prefixed + // with `discussions`, i.e, `discussionsFoo`. + extraProperties.put('foo', 'bar') + } + } +} +---- +==== + +== Mail + +Every key/value from `mail.extraProperties` is mapped with `mail` as key prefix and the capitalized +key, such that + +[tabs] +==== +YAML:: ++ +[source,yaml] +[subs="+macros"] +---- +announce: + mail: + extraProperties: + # Key will be capitalized and prefixed + # with `mail`, i.e, `mailFoo`. + foo: bar +---- +TOML:: ++ +[source,toml] +[subs="+macros"] +---- +[announce.mail] + # Key will be capitalized and prefixed + # with `mail`, i.e, `mailFoo`. + extraProperties.foo = "bar" +---- +JSON:: ++ +[source,json] +[subs="+macros"] +---- +{ + "announce": { + "mail": { + "extraProperties": { + // Key will be capitalized and prefixed + // with `mail`, i.e, `mailFoo`. + "foo": "bar" + } + } + } +} +---- +Maven:: ++ +[source,xml] +[subs="+macros,verbatim"] +---- + + + + + + bar + + + + +---- +Gradle:: ++ +[source,groovy] +[subs="+macros"] +---- +jreleaser { + announce { + mail { + // Key will be capitalized and prefixed + // with `mail`, i.e, `mailFoo`. + extraProperties.put('foo', 'bar') + } + } +} +---- +==== + +== Mastodon + +Every key/value from `mastodon.extraProperties` is mapped with `mastodon` as key prefix and the capitalized +key, such that + +[tabs] +==== +YAML:: ++ +[source,yaml] +[subs="+macros"] +---- +announce: + mastodon: + extraProperties: + # Key will be capitalized and prefixed + # with `mastodon`, i.e, `mastodonFoo`. + foo: bar +---- +TOML:: ++ +[source,toml] +[subs="+macros"] +---- +[announce.mastodon] + # Key will be capitalized and prefixed + # with `mastodon`, i.e, `mastodonFoo`. + extraProperties.foo = "bar" +---- +JSON:: ++ +[source,json] +[subs="+macros"] +---- +{ + "announce": { + "mastodon": { + "extraProperties": { + // Key will be capitalized and prefixed + // with `mastodon`, i.e, `mastodonFoo`. + "foo": "bar" + } + } + } +} +---- +Maven:: ++ +[source,xml] +[subs="+macros,verbatim"] +---- + + + + + + bar + + + + +---- +Gradle:: ++ +[source,groovy] +[subs="+macros"] +---- +jreleaser { + announce { + mastodon { + // Key will be capitalized and prefixed + // with `mastodon`, i.e, `mastodonFoo`. + extraProperties.put('foo', 'bar') + } + } +} +---- +==== + +== Mattermost + +Every key/value from `mattermost.extraProperties` is mapped with `mattermost` as key prefix and the capitalized +key, such that + +[tabs] +==== +YAML:: ++ +[source,yaml] +[subs="+macros"] +---- +announce: + mattermost: + extraProperties: + # Key will be capitalized and prefixed + # with `mattermost`, i.e, `mattermostFoo`. + foo: bar +---- +TOML:: ++ +[source,toml] +[subs="+macros"] +---- +[announce.mattermost] + # Key will be capitalized and prefixed + # with `mattermost`, i.e, `mattermostFoo`. + extraProperties.foo = "bar" +---- +JSON:: ++ +[source,json] +[subs="+macros"] +---- +{ + "announce": { + "mattermost": { + "extraProperties": { + // Key will be capitalized and prefixed + // with `mattermost`, i.e, `mattermostFoo`. + "foo": "bar" + } + } + } +} +---- +Maven:: ++ +[source,xml] +[subs="+macros,verbatim"] +---- + + + + + + bar + + + + +---- +Gradle:: ++ +[source,groovy] +[subs="+macros"] +---- +jreleaser { + announce { + mattermost { + // Key will be capitalized and prefixed + // with `mattermost`, i.e, `mattermostFoo`. + extraProperties.put('foo', 'bar') + } + } +} +---- +==== + +== Sdkman + +Every key/value from `sdkman.extraProperties` is mapped with `sdkman` as key prefix and the capitalized +key, such that + +[tabs] +==== +YAML:: ++ +[source,yaml] +[subs="+macros"] +---- +announce: + sdkman: + extraProperties: + # Key will be capitalized and prefixed + # with `sdkman`, i.e, `sdkmanFoo`. + foo: bar +---- +TOML:: ++ +[source,toml] +[subs="+macros"] +---- +[announce.sdkman] + # Key will be capitalized and prefixed + # with `sdkman`, i.e, `sdkmanFoo`. + extraProperties.foo = "bar" +---- +JSON:: ++ +[source,json] +[subs="+macros"] +---- +{ + "announce": { + "sdkman": { + "extraProperties": { + // Key will be capitalized and prefixed + // with `sdkman`, i.e, `sdkmanFoo`. + "foo": "bar" + } + } + } +} +---- +Maven:: ++ +[source,xml] +[subs="+macros,verbatim"] +---- + + + + + + bar + + + + +---- +Gradle:: ++ +[source,groovy] +[subs="+macros"] +---- +jreleaser { + announce { + sdkman { + // Key will be capitalized and prefixed + // with `sdkman`, i.e, `sdkmanFoo`. + extraProperties.put('foo', 'bar') + } + } +} +---- +==== + +== Slack + +Every key/value from `slack.extraProperties` is mapped with `slack` as key prefix and the capitalized +key, such that + +[tabs] +==== +YAML:: ++ +[source,yaml] +[subs="+macros"] +---- +announce: + slack: + extraProperties: + # Key will be capitalized and prefixed + # with `slack`, i.e, `slackFoo`. + foo: bar +---- +TOML:: ++ +[source,toml] +[subs="+macros"] +---- +[announce.slack] + # Key will be capitalized and prefixed + # with `slack`, i.e, `slackFoo`. + extraProperties.foo = "bar" +---- +JSON:: ++ +[source,json] +[subs="+macros"] +---- +{ + "announce": { + "slack": { + "extraProperties": { + // Key will be capitalized and prefixed + // with `slack`, i.e, `slackFoo`. + "foo": "bar" + } + } + } +} +---- +Maven:: ++ +[source,xml] +[subs="+macros,verbatim"] +---- + + + + + + bar + + + + +---- +Gradle:: ++ +[source,groovy] +[subs="+macros"] +---- +jreleaser { + announce { + slack { + // Key will be capitalized and prefixed + // with `slack`, i.e, `slackFoo`. + extraProperties.put('foo', 'bar') + } + } +} +---- +==== + +== Teams + +Every key/value from `teams.extraProperties` is mapped with `teams` as key prefix and the capitalized +key, such that + +[tabs] +==== +YAML:: ++ +[source,yaml] +[subs="+macros"] +---- +announce: + teams: + extraProperties: + # Key will be capitalized and prefixed + # with `teams`, i.e, `teamsFoo`. + foo: bar +---- +TOML:: ++ +[source,toml] +[subs="+macros"] +---- +[announce.teams] + # Key will be capitalized and prefixed + # with `teams`, i.e, `teamsFoo`. + extraProperties.foo = "bar" +---- +JSON:: ++ +[source,json] +[subs="+macros"] +---- +{ + "announce": { + "teams": { + "extraProperties": { + // Key will be capitalized and prefixed + // with `teams`, i.e, `teamsFoo`. + "foo": "bar" + } + } + } +} +---- +Maven:: ++ +[source,xml] +[subs="+macros,verbatim"] +---- + + + + + + bar + + + + +---- +Gradle:: ++ +[source,groovy] +[subs="+macros"] +---- +jreleaser { + announce { + teams { + // Key will be capitalized and prefixed + // with `teams`, i.e, `teamsFoo`. + extraProperties.put('foo', 'bar') + } + } +} +---- +==== + +== Twitter + +Every key/value from `twitter.extraProperties` is mapped with `twitter` as key prefix and the capitalized +key, such that + +[tabs] +==== +YAML:: ++ +[source,yaml] +[subs="+macros"] +---- +announce: + twitter: + extraProperties: + # Key will be capitalized and prefixed + # with `twitter`, i.e, `twitterFoo`. + foo: bar +---- +TOML:: ++ +[source,toml] +[subs="+macros"] +---- +[announce.twitter] + # Key will be capitalized and prefixed + # with `twitter`, i.e, `twitterFoo`. + extraProperties.foo = "bar" +---- +JSON:: ++ +[source,json] +[subs="+macros"] +---- +{ + "announce": { + "twitter": { + "extraProperties": { + // Key will be capitalized and prefixed + // with `twitter`, i.e, `twitterFoo`. + "foo": "bar" + } + } + } +} +---- +Maven:: ++ +[source,xml] +[subs="+macros,verbatim"] +---- + + + + + + bar + + + + +---- +Gradle:: ++ +[source,groovy] +[subs="+macros"] +---- +jreleaser { + announce { + twitter { + // Key will be capitalized and prefixed + // with `twitter`, i.e, `twitterFoo`. + extraProperties.put('foo', 'bar') + } + } +} +---- +==== + +== Zulip + +Every key/value from `zulip.extraProperties` is mapped with `zulip` as key prefix and the capitalized +key, such that + +[tabs] +==== +YAML:: ++ +[source,yaml] +[subs="+macros"] +---- +announce: + zulip: + extraProperties: + # Key will be capitalized and prefixed + # with `zulip`, i.e, `zulipFoo`. + foo: bar +---- +TOML:: ++ +[source,toml] +[subs="+macros"] +---- +[announce.zulip] + # Key will be capitalized and prefixed + # with `zulip`, i.e, `zulipFoo`. + extraProperties.foo = "bar" +---- +JSON:: ++ +[source,json] +[subs="+macros"] +---- +{ + "announce": { + "zulip": { + "extraProperties": { + // Key will be capitalized and prefixed + // with `zulip`, i.e, `zulipFoo`. + "foo": "bar" + } + } + } +} +---- +Maven:: ++ +[source,xml] +[subs="+macros,verbatim"] +---- + + + + + + bar + + + + +---- +Gradle:: ++ +[source,groovy] +[subs="+macros"] +---- +jreleaser { + announce { + zulip { + // Key will be capitalized and prefixed + // with `zulip`, i.e, `zulipFoo`. + extraProperties.put('foo', 'bar') + } + } +} +---- +==== + diff --git a/docs/modules/configuration/pages/packagers/chocolatey.adoc b/docs/modules/configuration/pages/packagers/chocolatey.adoc index 4b0d9a6..5931c46 100644 --- a/docs/modules/configuration/pages/packagers/chocolatey.adoc +++ b/docs/modules/configuration/pages/packagers/chocolatey.adoc @@ -35,7 +35,7 @@ packagers: templateDirectory: path/to/chocolatey/templates # Additional properties used when evaluating templates. - # icon:dot-circle[] + # icon:dot-circle[] icon:file-alt[] extraProperties: # Key will be capitalized and prefixed with `chocolatey`, i.e, `chocolateyFoo`. foo: bar @@ -109,7 +109,7 @@ TOML:: templateDirectory = "path/to/chocolatey/templates" # Additional properties used when evaluating templates. - # icon:dot-circle[] + # icon:dot-circle[] icon:file-alt[] extraProperties.foo = "bar" # Key will be capitalized and prefixed with `chocolatey`, i.e, `chocolateyFoo`. @@ -182,7 +182,7 @@ JSON:: "templateDirectory": "path/to/chocolatey/templates", // Additional properties used when evaluating templates. - // icon:dot-circle[] + // icon:dot-circle[] icon:file-alt[] "extraProperties": { // Key will be capitalized and prefixed with `chocolatey`, i.e, `chocolateyFoo`. "foo": "bar" @@ -274,7 +274,7 @@ Maven:: + 2021 Duke + + + pass:[https://acme.com/app/docs] + +