Skip to content

Commit 8f22a5e

Browse files
committed
Update changelogs correctly for monorepo packages
Packages within a monorepo should now have their changelogs correctly updated. Previously the update step was incorrectly expecting the monorepo package to be using a tag of the format `v[version]`. This is not how we tag packages within an indepentently versioned monorepo because we need some way to distinguish the tags used for each project. This step has been updated to specify the expected tag prefix as being the package name followed by `@`.
1 parent 2771767 commit 8f22a5e

File tree

5 files changed

+14
-12
lines changed

5 files changed

+14
-12
lines changed

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
},
3737
"devDependencies": {
3838
"@lavamoat/allow-scripts": "^2.0.3",
39-
"@metamask/auto-changelog": "^2.3.0",
39+
"@metamask/auto-changelog": "^3.0.0",
4040
"@metamask/eslint-config": "^10.0.0",
4141
"@metamask/eslint-config-jest": "^10.0.0",
4242
"@metamask/eslint-config-nodejs": "^10.0.0",

src/functional.test.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -304,8 +304,8 @@ describe('create-release-branch (functional)', () => {
304304
- Update "a"
305305
- Initial commit
306306
307-
[Unreleased]: https://github.com/example-org/example-repo/compare/v2.0.0...HEAD
308-
[2.0.0]: https://github.com/example-org/example-repo/releases/tag/v2.0.0
307+
[Unreleased]: https://github.com/example-org/example-repo/compare/@scope/a@2.0.0...HEAD
308+
[2.0.0]: https://github.com/example-org/example-repo/releases/tag/@scope/a@2.0.0
309309
`),
310310
);
311311
expect(
@@ -318,8 +318,8 @@ describe('create-release-branch (functional)', () => {
318318
### Uncategorized
319319
- Initial commit
320320
321-
[Unreleased]: https://github.com/example-org/example-repo/compare/v2.0.0...HEAD
322-
[2.0.0]: https://github.com/example-org/example-repo/releases/tag/v2.0.0
321+
[Unreleased]: https://github.com/example-org/example-repo/compare/@scope/b@2.0.0...HEAD
322+
[2.0.0]: https://github.com/example-org/example-repo/releases/tag/@scope/b@2.0.0
323323
`),
324324
);
325325
},
@@ -652,8 +652,8 @@ The release spec file has been retained for you to edit again and make the neces
652652
- Update "a"
653653
- Initial commit
654654
655-
[Unreleased]: https://github.com/example-org/example-repo/compare/v2.0.0...HEAD
656-
[2.0.0]: https://github.com/example-org/example-repo/releases/tag/v2.0.0
655+
[Unreleased]: https://github.com/example-org/example-repo/compare/@scope/a@2.0.0...HEAD
656+
[2.0.0]: https://github.com/example-org/example-repo/releases/tag/@scope/a@2.0.0
657657
`),
658658
);
659659
expect(

src/package.test.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -474,6 +474,7 @@ describe('package', () => {
474474
isReleaseCandidate: true,
475475
projectRootDirectory: sandbox.directoryPath,
476476
repoUrl: 'https://repo.url',
477+
tagPrefixes: ['package@', 'v'],
477478
})
478479
.mockResolvedValue('new changelog');
479480
await fs.promises.writeFile(changelogPath, 'existing changelog');

src/package.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -271,6 +271,7 @@ async function updatePackageChangelog({
271271
isReleaseCandidate: true,
272272
projectRootDirectory: pkg.directoryPath,
273273
repoUrl: repositoryUrl,
274+
tagPrefixes: [`${pkg.validatedManifest.name}@`, 'v'],
274275
});
275276

276277
if (newChangelogContent) {

yarn.lock

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -873,17 +873,17 @@ __metadata:
873873
languageName: node
874874
linkType: hard
875875

876-
"@metamask/auto-changelog@npm:^2.3.0":
877-
version: 2.6.1
878-
resolution: "@metamask/auto-changelog@npm:2.6.1"
876+
"@metamask/auto-changelog@npm:^3.0.0":
877+
version: 3.0.0
878+
resolution: "@metamask/auto-changelog@npm:3.0.0"
879879
dependencies:
880880
diff: ^5.0.0
881881
execa: ^5.1.1
882882
semver: ^7.3.5
883883
yargs: ^17.0.1
884884
bin:
885885
auto-changelog: dist/cli.js
886-
checksum: 6ae84de492e4aec710ff2dd793f258b7cc3aba3fdeb416c0d3ab55a156da61b4ccd3272e9a6608f32b71695dc42b527a380ce62566e387240665556c8da26de3
886+
checksum: ee6f41b466e8f0deb8bc454936513602c4767b7be94f704da3579e3100154c92779dcfde542076158138d5fcfb64ce491ab7fc30248ae097c7d903be0cad9fb4
887887
languageName: node
888888
linkType: hard
889889

@@ -893,7 +893,7 @@ __metadata:
893893
dependencies:
894894
"@lavamoat/allow-scripts": ^2.0.3
895895
"@metamask/action-utils": ^0.0.2
896-
"@metamask/auto-changelog": ^2.3.0
896+
"@metamask/auto-changelog": ^3.0.0
897897
"@metamask/eslint-config": ^10.0.0
898898
"@metamask/eslint-config-jest": ^10.0.0
899899
"@metamask/eslint-config-nodejs": ^10.0.0

0 commit comments

Comments
 (0)