Document jreleaser/jreleaser#853

jreleaser · Aug 3, 2022 · 517fa84 · 517fa84
1 parent c9d4272
commit 517fa84
Showing 1 changed file with 60 additions and 1 deletion.
diff --git a/docs/modules/configuration/pages/announce/twitter.adoc b/docs/modules/configuration/pages/announce/twitter.adoc
@@ -46,6 +46,18 @@ include::partial$announce/yaml/common-head.adoc[]
     # Review the available xref:configuration:name-templates.adoc[].
     # icon:dot-circle[] icon:file-alt[]
     status: '🚀 {{projectNameCapitalized}} {{projectVersion}} has been released! {{releaseNotesUrl}}'
+
+    # The announcement messages.
+    # Review the available xref:configuration:name-templates.adoc[].
+    # icon:dot-circle[] icon:file-alt[]
+    statuses:
+      - '🚀 {{projectNameCapitalized}} {{projectVersion}} has been released! {{releaseNotesUrl}}'
+      - 'New and exciting features added to {{projectNameCapitalized}} {{projectVersion}}'
+
+    # Path to a template file that contains a list of statuses.
+    # Review the available xref:configuration:name-templates.adoc[].
+    # icon:dot-circle[] icon:file-alt[]
+    statusTemplate: path/to/template/twitter.tpl
 ----
 --
 TOML::
@@ -84,6 +96,16 @@ include::partial$announce/toml/common-head.adoc[]
   # Review the available xref:configuration:name-templates.adoc[].
   # icon:dot-circle[] icon:file-alt[]
   status = "🚀 {{projectNameCapitalized}} {{projectVersion}} has been released! {{releaseNotesUrl}}"
+
+  # The announcement message.
+  # Review the available xref:configuration:name-templates.adoc[].
+  # icon:dot-circle[] icon:file-alt[]
+  statuses = ["🚀 {{projectNameCapitalized}} {{projectVersion}} has been released! {{releaseNotesUrl}}", "New and exciting featurer added to {{projectNameCapitalized}} {{projectVersion}}"]
+
+  # Path to a template file that contains a list of statuses.
+  # Review the available xref:configuration:name-templates.adoc[].
+  # icon:dot-circle[] icon:file-alt[]
+  statusTemplate = "path/to/template/twitter.tpl"
 ----
 --
 JSON::
@@ -122,6 +144,17 @@ include::partial$announce/json/common-head.adoc[]
       // Review the available xref:configuration:name-templates.adoc[].
       // icon:dot-circle[] icon:file-alt[]
       "status": "🚀 {{projectNameCapitalized}} {{projectVersion}} has been released! {{releaseNotesUrl}}"
+
+      // The announcement message.
+      // Review the available xref:configuration:name-templates.adoc[].
+      // icon:dot-circle[] icon:file-alt[]
+      "statuses": [
+        "🚀 {{projectNameCapitalized}} {{projectVersion}} has been released! {{releaseNotesUrl}}","New and exciting featurer added to {{projectNameCapitalized}} {{projectVersion}}"],
+
+      // Path to a template file that contains a list of statuses.
+      // Review the available xref:configuration:name-templates.adoc[].
+      // icon:dot-circle[] icon:file-alt[]
+      "statusTemplate": "path/to/template/twitter.tpl"
 include::partial$announce/json/common-footer.adoc[]
 ----
 --
@@ -164,13 +197,29 @@ include::partial$announce/maven/common-head.adoc[]
         icon:exclamation-triangle[] icon:eye-slash[]
       -->
       <accessTokenSecret>__DO_NOT_SET_HERE__</accessTokenSecret>
-  
+
       <!--
         The announcement message.
         Review the available xref:configuration:name-templates.adoc[].
         icon:dot-circle[] icon:file-alt[]
       -->
       <status>🚀 {{projectNameCapitalized}} {{projectVersion}} has been released! {{releaseNotesUrl}}</status>
+
+      <!--
+        The announcement message.
+        Review the available xref:configuration:name-templates.adoc[].
+        icon:dot-circle[] icon:file-alt[]
+      -->
+      <statuses>
+        <status>🚀 {{projectNameCapitalized}} {{projectVersion}} has been released! {{releaseNotesUrl}}</status>
+        <status>New and exciting featurer added to {{projectNameCapitalized}} {{projectVersion}}</status>
+      </statuses>
+
+      <!-- Path to a template file that contains a list of statuses.
+       Review the available   xref:configuration:name-templates.adoc[].
+         icon:dot-circle[] icon:file-alt[]
+      -->
+      <statusTemplate>path/to/template/twitter.tpl</statusTemplate>
 include::partial$announce/maven/common-footer.adoc[]
 ----
 --
@@ -210,6 +259,16 @@ include::partial$announce/gradle/common-head.adoc[]
       // Review the available xref:configuration:name-templates.adoc[].
       // icon:dot-circle[] icon:file-alt[]
       status = '🚀 {{projectNameCapitalized}} {{projectVersion}} has been released! {{releaseNotesUrl}}'
+      // The announcement message.
+      // Review the available xref:configuration:name-templates.adoc[].
+      // icon:dot-circle[] icon:file-alt[]
+      statuses = [
+        '🚀 {{projectNameCapitalized}} {{projectVersion}} has been released! {{releaseNotesUrl}}','New and exciting featurer added to {{projectNameCapitalized}} {{projectVersion}}']
+
+      // Path to a template file that contains a list of statuses.
+      // Review the available xref:configuration:name-templates.adoc[].
+      // icon:dot-circle[] icon:file-alt[]
+      statusTemplate = 'path/to/template/twitter.tpl'
 include::partial$announce/gradle/common-footer.adoc[]
 ----
 --