Installations

npm install @semantic-release/release-notes-generator

Developer Guide

BETA

Typescript

No

Module System

ESM

Min. Node Version

>=20.8.1

Node Version

22.12.0

NPM Version

10.9.2 Score

50.6

Supply Chain

85.5

Quality

84.6

Maintenance

100

Vulnerability

96.1

License

Pull Requests

Open

10

Total

669

Closed

50

Merged

609

Issues

Open

36

Total

105

Closed

69

Releases

81

v14.0.3

Updated on Jan 03, 2025

v14.0.2

Updated on Dec 16, 2024

v14.0.1

Updated on Jun 22, 2024

v14.0.0

Updated on May 31, 2024

v14.0.0-beta.1

Updated on May 17, 2024

v13.0.0

Updated on Mar 24, 2024

View All 81 releases

Contributors

26

Unable to fetch Contributors

View All 26 Contributors

Languages

1

JavaScript

JavaScript (100%)

Love this project? Help keep it running — sponsor us today! 🚀

Developer

semantic-release

Download Statistics

Total Downloads

221,632,752

Last Day

266,178

Last Week

1,592,222

Last Month

6,549,815

Last Year

69,460,708

GitHub Statistics

MIT License

324 Stars

698 Commits

49 Forks

6 Watchers

5 Branches

26 Contributors

Updated on Feb 15, 2025

Maintainers

4

Package Meta Information

Latest Version

14.0.3

Package Id

@semantic-release/release-notes-generator@14.0.3

Unpacked Size

33.45 kB

Size

5.79 kB

File Count

7

NPM Version

10.9.2

Node Version

22.12.0

Published on

Jan 03, 2025

Total Downloads

Cumulative downloads

Total Downloads

221,632,752

Last Day

4.5%

266,178

Compared to previous day

Last Week

3.4%

1,592,222

Compared to previous week

Last Month

32.7%

6,549,815

Compared to previous month

Last Year

36.7%

69,460,708

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

10

conventional-changelog-angular conventional-changelog-writer conventional-commits-filter conventional-commits-parser debug get-stream import-from-esm into-stream lodash-es read-package-up

Peer Dependencies

1

semantic-release

Dev Dependencies

20

release-notes-generator

semantic-release plugin to generate changelog content with conventional-changelog

Step	Description
`generateNotes`	Generate release notes for the commits added since the last release with conventional-changelog.

Install

1$ npm install @semantic-release/release-notes-generator -D

Usage

The plugin can be configured in the semantic-release configuration file:

1{
2  "plugins": [
3    [
4      "@semantic-release/commit-analyzer",
5      {
6        "preset": "angular",
7        "parserOpts": {
8          "noteKeywords": ["BREAKING CHANGE", "BREAKING CHANGES", "BREAKING"]
9        }
10      }
11    ],
12    [
13      "@semantic-release/release-notes-generator",
14      {
15        "preset": "angular",
16        "parserOpts": {
17          "noteKeywords": ["BREAKING CHANGE", "BREAKING CHANGES", "BREAKING"]
18        },
19        "writerOpts": {
20          "commitsSort": ["subject", "scope"]
21        }
22      }
23    ]
24  ]
25}

With this example:

the commits that contains BREAKING CHANGE, BREAKING CHANGES or BREAKING in their body will be considered breaking changes (by default the angular preset checks only for BREAKING CHANGE and BREAKING CHANGES)
the commits will be sorted in the changelog by subject then scope (by default the angular preset sort the commits in the changelog by scope then subject)

Configuration

Options

Option	Description	Default
`preset`	conventional-changelog preset (possible values: `angular`, `atom`, `codemirror`, `ember`, `eslint`, `express`, `jquery`, `jshint`, `conventionalcommits`).	`angular`
`config`	NPM package name of a custom conventional-changelog preset.	-
`parserOpts`	Additional conventional-commits-parser options that will extends the ones loaded by `preset` or `config`. This is convenient to use a conventional-changelog preset with some customizations without having to create a new module.	-
`writerOpts`	Additional conventional-commits-writer options that will extends the ones loaded by `preset` or `config`. This is convenient to use a conventional-changelog preset with some customizations without having to create a new module.	-
`host`	The host used to generate links to issues and commits. See conventional-changelog-writer#host.	The host from the `repositoryurl` option.
`linkCompare`	Whether to include a link to compare changes since previous release in the release note.	`true`
`linkReferences`	Whether to include a link to issues and commits in the release note. See conventional-changelog-writer#linkreferences.	`true`
`commit`	Keyword used to generate commit links (formatted as `<host>/<owner>/<repository>/<commit>/<commit_sha>`). See conventional-changelog-writer#commit.	`commits` for Bitbucket repositories, `commit` otherwise
`issue`	Keyword used to generate issue links (formatted as `<host>/<owner>/<repository>/<issue>/<issue_number>`). See conventional-changelog-writer#issue.	`issue` for Bitbucket repositories, `issues` otherwise
`presetConfig`	Additional configuration passed to the conventional-changelog preset. Used for example with conventional-changelog-conventionalcommits.	-

Notes: in order to use a preset it must be installed (for example to use the eslint preset you must install it with npm install conventional-changelog-eslint -D)

Note: config will be overwritten by the values of preset. You should use either preset or config, but not both.

Note: Individual properties of parserOpts and writerOpts will override ones loaded with an explicitly set preset or config. If preset or config are not set, only the properties set in parserOpts and writerOpts will be used.

Note: For presets that expects a configuration object, such as conventionalcommits, the presetConfig option must be set.

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Maintained

Determines if the project is "actively maintained".

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

10

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

10

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

10

License

Determines if the project has defined a license.

10

Security-Policy

Determines if the project has published a security policy.

10

Packaging

Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.

6

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

Score

8

/10

Last Scanned on 2025-02-10

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

@semantic-release/release-notes-generator

Installations

Developer Guide

No

ESM

>=20.8.1

22.12.0

10.9.2

Score

Pull Requests

10

669

50

609

Issues

36

105

69

Releases

Contributors

Unable to fetch Contributors

Languages

Developer

semantic-release

Download Statistics

GitHub Statistics

Maintainers

Package Meta Information

Total Downloads

221,632,752

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Dev Dependencies

release-notes-generator

Install

Usage

Configuration

Options

10

10

10

10

10

10

10

10

10

6

0

0

0

8

/10

Other packages similar to @semantic-release/release-notes-generator