@semantic-release/github - npm Package Compare versions

Comparing version 9.0.7 to 9.1.0

lib/definitions/errors.js

@@ -198,1 +198,27 @@ import { inspect } from "node:util";
 }
+
+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,
+    )}\`.`,
+  };
+}

lib/publish.js

@@ -22,3 +22,3 @@ import { resolve, basename, extname } from "node:path";
     branch,
-    nextRelease: { name, gitTag, notes },
+    nextRelease: { gitTag },
     logger,
@@ -33,2 +33,4 @@ } = context;
     draftRelease,
+    releaseNameTemplate,
+    releaseBodyTemplate,
   } = resolveConfig(pluginConfig, context);
@@ -49,4 +51,4 @@ const { owner, repo } = parseGithubUrl(repositoryUrl);
     target_commitish: branch.name,
-    name,
-    body: notes,
+    name: template(releaseNameTemplate)(context),
+    body: template(releaseBodyTemplate)(context),
     prerelease: isPrerelease(branch),
@@ -53,0 +55,0 @@ };

lib/resolve-config.js

@@ -17,2 +17,4 @@ import { isNil, castArray } from "lodash-es";
     draftRelease,
+    releaseNameTemplate,
+    releaseBodyTemplate,
   },
@@ -48,3 +50,9 @@ { env },
     draftRelease: isNil(draftRelease) ? false : draftRelease,
+    releaseBodyTemplate: !isNil(releaseBodyTemplate)
+      ? releaseBodyTemplate
+      : "<%= nextRelease.notes %>",
+    releaseNameTemplate: !isNil(releaseNameTemplate)
+      ? releaseNameTemplate
+      : "<%= nextRelease.name %>",
   };
 }

lib/verify.js

@@ -48,2 +48,4 @@ import {
   draftRelease: isBoolean,
+  releaseBodyTemplate: isNonEmptyString,
+  releaseNameTemplate: isNonEmptyString,
 };
@@ -50,0 +52,0 @@

package.json

 {
   "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",
@@ -46,3 +46,3 @@ "author": "Pierre Vanduynslager (https://twitter.com/@pvdlg_)",
     "prettier": "3.0.3",
-    "semantic-release": "22.0.4",
+    "semantic-release": "22.0.5",
     "sinon": "16.0.0",
@@ -49,0 +49,0 @@ "tempy": "3.1.0"

README.md

@@ -96,2 +96,4 @@ # @semantic-release/github
 | `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 %>`                                                                                                                           |
 
@@ -98,0 +100,0 @@ #### proxy

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

72773

increased by2.86%

Lines of code

1240

increased by2.82%

Number of lines in readme file

227

increased by0.89%

Published versions last months

8

increased by14.29%

Published versions last year

31

increased by3.33%

No dependency changes