feat: add template input

release-drafter · Oct 24, 2023 · e2d8e6d · e2d8e6d
1 parent 09c613e
commit e2d8e6d
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -371,6 +371,7 @@ The Release Drafter GitHub Action accepts a number of optional inputs directly i
 | `latest`                | A string indicating whether the release being created or updated should be marked as latest.                                                                                                                                                                                                                                                                       |
 | `commitish`             | A string specifying the target branch for the release being created.                                                                                                                                                                                                                                                                                               |
 | `header`                | A string that would be added before the template body.                                                                                                                                                                                                                                                                                                             |
+| `template`              | The template for the body of the release.                                                                                                                                                                                                                                                                                                                          |
 | `footer`                | A string that would be added after the template body.                                                                                                                                                                                                                                                                                                              |
 
 ## Action Outputs

diff --git a/action.yml b/action.yml
@@ -58,6 +58,10 @@ inputs:
       A string that would be added before the template body.
     required: false
     default: ''
+  template:
+    description: |
+      The template for the body of the release.
+    required: false
   footer:
     description: |
       A string that would be added after the template body.

diff --git a/index.js b/index.js
@@ -269,6 +269,10 @@ function updateConfigFromInput(config, input) {
     config.header = input.header
   }
 
+  if (input.template) {
+    config.template = input.template
+  }
+
   if (input.footer) {
     config.footer = input.footer
   }

diff --git a/lib/default-config.js b/lib/default-config.js
@@ -32,6 +32,8 @@ const DEFAULT_CONFIG = Object.freeze({
   commitish: '',
   'category-template': `## $TITLE`,
   header: '',
+  template:
+    "# What's Changed\n$CHANGES\n**Full Changelog**: https://github.com/$OWNER/$REPOSITORY/compare/$PREVIOUS_TAG...$RESOLVED_VERSION",
   footer: '',
 })