Document jreleaser/jreleaser#1028

jreleaser · Dec 2, 2022 · c1b5941 · c1b5941
1 parent bff324a
commit c1b5941
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 0 deletions.
diff --git a/docs/modules/tools/pages/jreleaser-ant.adoc b/docs/modules/tools/pages/jreleaser-ant.adoc
@@ -184,6 +184,16 @@ Description:: The name of the announcer to be used.
 
 ---
 
+*assemblerType*
+[horizontal]
+Type:: String
+Default value:: <none>
+Property:: jreleaser.assembler.type
+Required:: false
+Description:: The type of the assembler to be used.
+
+---
+
 *distributionType*
 [horizontal]
 Type:: String

diff --git a/docs/modules/tools/pages/jreleaser-cli.adoc b/docs/modules/tools/pages/jreleaser-cli.adoc
@@ -199,6 +199,7 @@ Generate a packager/announcer template.
 
 Usage: jreleaser template [-ghioqVw] [-sn] [-b=<basedir>] [-od=<outputdir>]
                           [-D=<key=value>]... ([-a=<announcer>] |
+                          [-st=<assembler-type> -s=<assembler-name>] |
                           [-d=<distribution> -p=<packager> [-dt=<type>]])
 
 Options:
@@ -219,6 +220,12 @@ Announcer templates
   -a, --announcer=<announcer>
                             The name of the announcer.
 
+Assembler templates
+  -s, --assembler-name=<assembler-name>
+                            The name of the assembler.
+      -st, --assembler-type=<assembler-type>
+                            The type of the assembler.
+
 Packager templates
   -d, --distribution=<distribution>
                             The name of the distribution.
@@ -236,6 +243,9 @@ Announcer and tool settings are mutually exclusive.
 
 The value of `--announcer` must match any of the available xref:configuration:announce/index.adoc[announcers].
 
+The value of `--assembler-type` must match any of the available xref:configuration:assemble/index.adoc[assemblers] while
+the value of `--assembler-name` must match any of the available xref:configuration:assemble/index.adoc[assembler names].
+
 The value of `--distribution` must match the name of a configured
 xref:configuration:distributions.adoc[distribution].
 

diff --git a/docs/modules/tools/pages/jreleaser-gradle.adoc b/docs/modules/tools/pages/jreleaser-gradle.adoc
@@ -138,6 +138,10 @@ Type
 Options
      --announcer-name        The name of the announcer (OPTIONAL).
 
+     --assembler-name        The name of the assembler (OPTIONAL).
+
+     --assembler-type        The type of the assembler (OPTIONAL).
+
      --distribution-name     The name of the distribution (OPTIONAL).
 
      --distribution-type     The type of the distribution (OPTIONAL).

diff --git a/docs/modules/tools/pages/jreleaser-maven.adoc b/docs/modules/tools/pages/jreleaser-maven.adoc
@@ -136,6 +136,11 @@ Available parameters:
    Type: String +
    User property: `jreleaser.announcer.name`
 
+ * assemblerType +
+   The type of the assembler +
+   Type: String +
+   User property: `jreleaser.assembler.type`
+
  * distributionName +
    The name of the distribution +
    Type: String +