changenog

Zero-config changelog generator with monorepo support.

Parses Git tags and commits since last entry, restricts them by current working directory, and adds any missing entries to the changelog.

Running changenog from inside a subdirectory will find the nearest parent that's a git repository, and filter commits to only include those that have changes within that subdirectory.

NOTE: monorepo packages must be tagged in <package-name>/<version> format.

Usage

npm i -D changenog

{
  "scripts": {
    "changenog": "changenog"
  }
}

See this repo's changelog for example output.

Options

• --overwrite - overwrite existing changelog
• --no-links - disable links
• --continue - allow subsequent commands to run on incomplete exit
• --max-commits=<number> - maximum number of commits to process (default: 1000)
• --locale=<string> - valid locale string passed to Intl.DateTimeFormat (default: en-GB)
• --filter-preset=<string> - filter preset to use
• --filter-regex=<string> - regex that a commit must match to be included

Filters

Multiple --filter-preset and --filter-regex options can be used. A commit must match all filters to be included.

For example:

changenog --filter-preset=angular --filter-regex='^(?!.*changelog).*$'

Would filter:

✅
docs(readme): update usage
feat: add new feature
fix: fix bug
perf: improve performance

❌
chore: update dependencies
ci(release): release version
docs(changelog): v0.1.0
my commit message

Presets

• angular - include only feat, fix, perf, and docs commits that match the Angular commit message convention
• angular-readme-only-docs - exclude Angular docs commits unless they have a scope of readme
• no-changelog - exclude all commits with changelog in the subject