Skip to content

5.0.0

Choose a tag to compare

@github-actions github-actions released this 28 Mar 16:32
e65c485

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