@semantic-release/release-notes-generator 14.0.2 → 14.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/README.md +5 -1
  2. package/index.js +6 -1
  3. package/lib/load-changelog-config.js +1 -0
  4. package/package.json +12 -12
package/README.md CHANGED
@@ -11,6 +11,10 @@
11
11
 
12
12
  ## Install
13
13
 
14
+ > [!TIP]
15
+ > You do not need to directly depend on this package if you are using `semantic-release`.
16
+ > `semantic-release` already depends on this package, and defining your own direct dependency can result in conflicts when you update `semantic-release`.
17
+
14
18
  ```bash
15
19
  $ npm install @semantic-release/release-notes-generator -D
16
20
  ```
@@ -67,7 +71,7 @@ With this example:
67
71
  | `linkReferences` | Whether to include a link to issues and commits in the release note. See [conventional-changelog-writer#linkreferences](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-writer#linkreferences). | `true` |
68
72
  | `commit` | Keyword used to generate commit links (formatted as `<host>/<owner>/<repository>/<commit>/<commit_sha>`). See [conventional-changelog-writer#commit](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-writer#commit). | `commits` for Bitbucket repositories, `commit` otherwise |
69
73
  | `issue` | Keyword used to generate issue links (formatted as `<host>/<owner>/<repository>/<issue>/<issue_number>`). See [conventional-changelog-writer#issue](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-writer#issue). | `issue` for Bitbucket repositories, `issues` otherwise |
70
- | `presetConfig` | Additional configuration passed to the [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog) preset. Used for example with [conventional-changelog-conventionalcommits](https://github.com/conventional-changelog/conventional-changelog-config-spec/blob/master/versions/2.0.0/README.md). | - |
74
+ | `presetConfig` | Additional configuration passed to the [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog) preset. Used for example with [conventional-changelog-conventionalcommits](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-conventionalcommits#specific-options). | - |
71
75
 
72
76
  **Notes**: in order to use a `preset` it must be installed (for example to use the [eslint preset](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-eslint) you must install it with `npm install conventional-changelog-eslint -D`)
73
77
 
package/index.js CHANGED
@@ -31,7 +31,7 @@ const debug = debugFactory("semantic-release:release-notes-generator");
31
31
  export async function generateNotes(pluginConfig, context) {
32
32
  const { commits, lastRelease, nextRelease, options, cwd } = context;
33
33
  const repositoryUrl = options.repositoryUrl.replace(/\.git$/i, "");
34
- const { parserOpts, writerOpts } = await loadChangelogConfig(pluginConfig, context);
34
+ const { commitOpts, parserOpts, writerOpts } = await loadChangelogConfig(pluginConfig, context);
35
35
 
36
36
  const [match, auth, host, path] = /^(?!.+:\/\/)(?:(?<auth>.*)@)?(?<host>.*?):(?<path>.*)$/.exec(repositoryUrl) || [];
37
37
  let { hostname, port, pathname, protocol } = new URL(
@@ -52,6 +52,11 @@ export async function generateNotes(pluginConfig, context) {
52
52
  return false;
53
53
  }
54
54
 
55
+ if (commitOpts && commitOpts.ignore && new RegExp(commitOpts.ignore).test(message) && !commitOpts.merges) {
56
+ debug("Skip commit %s by ignore option", hash);
57
+ return false;
58
+ }
59
+
55
60
  return true;
56
61
  })
57
62
  .map((rawCommit) => ({
package/lib/load-changelog-config.js CHANGED
@@ -33,6 +33,7 @@ export default async ({ preset, config, parserOpts, writerOpts, presetConfig },
33
33
  }
34
34
 
35
35
  return {
36
+ commitOpts: loadedConfig.commits,
36
37
  parserOpts: { ...loadedConfig.parser, ...parserOpts },
37
38
  writerOpts: { ...loadedConfig.writer, ...writerOpts },
38
39
  };
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@semantic-release/release-notes-generator",
3
3
  "description": "semantic-release plugin to generate changelog content with conventional-changelog",
4
- "version": "14.0.2",
4
+ "version": "14.1.0",
5
5
  "author": "Pierre Vanduynslager (https://twitter.com/@pvdlg_)",
6
6
  "bugs": {
7
7
  "url": "https://github.com/semantic-release/release-notes-generator/issues"
@@ -17,29 +17,29 @@
17
17
  "conventional-commits-parser": "^6.0.0",
18
18
  "debug": "^4.0.0",
19
19
  "get-stream": "^7.0.0",
20
- "import-from-esm": "^1.0.3",
20
+ "import-from-esm": "^2.0.0",
21
21
  "into-stream": "^7.0.0",
22
22
  "lodash-es": "^4.17.21",
23
23
  "read-package-up": "^11.0.0"
24
24
  },
25
25
  "devDependencies": {
26
- "ava": "6.2.0",
26
+ "ava": "6.4.1",
27
27
  "c8": "10.1.3",
28
28
  "conventional-changelog-atom": "5.0.0",
29
- "conventional-changelog-conventionalcommits": "8.0.0",
29
+ "conventional-changelog-conventionalcommits": "9.1.0",
30
30
  "conventional-changelog-ember": "5.0.0",
31
31
  "conventional-changelog-eslint": "6.0.0",
32
32
  "conventional-changelog-express": "5.0.0",
33
33
  "conventional-changelog-jshint": "5.0.0",
34
34
  "escape-string-regexp": "5.0.0",
35
- "fs-extra": "11.2.0",
36
- "lockfile-lint": "4.14.0",
35
+ "fs-extra": "11.3.1",
36
+ "lockfile-lint": "4.14.1",
37
37
  "ls-engines": "0.9.3",
38
- "npm-run-all2": "7.0.1",
39
- "prettier": "3.4.2",
40
- "publint": "0.2.12",
41
- "semantic-release": "24.2.0",
42
- "sinon": "19.0.2",
38
+ "npm-run-all2": "8.0.4",
39
+ "prettier": "3.6.2",
40
+ "publint": "0.3.12",
41
+ "semantic-release": "24.2.7",
42
+ "sinon": "21.0.0",
43
43
  "stream-buffers": "3.0.3",
44
44
  "tempy": "3.1.0",
45
45
  "testdouble": "3.20.2"
@@ -127,5 +127,5 @@
127
127
  "github>semantic-release/.github:renovate-config"
128
128
  ]
129
129
  },
130
- "packageManager": "npm@10.9.2"
130
+ "packageManager": "npm@11.5.2"
131
131
  }