@alanscodelog/semantic-release-config 4.0.0 → 4.1.0

package/README.md

@@ -1,6 +1,6 @@
 [![Release](https://github.com/alanscodelog/my-semantic-release-config/workflows/Release/badge.svg)](https://www.npmjs.com/package/@alanscodelog/semantic-release-config)
 
-My preferred semantic release config.
+My preferred semantic release config, with support for 0.0.0 versioned releases and showing the full commit body in the release notes.
 
 # Install
 
@@ -26,7 +26,6 @@ yarn add -D @alanscodelog/semantic-release-config
 
 ## Shown in Changelog
 
-
 `feat` :star: New Features (minor)
 
 `fix` :bug: Fixes (patch)
@@ -39,6 +38,8 @@ yarn add -D @alanscodelog/semantic-release-config
 
 `perf` :rocket: Performance Improvements (patch)
 
+The commit body is shown by default, this can be disabled by setting the `SEMANTIC_RELEASE_HIDE_COMMIT_BODY` environment variable to `TRUE`, or per commit by adding `<!--skip-release-notes-->` to the commit body.
+
 ### 0.0.0 Versioned Releases
 
 Workaround for semantic-release's lack of 0.0.0 versioning ([see](https://github.com/semantic-release/semantic-release/issues/1507)).

package/package.json

@@ -1,15 +1,16 @@
 {
 	"name": "@alanscodelog/semantic-release-config",
 	"description": "My preferred semantic release config.",
-	"version": "4.0.0",
+	"version": "4.1.0",
+	"type": "module",
 	"main": "release.config.js",
 	"scripts": {
 		"lint:commits": "commitlint --from $(git rev-list --max-parents=0 HEAD) --to HEAD --verbose",
 		"prepare": "husky"
 	},
 	"dependencies": {
-		"@alanscodelog/commitlint-config": ">=2.0.0",
-		"@alanscodelog/semantic-release-config": "^3.0.0",
+		"@alanscodelog/commitlint-config": "^3.0.1",
+		"@alanscodelog/semantic-release-config": "^4.0.0",
 		"@semantic-release/changelog": "^6.0.3",
 		"@semantic-release/commit-analyzer": "^12.0.0",
 		"@semantic-release/github": "^10.0.5",
@@ -19,7 +20,7 @@
 		"semantic-release": "^23.1.1"
 	},
 	"devDependencies": {
-		"commitlint": "^19.3.0",
+		"@commitlint/cli": "^19.3.0",
 		"husky": "^9.0.11"
 	},
 	"author": "Alan <alanscodelog@gmail.com>",

package/release.config.js

@@ -1,3 +1,8 @@
+import fs from "fs"
+const __dirname = import.meta.dirname;
+const commitPartial = fs.readFileSync(`${__dirname}/template.hbs`).toString()
+
+const showCommitBody = process.env.SEMANTIC_RELEASE_HIDE_COMMIT_BODY !== 'TRUE'
 
 // feat, fix, revert, docs(readme), perf, tests, chore, deps, ci, build, style, refactor, [any type](no-release)
 const hidden = true
@@ -31,8 +36,8 @@ const types = [
 	{ scope: "no-release", release: false },
 ]
 
-let releaseRules = types.filter(_ => _.release !== undefined).map(_ => {
-	let clone = {}
+const releaseRules = types.filter(_ => _.release !== undefined).map(_ => {
+	const clone = {}
 	for (let key of Object.keys(_)) {
 		if (["scope", "type", "breaking", "release"].includes(key)) {
 			if (_[key] !== undefined) clone[key] = _[key]
@@ -41,9 +46,9 @@ let releaseRules = types.filter(_ => _.release !== undefined).map(_ => {
 	return clone
 })
 
-let presetConfig_types = types.filter(_ => _.section !== undefined).map(_ => ({ type: _.type, section: _.section, hidden: _.hidden }))
+const presetConfig_types = types.filter(_ => _.section !== undefined).map(_ => ({ type: _.type, section: _.section, hidden: _.hidden }))
 
-module.exports = {
+export default{
 	__types: types,
 	plugins: [
 		[ "@semantic-release/commit-analyzer", {
@@ -72,6 +77,18 @@ module.exports = {
 					let title_compare = types_a_index - types_b_index
 					return title_compare
 				},
+				...(showCommitBody ? {
+					commitPartial,
+					finalizeContext: (context) => {
+						for (const commitGroup of context.commitGroups) {
+							for (const commit of commitGroup.commits) {
+								if (commit.body?.includes("<!--skip-release-notes-->")) continue
+								commit.commitBody = commit.body//?.split('\n')
+							}
+						}
+						return context
+					}
+				} :{}),
 			},
 			presetConfig: {
 				types: presetConfig_types