Skip to content

Commit d58ea5e

Browse files
author
LAN Xingcan
committed
Add a new bump strategy for peers bump, resolve changesets#1011, changesets#960, changesets#822
1 parent 1ea308a commit d58ea5e

7 files changed

Lines changed: 167 additions & 17 deletions

File tree

‎.changeset/short-geese-taste.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
"@changesets/assemble-release-plan": minor
3+
"@changesets/config": minor
4+
"@changesets/types": minor
5+
---
6+
7+
Add a new bump strategy for peers bump.
8+
9+
This adds a new option "updatePeersDependencies" to the config, and can be set
10+
to "major" (default) or "follow". When set to "major", it preserves the
11+
origin behaviour that when peers dependencies has a minor or major bump,
12+
the dependent need to perform a major bump; when set to "follow", when peers
13+
have a major/minor/patch bump, the dependent will need to perform **at least**
14+
a major/minor/patch bump, respectively.

‎packages/assemble-release-plan/src/determine-dependents.ts‎

Lines changed: 43 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -68,19 +68,55 @@ export default function determineDependents({
6868
if (nextRelease.type === "none") {
6969
continue;
7070
} else if (
71-
shouldBumpMajor({
72-
dependent,
71+
shouldBumpsForPeerDeps({
7372
depType,
7473
versionRange,
75-
releases,
7674
nextRelease,
7775
preInfo,
7876
onlyUpdatePeerDependentsWhenOutOfRange:
7977
config.___experimentalUnsafeOptions_WILL_CHANGE_IN_PATCH
8078
.onlyUpdatePeerDependentsWhenOutOfRange,
8179
})
8280
) {
83-
type = "major";
81+
if (config.updatePeerDependencies === "major") {
82+
if (nextRelease.type === "patch") {
83+
if (
84+
!semver.satisfies(
85+
incrementVersion(nextRelease, preInfo),
86+
versionRange
87+
)
88+
) {
89+
type = "patch";
90+
}
91+
}
92+
// bump major only if the dependent doesn't already have a major release.
93+
else if (
94+
!releases.has(dependent) ||
95+
(releases.has(dependent) &&
96+
releases.get(dependent)!.type !== "major")
97+
)
98+
type = "major";
99+
} else {
100+
if (!releases.has(dependent)) {
101+
type = nextRelease.type;
102+
} else {
103+
switch (releases.get(dependent)!.type) {
104+
case "none":
105+
type = nextRelease.type;
106+
break;
107+
case "patch":
108+
if (nextRelease.type !== "patch") {
109+
type = nextRelease.type;
110+
}
111+
break;
112+
case "minor":
113+
if (nextRelease.type === "major") {
114+
type = nextRelease.type;
115+
}
116+
break;
117+
}
118+
}
119+
}
84120
} else if (
85121
(!releases.has(dependent) ||
86122
releases.get(dependent)!.type === "none") &&
@@ -206,19 +242,15 @@ function getDependencyVersionRanges(
206242
return dependencyVersionRanges;
207243
}
208244

209-
function shouldBumpMajor({
210-
dependent,
245+
function shouldBumpsForPeerDeps({
211246
depType,
212247
versionRange,
213-
releases,
214248
nextRelease,
215249
preInfo,
216250
onlyUpdatePeerDependentsWhenOutOfRange,
217251
}: {
218-
dependent: string;
219252
depType: DependencyType;
220253
versionRange: string;
221-
releases: Map<string, InternalRelease>;
222254
nextRelease: InternalRelease;
223255
preInfo: PreInfo | undefined;
224256
onlyUpdatePeerDependentsWhenOutOfRange: boolean;
@@ -227,16 +259,10 @@ function shouldBumpMajor({
227259
return (
228260
depType === "peerDependencies" &&
229261
nextRelease.type !== "none" &&
230-
nextRelease.type !== "patch" &&
262+
231263
// 1. If onlyUpdatePeerDependentsWhenOutOfRange set to true, bump major if the version is leaving the range.
232264
// 2. If onlyUpdatePeerDependentsWhenOutOfRange set to false, bump major regardless whether or not the version is leaving the range.
233265
(!onlyUpdatePeerDependentsWhenOutOfRange ||
234-
!semver.satisfies(
235-
incrementVersion(nextRelease, preInfo),
236-
versionRange
237-
)) &&
238-
// bump major only if the dependent doesn't already has a major release.
239-
(!releases.has(dependent) ||
240-
(releases.has(dependent) && releases.get(dependent)!.type !== "major"))
266+
!semver.satisfies(incrementVersion(nextRelease, preInfo), versionRange))
241267
);
242268
}

‎packages/assemble-release-plan/src/index.test.ts‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1401,6 +1401,70 @@ describe("bumping peerDeps", () => {
14011401
expect(releases[1].name).toEqual("pkg-b");
14021402
expect(releases[1].newVersion).toEqual("2.0.0");
14031403
});
1404+
1405+
it("should major bump dependent when bumping caret peerDep by major when updatePeerDependencies = follow", () => {
1406+
setup.updatePeerDependency("pkg-b", "pkg-a", "^1.0.0");
1407+
setup.addChangeset({
1408+
id: "anyway-the-windblows",
1409+
releases: [{ name: "pkg-a", type: "major" }],
1410+
});
1411+
1412+
let { releases } = assembleReleasePlan(
1413+
setup.changesets,
1414+
setup.packages,
1415+
{ ...defaultConfig, updatePeerDependencies: "follow" },
1416+
undefined
1417+
);
1418+
1419+
expect(releases.length).toBe(2);
1420+
expect(releases[0].name).toEqual("pkg-a");
1421+
expect(releases[0].newVersion).toEqual("2.0.0");
1422+
expect(releases[1].name).toEqual("pkg-b");
1423+
expect(releases[1].newVersion).toEqual("2.0.0");
1424+
});
1425+
1426+
it("should minor bump dependent when bumping caret peerDep by minor when updatePeerDependencies = follow", () => {
1427+
setup.updatePeerDependency("pkg-b", "pkg-a", "^1.0.0");
1428+
setup.addChangeset({
1429+
id: "anyway-the-windblows",
1430+
releases: [{ name: "pkg-a", type: "minor" }],
1431+
});
1432+
1433+
let { releases } = assembleReleasePlan(
1434+
setup.changesets,
1435+
setup.packages,
1436+
{ ...defaultConfig, updatePeerDependencies: "follow" },
1437+
undefined
1438+
);
1439+
1440+
expect(releases.length).toBe(2);
1441+
expect(releases[0].name).toEqual("pkg-a");
1442+
expect(releases[0].newVersion).toEqual("1.1.0");
1443+
expect(releases[1].name).toEqual("pkg-b");
1444+
expect(releases[1].newVersion).toEqual("1.1.0");
1445+
});
1446+
1447+
it("should patch bump dependent when bumping caret peerDep by patch when updatePeerDependencies = follow", () => {
1448+
setup.updatePeerDependency("pkg-b", "pkg-a", "^1.0.0");
1449+
setup.addChangeset({
1450+
id: "anyway-the-windblows",
1451+
releases: [{ name: "pkg-a", type: "patch" }],
1452+
});
1453+
1454+
let { releases } = assembleReleasePlan(
1455+
setup.changesets,
1456+
setup.packages,
1457+
{ ...defaultConfig, updatePeerDependencies: "follow" },
1458+
undefined
1459+
);
1460+
1461+
expect(releases.length).toBe(2);
1462+
expect(releases[0].name).toEqual("pkg-a");
1463+
expect(releases[0].newVersion).toEqual("1.0.1");
1464+
expect(releases[1].name).toEqual("pkg-b");
1465+
expect(releases[1].newVersion).toEqual("1.0.1");
1466+
});
1467+
14041468
it("should patch bump transitive dep that is only affected by peerDep bump", () => {
14051469
setup.updatePeerDependency("pkg-b", "pkg-a", "^1.0.0");
14061470
setup.addPackage("pkg-c", "1.0.0");

‎packages/config/schema.json‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,11 @@
122122
"description": "The minimum bump type to trigger automatic update of internal dependencies that are part of the same release.",
123123
"default": "patch"
124124
},
125+
"updatePeerDependencies": {
126+
"enum": ["major", "follow"],
127+
"type": "string",
128+
"description": "The strategy used to trigger automatic update of peer dependencies that are part of the same release, \"follow\" means if peer dependencies has a major/minor/patch bumps, this package will have a major/minor/patch bump too, respectively"
129+
},
125130
"bumpVersionsWithWorkspaceProtocolOnly": {
126131
"type": "boolean",
127132
"default": false,

‎packages/config/src/index.test.ts‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ test("read reads the config", async () => {
4747
baseBranch: "master",
4848
changedFilePatterns: ["**"],
4949
updateInternalDependencies: "patch",
50+
updatePeerDependencies: "major",
5051
ignore: [],
5152
bumpVersionsWithWorkspaceProtocolOnly: false,
5253
privatePackages: {
@@ -73,6 +74,7 @@ let defaults: Config = {
7374
baseBranch: "master",
7475
changedFilePatterns: ["**"],
7576
updateInternalDependencies: "patch",
77+
updatePeerDependencies: "major",
7678
ignore: [],
7779
privatePackages: { version: true, tag: false },
7880
___experimentalUnsafeOptions_WILL_CHANGE_IN_PATCH: {
@@ -276,6 +278,24 @@ let correctCases: Record<string, CorrectCase> = {
276278
updateInternalDependencies: "patch",
277279
},
278280
},
281+
"update peer dependencies major": {
282+
input: {
283+
updatePeerDependencies: "major",
284+
},
285+
output: {
286+
...defaults,
287+
updatePeerDependencies: "major",
288+
},
289+
},
290+
"update peer dependencies follow": {
291+
input: {
292+
updatePeerDependencies: "follow",
293+
},
294+
output: {
295+
...defaults,
296+
updatePeerDependencies: "follow",
297+
},
298+
},
279299
ignore: {
280300
input: {
281301
ignore: ["pkg-a", "pkg-b"],

‎packages/config/src/index.ts‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ export let defaultWrittenConfig = {
2323
access: "restricted",
2424
baseBranch: "master",
2525
updateInternalDependencies: "patch",
26+
updatePeerDepeendencies: "major",
2627
ignore: [] as ReadonlyArray<string>,
2728
} as const;
2829

@@ -293,6 +294,20 @@ export let parse = (json: WrittenConfig, packages: Packages): Config => {
293294
)} but can only be 'patch' or 'minor'`
294295
);
295296
}
297+
298+
if (
299+
json.updatePeerDependencies !== undefined &&
300+
!["major", "follow"].includes(json.updatePeerDependencies)
301+
) {
302+
messages.push(
303+
`The \`updatePeerDependences\` option is set as ${JSON.stringify(
304+
json.updatePeerDependencies,
305+
null,
306+
2
307+
)} but can only be 'major' or 'follow'`
308+
);
309+
}
310+
296311
if (json.ignore) {
297312
if (
298313
!(
@@ -445,6 +460,10 @@ export let parse = (json: WrittenConfig, packages: Packages): Config => {
445460
? defaultWrittenConfig.updateInternalDependencies
446461
: json.updateInternalDependencies,
447462

463+
updatePeerDependencies:
464+
json.updatePeerDependencies === undefined
465+
? defaultWrittenConfig.updatePeerDepeendencies
466+
: json.updatePeerDependencies,
448467
ignore:
449468
json.ignore === undefined
450469
? defaultWrittenConfig.ignore

‎packages/types/src/index.ts‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,7 @@ export type Config = {
7878
privatePackages: PrivatePackages;
7979
/** The minimum bump type to trigger automatic update of internal dependencies that are part of the same release */
8080
updateInternalDependencies: "patch" | "minor";
81+
updatePeerDependencies: "major" | "follow";
8182
ignore: ReadonlyArray<string>;
8283
/** This is supposed to be used with pnpm's `link-workspace-packages: false` and Berry's `enableTransparentWorkspaces: false` */
8384
bumpVersionsWithWorkspaceProtocolOnly?: boolean;
@@ -108,6 +109,7 @@ export type WrittenConfig = {
108109
};
109110
/** The minimum bump type to trigger automatic update of internal dependencies that are part of the same release */
110111
updateInternalDependencies?: "patch" | "minor";
112+
updatePeerDependencies?: "major" | "follow";
111113
ignore?: ReadonlyArray<string>;
112114
bumpVersionsWithWorkspaceProtocolOnly?: boolean;
113115
snapshot?: {

0 commit comments

Comments
 (0)