5.1.0 (#250)

This is the release candidate for version 5.1.0.

---------

Co-authored-by: github-actions <[email protected]>
Co-authored-by: Howard Braham <[email protected]>
Co-authored-by: Gauthier Petetin <[email protected]>

Author: 4 people

CHANGELOG.md

@@ -7,9 +7,37 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [5.1.0]
+
 ### Added
 
-- Look for `CHANGELOG entry:` in the PR description, and look for `no-changelog` label, then apply this to the generated CHANGELOG, plus properly categorize by Conventional Commit type, including our custom ConventionalCommitType.RELEASE (#247)
+- Add `--useChangelogEntry` to `auto-changelog update` ([#247](https://github.com/MetaMask/auto-changelog/pull/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](https://github.com/MetaMask/auto-changelog/pull/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](https://github.com/MetaMask/auto-changelog/pull/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]
 
@@ -160,7 +188,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Fixed
 
-- Correctly calculate the most recent git tag ([#87](https://github.com/MetaMask/auto-changelog/pull/87)) ([#87](https://github.com/MetaMask/auto-changelog/pull/87))
+- Correctly calculate the most recent git tag ([#87](https://github.com/MetaMask/auto-changelog/pull/87))
   - Previously, we passed the path to the project root directory as a parameter to an invocation of `git rev-list`. For all repositories, this caused most tags belonging to merge commits to be excluded. For monorepos, this also caused tags belonging to commits that didn't change any files belonging to the changelog's package / workspace to be excluded.
 
 ## [2.2.0]
@@ -219,14 +247,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
-- The initial `auto-changelog` implementation, adapted from the original `auto-changelog.js` script in `metamask-extension` ([#8](https://github.com/MetaMask/auto-changelog/pull/8)).
+- The initial `auto-changelog` implementation, adapted from the original `auto-changelog.js` script in `metamask-extension`. ([#8](https://github.com/MetaMask/auto-changelog/pull/8))
   Includes the following features:
   - An `update` command ([#26](https://github.com/MetaMask/auto-changelog/pull/26))
   - A `validate` command ([#28](https://github.com/MetaMask/auto-changelog/pull/28))
   - Monorepo support ([#41](https://github.com/MetaMask/auto-changelog/pull/41))
   - Configurable repository URL, version, and changelog file path ([#33](https://github.com/MetaMask/auto-changelog/pull/33), [#31](https://github.com/MetaMask/auto-changelog/pull/31), [#30](https://github.com/MetaMask/auto-changelog/pull/30))
 
-[Unreleased]: https://github.com/MetaMask/auto-changelog/compare/v5.0.2...HEAD
+[Unreleased]: https://github.com/MetaMask/auto-changelog/compare/v5.1.0...HEAD
+[5.1.0]: https://github.com/MetaMask/auto-changelog/compare/v5.0.2...v5.1.0
 [5.0.2]: https://github.com/MetaMask/auto-changelog/compare/v5.0.1...v5.0.2
 [5.0.1]: https://github.com/MetaMask/auto-changelog/compare/v5.0.0...v5.0.1
 [5.0.0]: https://github.com/MetaMask/auto-changelog/compare/v4.1.0...v5.0.0

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/auto-changelog",
-  "version": "5.0.2",
+  "version": "5.1.0",
   "description": "Utilities for validating and updating \"Keep a Changelog\" formatted changelogs",
   "repository": {
     "type": "git",