Skip to content

Commit 7c440fc

Browse files
chore: formatting changelog (#242)
Formatting changelog MD according to Release RP action generated code to prevent next release PR to include formatting changes. See #241 (comment)
1 parent c5a1264 commit 7c440fc

File tree

1 file changed

+57
-2
lines changed

1 file changed

+57
-2
lines changed

CHANGELOG.md

Lines changed: 57 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# Changelog
2+
23
All notable changes to this project will be documented in this file.
34

45
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
@@ -7,11 +8,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
78
## [Unreleased]
89

910
## [5.0.1]
11+
1012
### Fixed
13+
1114
- Fix CLI path ([#235](https://github.com/MetaMask/auto-changelog/pull/235))
1215

1316
## [5.0.0]
17+
1418
### Added
19+
1520
- JavaScript sources and TypeScript declarations are now available in both CommonJS- and ESM-compatible variants ([#226](https://github.com/MetaMask/auto-changelog/pull/226))
1621
- Add option to changelog validation to ensure that each entry in the changelog links to one or more originating PRs ([#222](https://github.com/MetaMask/auto-changelog/pull/222))
1722
- Pass `--pr-links` to the CLI, or pass `ensureValidPrLinksPresent` to `validateChangelog` to enable this behavior, ideally in your `lint` package script or CI workflow
@@ -20,20 +25,25 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
2025
- See note on `Changelog.getReleaseChanges` below for more
2126

2227
### Changed
28+
2329
- **BREAKING:** `Changelog.getReleaseChanges` now returns an object whose values are objects of shape `{ description: string; prNumbers: string[] }` rather than simply `string` (the description) ([#222](https://github.com/MetaMask/auto-changelog/pull/222))
2430
- This affects `parseChangelog` as well, since it returns an instance of `Changelog`
2531
- **BREAKING:** Bump minimum Node version to 18.20 ([#227](https://github.com/MetaMask/auto-changelog/pull/227))
2632
- **BREAKING:** Custom subpath imports are no longer supported ([#226](https://github.com/MetaMask/auto-changelog/pull/226))
2733
- You may now only import `@metamask/auto-changelog` and `@metamask/auto-changelog/package.json`
2834

2935
## [4.1.0]
36+
3037
### Added
38+
3139
- Add `--autoCategorize` flag to `update` command ([#212](https://github.com/MetaMask/auto-changelog/pull/212))
3240
- When populating the Unreleased section, the tool will look for [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) prefixes in commit message subjects and place matching commits in corresponding categories automatically.
3341
- Supported prefixes are `feat` (which routes to "Added") and `fix` (which routes to "Fixed").
3442

3543
## [4.0.0]
44+
3645
### Changed
46+
3747
- **BREAKING:** Drop support for Node.js <18.18 ([#203](https://github.com/MetaMask/auto-changelog/pull/203))
3848
- **BREAKING:** Require `prettier@>=3.0.0` ([#202](https://github.com/MetaMask/auto-changelog/pull/202))
3949
- Prettier is now a peer dependency of this package.
@@ -42,120 +52,165 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
4252
- You can opt-out of this change by specifying `--no-prettier`.
4353

4454
## [3.4.4]
55+
4556
### Added
57+
4658
- Retain tag history on update command for renamed packages with new options ([#182](https://github.com/MetaMask/auto-changelog/pull/182))
4759

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

5062
## [3.4.3]
63+
5164
### Changed
65+
5266
- Place this library under the MIT / Apache 2.0 dual license ([#175](https://github.com/MetaMask/auto-changelog/pull/175))
5367

5468
## [3.4.2]
69+
5570
### Fixed
71+
5672
- Remove circular dependency on `@metamask/utils` ([#170](https://github.com/MetaMask/auto-changelog/pull/170))
5773

5874
## [3.4.1]
75+
5976
### Fixed
77+
6078
- Add missing dependency `@metamask/utils` ([#168](https://github.com/MetaMask/auto-changelog/pull/168))
6179

6280
## [3.4.0]
81+
6382
### Added
83+
6484
- Retain tag history for renamed packages with new validation options ([#157](https://github.com/MetaMask/auto-changelog/pull/157))
6585

6686
- Introduced --version-before-package-rename and --tag-prefix-before-package-rename options for validate command.
6787

6888
## [3.3.0]
89+
6990
### Added
91+
7092
- Add `--prettier` option for Prettier-formatted changelogs ([#155](https://github.com/MetaMask/auto-changelog/pull/155))
7193

7294
## [3.2.0]
95+
7396
### Added
97+
7498
- Add `--fix` option to validate command ([#148](https://github.com/MetaMask/auto-changelog/pull/148))
7599

76100
## [3.1.0]
101+
77102
### Added
103+
78104
- Allow prerelease versions in release headers ([#130](https://github.com/MetaMask/auto-changelog/pull/130))
79105

80106
## [3.0.0]
107+
81108
### Added
109+
82110
- Support alternate tag prefixes ([#120](https://github.com/MetaMask/auto-changelog/pull/120))
83111

84112
### Changed
113+
85114
- **BREAKING:** Update minimum Node.js version to v14 ([#117](https://github.com/MetaMask/auto-changelog/pull/117))
86115
- Get package version from manifest ([#121](https://github.com/MetaMask/auto-changelog/pull/121))
87116

88117
## [2.6.1]
118+
89119
### Fixed
120+
90121
- When fetching remote tags, order by date to account for miniscule time differences between tags created within automated tests ([#113](https://github.com/MetaMask/auto-changelog/pull/113))
91122

92123
## [2.6.0]
124+
93125
### Changed
126+
94127
- Read repository URL from package.json if `npm_package_repository_url` is not set ([#111](https://github.com/MetaMask/auto-changelog/pull/111))
95128
- This makes this package compatible with Yarn >1.
96129

97130
## [2.5.0]
131+
98132
### Added
133+
99134
- The `validate --rc` command now ensures there are no uncategorized changes in the current release entry ([#102](https://github.com/MetaMask/auto-changelog/pull/102), [#106](https://github.com/MetaMask/auto-changelog/pull/106))
100135

101136
## [2.4.0]
137+
102138
### Changed
139+
103140
- Permit missing separating space in "Unreleased" link reference definition ([#92](https://github.com/MetaMask/auto-changelog/pull/92))
104141
- Use `execa` to execute git commands ([#94](https://github.com/MetaMask/auto-changelog/pull/94))
105142
- This may fix subtle bugs related to git command execution, especially in CI.
106143

107144
## [2.3.0]
145+
108146
### Added
147+
109148
- More exports to index.ts ([#86](https://github.com/MetaMask/auto-changelog/pull/86))
110149
- Specifically, the `Changelog` class, `createEmptyChangelog`, and `parseChangelog`.
111150

112151
### Fixed
152+
113153
- 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))
114154
- 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.
115155

116156
## [2.2.0]
157+
117158
### Added
159+
118160
- Add `init` command ([#77](https://github.com/MetaMask/auto-changelog/pull/77))
119161

120162
### Changed
163+
121164
- Add `@lavamoat/allow-scripts` and `setup` command ([#78](https://github.com/MetaMask/auto-changelog/pull/78))
122165
- Detect all PRs referenced in each change description, rather than just the first ([#84](https://github.com/MetaMask/auto-changelog/pull/84))
123166

124167
### Fixed
168+
125169
- Fix broken validation and updating when the lowest SemVer release isn't the first chronological release ([#76](https://github.com/MetaMask/auto-changelog/pull/76))
126170
- Fix PR number detection in existing change entries ([#83](https://github.com/MetaMask/auto-changelog/pull/83))
127171

128172
## [2.1.0]
173+
129174
### Added
175+
130176
- Add Changelog.getStringifiedRelease ([#73](https://github.com/MetaMask/auto-changelog/pull/73))
131177

132178
### Fixed
179+
133180
- Remove trailing '.git' from default repo URL ([#74](https://github.com/MetaMask/auto-changelog/pull/74))
134181

135182
## [2.0.1]
183+
136184
### Fixed
185+
137186
- Prevent old build files from being published ([#71](https://github.com/MetaMask/auto-changelog/pull/71))
138187

139188
## [2.0.0]
189+
140190
### Added
191+
141192
- TypeScript types ([#59](https://github.com/MetaMask/auto-changelog/pull/59))
142193

143194
### Changed
195+
144196
- **(BREAKING)** Move Pull Request links to end of change entries ([#66](https://github.com/MetaMask/auto-changelog/pull/66))
145197
- Rename files to use snake-case ([#64](https://github.com/MetaMask/auto-changelog/pull/64))
146198
- Validate change categories during parsing ([#62](https://github.com/MetaMask/auto-changelog/pull/62))
147199
- This causes a validation error to be thrown earlier than previously.
148200
- Migrate to TypeScript ([#59](https://github.com/MetaMask/auto-changelog/pull/59))
149201

150202
### Fixed
203+
151204
- Release candidate tag validation ([#55](https://github.com/MetaMask/auto-changelog/pull/55))
152205
- The fixed check ensures that there are no existing tags for release candidates.
153206
- Typo in CLI error message ([#65](https://github.com/MetaMask/auto-changelog/pull/65))
154207

155208
## [1.0.0]
209+
156210
### Added
157-
- 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)).
158-
Includes the following features:
211+
212+
- 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)).
213+
Includes the following features:
159214
- An `update` command ([#26](https://github.com/MetaMask/auto-changelog/pull/26))
160215
- A `validate` command ([#28](https://github.com/MetaMask/auto-changelog/pull/28))
161216
- Monorepo support ([#41](https://github.com/MetaMask/auto-changelog/pull/41))

0 commit comments

Comments
 (0)