Conventional Changelog

[build]: https://img.shields.io/github/actions/workflow/status/conventional-changelog/conventional-changelog/tests.yaml?branch=master [build-url]: https://github.com/conventional-changelog/conventional-changelog/actions

[coverage]: https://coveralls.io/repos/github/conventional-changelog/conventional-changelog/badge.svg?branch=master [coverage-url]: https://coveralls.io/github/conventional-changelog/conventional-changelog?branch=master

Generate a CHANGELOG from git metadata.

Getting started

The original conventional-changelog package repo can be found in packages/conventional-changelog.

If you are new to Conventional Commits, we recommend to read The Complete Guide.

We recommend considering the following high level tools for automating versioning, tagging, and CHANGELOG generation:

commit-and-tag-version — a drop-in replacement for npm's version command, handles automated version bumping, tagging, and CHANGELOG generation.
semantic-release — fully automates the release process from CI/CD, including version determination, changelog generation, and publishing.
simple-release-action — a simple GitHub Action to automate version bumps, changelogs, and releases. Supports monorepos and extensibility via addons.

For more details, guides and API references, check out the documentation website.

Skills

This repository includes universal agent skills in the skills directory. The currently available skill is:

conventional-commit-message — helps write Conventional Commit messages

Install it with either package runner:

# pnpm
pnpx skills add conventional-changelog/conventional-changelog --skill conventional-commit-message
# npm
npx skills add conventional-changelog/conventional-changelog --skill conventional-commit-message

Modules Important to Conventional Changelog Ecosystem

conventional-changelog - the full-featured command line interface
standard-changelog - command line interface for the angular commit format
conventional-recommended-bump - get a recommended version bump based on conventional commits
commitizen - simple commit conventions for internet citizens.
commitlint - lint commit messages

conventional-changelog

Installation

README.md