What is @semantic-release/release-notes-generator?
The @semantic-release/release-notes-generator package is a plugin for the semantic-release system. It automates the generation of release notes based on your project's commit history, adhering to the Semantic Versioning specification. This tool parses commit messages, groups them into sections, and formats them into a markdown document, which can then be used in release documentation.
What are @semantic-release/release-notes-generator's main functionalities?
Generate release notes
This feature automates the creation of release notes from commits. The code sample shows how to use the release-notes-generator in a Node.js script to generate release notes by providing plugin configuration and context.
const generateNotes = require('@semantic-release/release-notes-generator');
async function generateReleaseNotes(pluginConfig, context) {
const notes = await generateNotes(pluginConfig, context);
console.log(notes);
}
Other packages similar to @semantic-release/release-notes-generator
conventional-changelog
Like @semantic-release/release-notes-generator, conventional-changelog generates changelogs and release notes from a project's commit messages, following the conventional commit format. It offers more extensive customization options and plugins for different release systems, making it versatile but potentially more complex to configure.
lerna-changelog
Lerna-changelog is specifically designed for monorepos managed with Lerna and generates changelogs based on PR titles and labels. It's less flexible than @semantic-release/release-notes-generator for non-monorepo projects but is an excellent fit for projects using Lerna.