@semantic-release/github 9.0.7 → 9.1.0

package/README.md

@@ -93,6 +93,8 @@ When using the _GITHUB_TOKEN_, the **minimum required permissions** are:
 | `releasedLabels`      | The [labels](https://help.github.com/articles/about-labels) to add to each issue and pull request resolved by the release. Set to `false` to not add any label. See [releasedLabels](#releasedlabels). | `['released<%= nextRelease.channel ? \` on @\${nextRelease.channel}\` : "" %>']-                                                                     |
 | `addReleases`         | Will add release links to the GitHub Release. Can be `false`, `"bottom"` or `"top"`. See [addReleases](#addReleases).                                                                                  | `false`                                                                                                                                              |
 | `draftRelease`        | A boolean indicating if a GitHub Draft Release should be created instead of publishing an actual GitHub Release.                                                                                       | `false`                                                                                                                                              |
+| `releaseNameTemplate` | A [Lodash template](https://lodash.com/docs#template) to customize the github release's name                                                                                                           | `<%= nextverison.name %>`                                                                                                                            |
+| `releaseBodyTemplate` | A [Lodash template](https://lodash.com/docs#template) to customize the github release's body                                                                                                           | `<%= nextverison.notes %>`                                                                                                                           |
 
 #### proxy
 

package/lib/definitions/errors.js

@@ -195,3 +195,29 @@ export function ENOGHTOKEN({ owner, repo }) {
 Please make sure to create a [GitHub personal token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line) and to set it in the \`GH_TOKEN\` or \`GITHUB_TOKEN\` environment variable on your CI environment. The token must allow to push to the repository ${owner}/${repo}.`,
   };
 }
+
+export function EINVALIDRELEASEBODYTEMPLATE({ releaseBodyTemplate }) {
+  return {
+    message: "Invalid `releaseBodyTemplate` option.",
+    details: `The [releaseBodyTemplate option](${linkify(
+      "README.md#releaseBodyTemplate",
+    )}) must be a non empty \`String\`.
+
+Your configuration for the \`releaseBodyTemplate\` option is \`${stringify(
+      releaseBodyTemplate,
+    )}\`.`,
+  };
+}
+
+export function EINVALIDRELEASENAMETEMPLATE({ releaseNameTemplate }) {
+  return {
+    message: "Invalid `releaseNameTemplate` option.",
+    details: `The [releaseNameTemplate option](${linkify(
+      "README.md#releaseNameTemplate",
+    )}) must be a non empty \`String\`.
+
+Your configuration for the \`releaseNameTemplate\` option is \`${stringify(
+      releaseNameTemplate,
+    )}\`.`,
+  };
+}

package/lib/publish.js

@@ -19,7 +19,7 @@ export default async function publish(pluginConfig, context, { Octokit }) {
     cwd,
     options: { repositoryUrl },
     branch,
-    nextRelease: { name, gitTag, notes },
+    nextRelease: { gitTag },
     logger,
   } = context;
   const {
@@ -29,6 +29,8 @@ export default async function publish(pluginConfig, context, { Octokit }) {
     proxy,
     assets,
     draftRelease,
+    releaseNameTemplate,
+    releaseBodyTemplate,
   } = resolveConfig(pluginConfig, context);
   const { owner, repo } = parseGithubUrl(repositoryUrl);
   const octokit = new Octokit(
@@ -44,8 +46,8 @@ export default async function publish(pluginConfig, context, { Octokit }) {
     repo,
     tag_name: gitTag,
     target_commitish: branch.name,
-    name,
-    body: notes,
+    name: template(releaseNameTemplate)(context),
+    body: template(releaseBodyTemplate)(context),
     prerelease: isPrerelease(branch),
   };
 

package/lib/resolve-config.js

@@ -14,6 +14,8 @@ export default function resolveConfig(
     releasedLabels,
     addReleases,
     draftRelease,
+    releaseNameTemplate,
+    releaseBodyTemplate,
   },
   { env },
 ) {
@@ -44,5 +46,11 @@ export default function resolveConfig(
       : castArray(releasedLabels),
     addReleases: isNil(addReleases) ? false : addReleases,
     draftRelease: isNil(draftRelease) ? false : draftRelease,
+    releaseBodyTemplate: !isNil(releaseBodyTemplate)
+      ? releaseBodyTemplate
+      : "<%= nextRelease.notes %>",
+    releaseNameTemplate: !isNil(releaseNameTemplate)
+      ? releaseNameTemplate
+      : "<%= nextRelease.name %>",
   };
 }

package/lib/verify.js

@@ -45,6 +45,8 @@ const VALIDATORS = {
   releasedLabels: canBeDisabled(isArrayOf(isNonEmptyString)),
   addReleases: canBeDisabled(oneOf(["bottom", "top"])),
   draftRelease: isBoolean,
+  releaseBodyTemplate: isNonEmptyString,
+  releaseNameTemplate: isNonEmptyString,
 };
 
 export default async function verify(pluginConfig, context, { Octokit }) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@semantic-release/github",
   "description": "semantic-release plugin to publish a GitHub release and comment on released Pull Requests/Issues",
-  "version": "9.0.7",
+  "version": "9.1.0",
   "type": "module",
   "author": "Pierre Vanduynslager (https://twitter.com/@pvdlg_)",
   "ava": {
@@ -43,7 +43,7 @@
     "cpy": "10.1.0",
     "fetch-mock": "npm:@gr2m/fetch-mock@9.11.0-pull-request-644.1",
     "prettier": "3.0.3",
-    "semantic-release": "22.0.4",
+    "semantic-release": "22.0.5",
     "sinon": "16.0.0",
     "tempy": "3.1.0"
   },