Document jreleaser/jreleaser#1080

jreleaser · Dec 13, 2022 · f41bcc8 · f41bcc8
1 parent 8bf82aa
commit f41bcc8
Show file tree

Hide file tree

Showing 2 changed files with 56 additions and 2 deletions.
diff --git a/docs/modules/reference/pages/announce/mattermost.adoc b/docs/modules/reference/pages/announce/mattermost.adoc
@@ -35,6 +35,11 @@ include::partial$announce/yaml/common-head.adoc[]
     # Defaults to `src/jreleaser/templates/mattermost.tpl`.
     # icon:dot-circle[]
     messageTemplate: path/to/template/mattermost.tpl
+
+    # Whether to send the payload as is or wrap it with a `text:` property.
+    # Defaults to `true`.
+    # icon:dot-circle[]
+    structuredMessage: false
 ----
 --
 TOML::
@@ -61,6 +66,11 @@ include::partial$announce/toml/common-head.adoc[]
   # Defaults to `src/jreleaser/templates/mattermost.tpl`.
   # icon:dot-circle[]
   messageTemplate = "path/to/template/mattermost.tpl"
+
+  # Whether to send the payload as is or wrap it with a `text:` property.
+  # Defaults to `true`.
+  # icon:dot-circle[]
+  structuredMessage = false
 ----
 --
 JSON::
@@ -86,7 +96,12 @@ include::partial$announce/json/common-head.adoc[]
       // Review the available xref:reference: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",
+
+      // Whether to send the payload as is or wrap it with a `text:` property.
+      // Defaults to `true`.
+      // icon:dot-circle[]
+      "structuredMessage": false
 include::partial$announce/json/common-footer.adoc[]
 ----
 --
@@ -119,6 +134,13 @@ include::partial$announce/maven/common-head.adoc[]
         icon:dot-circle[]
       -->
       <messageTemplate>path/to/template/mattermost.tpl</messageTemplate>
+
+      <!--
+        Whether to send the payload as is or wrap it with a `text:` property.
+        Defaults to `true`.
+        icon:dot-circle[]
+      -->
+      <structuredMessage>false</structuredMessage>
 include::partial$announce/maven/common-footer.adoc[]
 ----
 --
@@ -146,6 +168,11 @@ include::partial$announce/gradle/common-head.adoc[]
       // Defaults to `src/jreleaser/templates/mattermost.tpl`.
       // icon:dot-circle[]
       messageTemplate = 'path/to/template/mattermost.tpl'
+
+      // Whether to send the payload as is or wrap it with a `text:` property.
+      // Defaults to `true`.
+      // icon:dot-circle[]
+      structuredMessage = false
 include::partial$announce/gradle/common-footer.adoc[]
 ----
 --

diff --git a/docs/modules/reference/pages/announce/webhooks.adoc b/docs/modules/reference/pages/announce/webhooks.adoc
@@ -67,6 +67,11 @@ announce:
       # Defaults to `src/jreleaser/templates/myWebhook.tpl`.
       # icon:dot-circle[]
       messageTemplate: path/to/template/myWebhook.tpl
+
+      # Whether to send the payload as is or wrap it with the `${messageProperty}` property.
+      # Defaults to `true`.
+      # icon:dot-circle[]
+      structuredMessage: false
 ----
 --
 TOML::
@@ -122,6 +127,11 @@ TOML::
   # Defaults to `src/jreleaser/templates/myWebhook.tpl`.
   # icon:dot-circle[]
   messageTemplate = "path/to/template/myWebhook.tpl"
+
+  # Whether to send the payload as is or wrap it with the `${messageProperty}` property.
+  # Defaults to `true`.
+  # icon:dot-circle[]
+  structuredMessage = false
 ----
 --
 JSON::
@@ -183,7 +193,12 @@ JSON::
         // Review the available xref:reference:name-templates.adoc[].
         // Defaults to `src/jreleaser/templates/myWebhook.tpl`.
         // icon:dot-circle[]
-        "messageTemplate": "path/to/template/myWebhook.tpl"
+        "messageTemplate": "path/to/template/myWebhook.tpl",
+
+        // Whether to send the payload as is or wrap it with the `${messageProperty}` property.
+        // Defaults to `true`.
+        // icon:dot-circle[]
+        "structuredMessage": false
       }
     }
   }
@@ -274,6 +289,13 @@ Maven::
           icon:dot-circle[]
         -->
         <messageTemplate>path/to/template/myWebhook.tpl</messageTemplate>
+
+        <!--
+          Whether to send the payload as is or wrap it with the `${messageProperty}` property.
+          Defaults to `true`.
+          icon:dot-circle[]
+        -->
+        <structuredMessage>false</structuredMessage>
       </myWebhook>
     </webhooks>
   </announce>
@@ -338,6 +360,11 @@ jreleaser {
         // Defaults to `src/jreleaser/templates/myWebhook.tpl`.
         // icon:dot-circle[]
         messageTemplate = 'path/to/template/myWebhook.tpl'
+
+        // Whether to send the payload as is or wrap it with the `${messageProperty}` property.
+        // Defaults to `true`.
+        // icon:dot-circle[]
+        structuredMessage = false
       }
     }
   }