5.3.0

Added

• Add --requirePrNumbers flag to auto-changelog update CLI command for generation-time filtering (#253)
  • When enabled, commits without PR numbers are filtered out from the changelog
  • Disabled by default for backward compatibility
  • The updateChangelog function also supports this option via the requirePrNumbers parameter

5.2.0

Added

• Deduplicate commits with no PR number in subject (#254)
  • For commits with no PR number in the subject (non-"Squash & Merge" commits), deduplication now checks if exact description text already exists in changelog
  • Merge commits are deduplicated using commit body instead of the generic merge subject

5.1.0

Added

• Add --useChangelogEntry to auto-changelog update (#247)
  • This will read the PR referenced in each commit message, look for CHANGELOG entry: in the PR description, and use this as the new changelog entry in the changelog (or skip if the no-changelog label is present on the PR)
  • Note that GITHUB_TOKEN must be set in order to use this option
  • The updateChangelog function also supports this option
• Add --useShortPrLink to auto-changelog update (#247)
  • This will generate short references to PRs, e.g. #123 instead of [#123](https://some/repo)
  • The updateChangelog function also supports this option

Changed

• Update auto-changelog update --autoCategorize to exclude entries with certain phrases or Conventional Commit prefixes (#247)
  • If commit messages have the following prefixes they will not be automatically added to the changelog:
    • style
    • refactor
    • test
    • build
    • ci
    • release
  • If commit messages have the following phrases they will not be automatically added to the changelog:
    • Bump main version to
    • changelog
    • cherry-pick
    • cp-
    • e2e
    • flaky test
    • INFRA-
    • merge
    • New Crowdin translations

5.0.2

Fixed

• Fix --autoCategorize so that commit messages with Conventional Commit prefixes are categorized correctly when the prefix contains a scope (e.g. feat(scope): ...) (#240)

5.0.1

Fixed

• Fix CLI path (#235)

5.0.0

Added

• JavaScript sources and TypeScript declarations are now available in both CommonJS- and ESM-compatible variants (#226)
• Add option to changelog validation to ensure that each entry in the changelog links to one or more originating PRs (#222)
  • Pass --pr-links to the CLI, or pass ensureValidPrLinksPresent to validateChangelog to enable this behavior, ideally in your lint package script or CI workflow
• Add an optional shouldExtractPrLinks option to parseChangelog (#222)
  • When true, this will extract pull request links from the text of each entry, identify the pull numbers, and keep them in a separate array
  • See note on Changelog.getReleaseChanges below for more

Changed

• BREAKING: Changelog.getReleaseChanges now returns an object whose values are objects of shape { description: string; prNumbers: string[] } rather than simply string (the description) (#222)
  • This affects parseChangelog as well, since it returns an instance of Changelog
• BREAKING: Bump minimum Node version to 18.20 (#227)
• BREAKING: Custom subpath imports are no longer supported (#226)
  • You may now only import @metamask/auto-changelog and @metamask/auto-changelog/package.json

4.1.0

Added

• Add --autoCategorize flag to update command (#212)
  • When populating the Unreleased section, the tool will look for Conventional Commits prefixes in commit message subjects and place matching commits in corresponding categories automatically.
  • Supported prefixes are feat (which routes to "Added") and fix (which routes to "Fixed").

4.0.0

Changed

• BREAKING: Drop support for Node.js <18.18 (#203)
• BREAKING: Require prettier@>=3.0.0 (#202)
  • Prettier is now a peer dependency of this package.
• BREAKING: Enable Prettier formatting by default (#204)
  • Changelogs are now formatted with Prettier by default when using the CLI.
  • You can opt-out of this change by specifying --no-prettier.

3.4.4

Added

• Retain tag history on update command for renamed packages with new options (#182)

  • Introduced --version-before-package-rename and --tag-prefix-before-package-rename options for update command.

3.4.3

Changed

• Place this library under the MIT / Apache 2.0 dual license (#175)