feat(preset): support ignoreCommits option (#836)

Author: roggervalf

index.js

@@ -31,7 +31,7 @@ const debug = debugFactory("semantic-release:release-notes-generator");
 export async function generateNotes(pluginConfig, context) {
   const { commits, lastRelease, nextRelease, options, cwd } = context;
   const repositoryUrl = options.repositoryUrl.replace(/\.git$/i, "");
-  const { parserOpts, writerOpts } = await loadChangelogConfig(pluginConfig, context);
+  const { commitOpts, parserOpts, writerOpts } = await loadChangelogConfig(pluginConfig, context);
 
   const [match, auth, host, path] = /^(?!.+:\/\/)(?:(?<auth>.*)@)?(?<host>.*?):(?<path>.*)$/.exec(repositoryUrl) || [];
   let { hostname, port, pathname, protocol } = new URL(
@@ -52,6 +52,11 @@ export async function generateNotes(pluginConfig, context) {
           return false;
         }
 
+        if (commitOpts && commitOpts.ignore && new RegExp(commitOpts.ignore).test(message) && !commitOpts.merges) {
+          debug("Skip commit %s by ignore option", hash);
+          return false;
+        }
+
         return true;
       })
       .map((rawCommit) => ({

lib/load-changelog-config.js

@@ -33,6 +33,7 @@ export default async ({ preset, config, parserOpts, writerOpts, presetConfig },
   }
 
   return {
+    commitOpts: loadedConfig.commits,
     parserOpts: { ...loadedConfig.parser, ...parserOpts },
     writerOpts: { ...loadedConfig.writer, ...writerOpts },
   };

test/integration.test.js

@@ -249,6 +249,32 @@ test.serial('Accept a partial "presetConfig" object as option', async (t) => {
   t.regex(changelog, new RegExp(escape("* Change test ([222](https://github.com/owner/repo/commit/222))")));
 });
 
+test.serial('Accept ignoreCommits in "presetConfig" object as option', async (t) => {
+  const { generateNotes } = await import("../index.js");
+  const commits = [
+    { hash: "111", message: "fix: First fix" },
+    { hash: "222", message: "test: Change test [python]" },
+  ];
+  const changelog = await generateNotes(
+    {
+      preset: "conventionalcommits",
+      presetConfig: {
+        ignoreCommits: "\\[python\\]",
+        types: [
+          { type: "fix", section: "Bug Fixes", hidden: false },
+          { type: "test", section: "Test !!", hidden: false },
+        ],
+      },
+    },
+    { cwd, options: { repositoryUrl }, lastRelease, nextRelease, commits }
+  );
+
+  t.regex(changelog, /### Bug Fixes/);
+  t.regex(changelog, new RegExp(escape("First fix")));
+  t.notRegex(changelog, /### Test !!/);
+  t.notRegex(changelog, new RegExp(escape("* Change test ([222](https://github.com/owner/repo/commit/222))")));
+});
+
 test.serial('Use "gitHead" from "lastRelease" and "nextRelease" if "gitTag" is not defined', async (t) => {
   const { generateNotes } = await import("../index.js");
   const commits = [