/
conventional-commits.spec.ts
491 lines (344 loc) · 17.7 KB
/
conventional-commits.spec.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
import { Fixture } from "../../utils/fixture";
import { normalizeCommitSHAs, normalizeEnvironment } from "../../utils/snapshot-serializer-utils";
expect.addSnapshotSerializer({
serialize(str: string) {
return normalizeCommitSHAs(
normalizeEnvironment(str.replaceAll(/\(\d\d\d\d-\d\d-\d\d\)/g, "({YYYY}-{MM}-{DD})"))
);
},
test(val: string) {
return val != null && typeof val === "string";
},
});
describe("lerna-version-conventional-commits", () => {
describe("single package", () => {
let fixture: Fixture;
beforeEach(async () => {
fixture = await Fixture.create({
name: "lerna-version-conventional-commits-single-package",
packageManager: "npm",
initializeGit: true,
runLernaInit: true,
installDependencies: true,
});
});
afterEach(() => fixture.destroy());
it("should correctly generate changelog and version information after a `feat` commit", async () => {
await fixture.createInitialGitCommit();
await fixture.lerna("create package-a -y");
await fixture.exec("git add --all");
await fixture.exec("git commit -m 'feat: add package-a'");
await fixture.exec("git push origin test-main");
const output = await fixture.lerna("version --conventional-commits -y", { silenceError: true });
expect(output.combinedOutput).toMatchInlineSnapshot(`
Changes:
- package-a: 0.0.0 => 0.1.0
lerna notice cli v999.9.9-e2e.0
lerna info current version 0.0.0
lerna info Assuming all packages changed
lerna info getChangelogConfig Successfully resolved preset "conventional-changelog-angular"
lerna info auto-confirmed
lerna info execute Skipping releases
lerna info git Pushing tags...
lerna success version finished
`);
const checkTagIsPresentLocally = await fixture.exec("git describe --abbrev=0");
expect(checkTagIsPresentLocally.combinedOutput).toMatchInlineSnapshot(`
v0.1.0
`);
const checkTagIsPresentOnRemote = await fixture.exec("git ls-remote origin refs/tags/v0.1.0");
expect(checkTagIsPresentOnRemote.combinedOutput).toMatchInlineSnapshot(`
{FULL_COMMIT_SHA} refs/tags/v0.1.0
`);
expect(JSON.parse(await fixture.readWorkspaceFile("lerna.json")).version).toMatchInlineSnapshot(
"0.1.0"
);
expect(JSON.parse(await fixture.readWorkspaceFile("packages/package-a/package.json")).version).toEqual(
"0.1.0"
);
expect(await fixture.readWorkspaceFile("CHANGELOG.md")).toMatchInlineSnapshot(`
# Change Log
All notable changes to this project will be documented in this file.
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
# 0.1.0 ({YYYY}-{MM}-{DD})
### Features
* add package-a ([{SHORT_COMMIT_SHA}](tmp/lerna-e2e/lerna-version-conventional-commits-single-package/origin/commits/{FULL_COMMIT_SHA}))
`);
expect(await fixture.readWorkspaceFile("packages/package-a/CHANGELOG.md")).toMatchInlineSnapshot(`
# Change Log
All notable changes to this project will be documented in this file.
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
# 0.1.0 ({YYYY}-{MM}-{DD})
### Features
* add package-a ([{SHORT_COMMIT_SHA}](tmp/lerna-e2e/lerna-version-conventional-commits-single-package/origin/commits/{FULL_COMMIT_SHA}))
`);
});
});
describe("multiple packages", () => {
let fixture: Fixture;
beforeEach(async () => {
fixture = await Fixture.create({
name: "lerna-version-conventional-commits-multiple-packages",
packageManager: "npm",
initializeGit: true,
runLernaInit: true,
installDependencies: true,
});
});
afterEach(() => fixture.destroy());
it("should correctly generate changelog and version information after a `feat` commit", async () => {
await fixture.createInitialGitCommit();
await fixture.lerna("create package-a -y");
await fixture.exec("git add --all");
await fixture.exec("git commit -m 'feat: add package-a'");
await fixture.lerna("create package-b -y");
await fixture.exec("git add --all");
await fixture.exec("git commit -m 'feat: add package-b'");
await fixture.exec("git push origin test-main");
const output = await fixture.lerna("version --conventional-commits -y", { silenceError: true });
expect(output.combinedOutput).toMatchInlineSnapshot(`
Changes:
- package-a: 0.0.0 => 0.1.0
- package-b: 0.0.0 => 0.1.0
lerna notice cli v999.9.9-e2e.0
lerna info current version 0.0.0
lerna info Assuming all packages changed
lerna info getChangelogConfig Successfully resolved preset "conventional-changelog-angular"
lerna info auto-confirmed
lerna info execute Skipping releases
lerna info git Pushing tags...
lerna success version finished
`);
const checkTagIsPresentLocally = await fixture.exec("git describe --abbrev=0");
expect(checkTagIsPresentLocally.combinedOutput).toMatchInlineSnapshot(`
v0.1.0
`);
const checkTagIsPresentOnRemote = await fixture.exec("git ls-remote origin refs/tags/v0.1.0");
expect(checkTagIsPresentOnRemote.combinedOutput).toMatchInlineSnapshot(`
{FULL_COMMIT_SHA} refs/tags/v0.1.0
`);
expect(JSON.parse(await fixture.readWorkspaceFile("lerna.json")).version).toMatchInlineSnapshot(
"0.1.0"
);
expect(JSON.parse(await fixture.readWorkspaceFile("packages/package-a/package.json")).version).toEqual(
"0.1.0"
);
expect(JSON.parse(await fixture.readWorkspaceFile("packages/package-b/package.json")).version).toEqual(
"0.1.0"
);
expect(await fixture.readWorkspaceFile("CHANGELOG.md")).toMatchInlineSnapshot(`
# Change Log
All notable changes to this project will be documented in this file.
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
# 0.1.0 ({YYYY}-{MM}-{DD})
### Features
* add package-a ([{SHORT_COMMIT_SHA}](tmp/lerna-e2e/lerna-version-conventional-commits-multiple-packages/origin/commits/{FULL_COMMIT_SHA}))
* add package-b ([{SHORT_COMMIT_SHA}](tmp/lerna-e2e/lerna-version-conventional-commits-multiple-packages/origin/commits/{FULL_COMMIT_SHA}))
`);
expect(await fixture.readWorkspaceFile("packages/package-a/CHANGELOG.md")).toMatchInlineSnapshot(`
# Change Log
All notable changes to this project will be documented in this file.
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
# 0.1.0 ({YYYY}-{MM}-{DD})
### Features
* add package-a ([{SHORT_COMMIT_SHA}](tmp/lerna-e2e/lerna-version-conventional-commits-multiple-packages/origin/commits/{FULL_COMMIT_SHA}))
`);
expect(await fixture.readWorkspaceFile("packages/package-b/CHANGELOG.md")).toMatchInlineSnapshot(`
# Change Log
All notable changes to this project will be documented in this file.
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
# 0.1.0 ({YYYY}-{MM}-{DD})
### Features
* add package-b ([{SHORT_COMMIT_SHA}](tmp/lerna-e2e/lerna-version-conventional-commits-multiple-packages/origin/commits/{FULL_COMMIT_SHA}))
`);
});
it("should correctly generate and promote prereleases when using --conventional-prerelease and --conventional-graduate", async () => {
await fixture.createInitialGitCommit();
await fixture.lerna("create package-a -y");
await fixture.exec("git add --all");
await fixture.exec("git commit -m 'feat: add package-a'");
await fixture.lerna("create package-b -y");
await fixture.exec("git add --all");
await fixture.exec("git commit -m 'feat: add package-b'");
await fixture.exec("git push origin test-main");
// Initial versioning with two packages created
await fixture.lerna("version --conventional-commits -y", { silenceError: true });
// Update and version just package-a
await fixture.exec("echo update_package_a > packages/package-a/new_file.txt");
await fixture.exec("git add --all");
await fixture.exec("git commit -m 'fix: update package-a'");
// Create a prerelease version
const output = await fixture.lerna("version --conventional-commits --conventional-prerelease -y", {
silenceError: true,
});
expect(output.combinedOutput).toMatchInlineSnapshot(`
Changes:
- package-a: 0.1.0 => 0.1.1-alpha.0
lerna notice cli v999.9.9-e2e.0
lerna info current version 0.1.0
lerna info Looking for changed packages since v0.1.0
lerna info getChangelogConfig Successfully resolved preset "conventional-changelog-angular"
lerna info auto-confirmed
lerna info execute Skipping releases
lerna info git Pushing tags...
lerna success version finished
`);
// Promote the prerelease version
const output2 = await fixture.lerna("version --conventional-commits --conventional-graduate -y", {
silenceError: true,
});
expect(output2.combinedOutput).toMatchInlineSnapshot(`
Changes:
- package-a: 0.1.1-alpha.0 => 0.1.1
lerna notice cli v999.9.9-e2e.0
lerna info current version 0.1.1-alpha.0
lerna WARN conventional-graduate all packages
lerna info Graduating all prereleased packages
lerna info Looking for changed packages since v0.1.1-alpha.0
lerna info getChangelogConfig Successfully resolved preset "conventional-changelog-angular"
lerna info auto-confirmed
lerna info execute Skipping releases
lerna info git Pushing tags...
lerna success version finished
`);
});
describe("independent packages", () => {
it("should correctly generate changelog and version information when releasing packages independently", async () => {
await fixture.createInitialGitCommit();
fixture.updateJson("lerna.json", (json) => {
// eslint-disable-next-line no-param-reassign
json.version = "independent";
return json;
});
await fixture.exec("git add lerna.json");
await fixture.exec("git commit -m 'chore: set version to independent'");
await fixture.exec("git push origin test-main");
await fixture.lerna("create package-a -y");
await fixture.exec("git add --all");
await fixture.exec("git commit -m 'feat: add package-a'");
await fixture.lerna("create package-b -y");
await fixture.exec("git add --all");
await fixture.exec("git commit -m 'feat: add package-b'");
await fixture.exec("git push origin test-main");
// Initial versioning with two packages created
const output1 = await fixture.lerna("version --conventional-commits -y", { silenceError: true });
// NOTE: In the independent case, lerna started with verion 1.0.0 as its assumed baseline (not 0.0.0 as in the fixed mode case)
expect(output1.combinedOutput).toMatchInlineSnapshot(`
Changes:
- package-a: 1.0.0 => 1.1.0
- package-b: 1.0.0 => 1.1.0
lerna notice cli v999.9.9-e2e.0
lerna info versioning independent
lerna info Assuming all packages changed
lerna info getChangelogConfig Successfully resolved preset "conventional-changelog-angular"
lerna info auto-confirmed
lerna info execute Skipping releases
lerna info git Pushing tags...
lerna success version finished
`);
// When releasing independently a root CHANGELOG.md should not be created
await expect(fixture.readWorkspaceFile("CHANGELOG.md")).rejects.toThrowErrorMatchingInlineSnapshot(
`ENOENT: no such file or directory, open '/tmp/lerna-e2e/lerna-version-conventional-commits-multiple-packages/lerna-workspace/CHANGELOG.md'`
);
// It should create one tag for each independently versioned package
const checkPackageTagsArePresentLocally = await fixture.exec("git describe --abbrev=0");
expect(checkPackageTagsArePresentLocally.combinedOutput).toMatchInlineSnapshot(`
package-a@1.1.0
`);
const checkPackageATagIsPresentOnRemote = await fixture.exec(
"git ls-remote origin refs/tags/package-a@1.1.0"
);
expect(checkPackageATagIsPresentOnRemote.combinedOutput).toMatchInlineSnapshot(`
{FULL_COMMIT_SHA} refs/tags/package-a@1.1.0
`);
const checkPackageBTagIsPresentOnRemote = await fixture.exec(
"git ls-remote origin refs/tags/package-b@1.1.0"
);
expect(checkPackageBTagIsPresentOnRemote.combinedOutput).toMatchInlineSnapshot(`
{FULL_COMMIT_SHA} refs/tags/package-b@1.1.0
`);
// The lerna.json version field should not be updated with any particular version when in independent mode
expect(JSON.parse(await fixture.readWorkspaceFile("lerna.json")).version).toMatchInlineSnapshot(
"independent"
);
expect(
JSON.parse(await fixture.readWorkspaceFile("packages/package-a/package.json")).version
).toEqual("1.1.0");
expect(
JSON.parse(await fixture.readWorkspaceFile("packages/package-b/package.json")).version
).toEqual("1.1.0");
expect(await fixture.readWorkspaceFile("packages/package-a/CHANGELOG.md")).toMatchInlineSnapshot(`
# Change Log
All notable changes to this project will be documented in this file.
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
# 1.1.0 ({YYYY}-{MM}-{DD})
### Features
* add package-a ([{SHORT_COMMIT_SHA}](tmp/lerna-e2e/lerna-version-conventional-commits-multiple-packages/origin/commits/{FULL_COMMIT_SHA}))
`);
const cachedPackageBChangelog = await fixture.readWorkspaceFile("packages/package-b/CHANGELOG.md");
expect(cachedPackageBChangelog).toMatchInlineSnapshot(`
# Change Log
All notable changes to this project will be documented in this file.
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
# 1.1.0 ({YYYY}-{MM}-{DD})
### Features
* add package-b ([{SHORT_COMMIT_SHA}](tmp/lerna-e2e/lerna-version-conventional-commits-multiple-packages/origin/commits/{FULL_COMMIT_SHA}))
`);
// Update and version just package-a
await fixture.exec("echo update_package_a > packages/package-a/new_file.txt");
await fixture.exec("git add --all");
await fixture.exec("git commit -m 'fix: update package-a'");
const output2 = await fixture.lerna("version --conventional-commits -y", { silenceError: true });
expect(output2.combinedOutput).toMatchInlineSnapshot(`
Changes:
- package-a: 1.1.0 => 1.1.1
lerna notice cli v999.9.9-e2e.0
lerna info versioning independent
lerna info Looking for changed packages since package-a@1.1.0
lerna info getChangelogConfig Successfully resolved preset "conventional-changelog-angular"
lerna info auto-confirmed
lerna info execute Skipping releases
lerna info git Pushing tags...
lerna success version finished
`);
expect(await fixture.readWorkspaceFile("packages/package-a/CHANGELOG.md")).toMatchInlineSnapshot(`
# Change Log
All notable changes to this project will be documented in this file.
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
## [1.1.1](tmp/lerna-e2e/lerna-version-conventional-commits-multiple-packages/origin/compare/package-a@1.1.0...package-a@1.1.1) ({YYYY}-{MM}-{DD})
### Bug Fixes
* update package-a ([{SHORT_COMMIT_SHA}](tmp/lerna-e2e/lerna-version-conventional-commits-multiple-packages/origin/commits/{FULL_COMMIT_SHA}))
# 1.1.0 ({YYYY}-{MM}-{DD})
### Features
* add package-a ([{SHORT_COMMIT_SHA}](tmp/lerna-e2e/lerna-version-conventional-commits-multiple-packages/origin/commits/{FULL_COMMIT_SHA}))
`);
// package-b CHANGELOG.md should not have been updated
expect(await fixture.readWorkspaceFile("packages/package-b/CHANGELOG.md")).toEqual(
cachedPackageBChangelog
);
// package-a version should have been updated
expect(
JSON.parse(await fixture.readWorkspaceFile("packages/package-a/package.json")).version
).toEqual("1.1.1");
// package-b version should NOT have been updated
expect(
JSON.parse(await fixture.readWorkspaceFile("packages/package-b/package.json")).version
).toEqual("1.1.0");
// Only package-a's tag should have been updated
const checkPackageTagsArePresentLocally2 = await fixture.exec("git describe --abbrev=0");
expect(checkPackageTagsArePresentLocally2.combinedOutput).toMatchInlineSnapshot(`
package-a@1.1.1
`);
// A 1.1.1 tag for package-a should exist on the remote
expect((await fixture.exec("git ls-remote origin refs/tags/package-a@1.1.1")).combinedOutput)
.toMatchInlineSnapshot(`
{FULL_COMMIT_SHA} refs/tags/package-a@1.1.1
`);
// A 1.1.1 tag for package-b should NOT exist on the remote
expect(
(await fixture.exec("git ls-remote origin refs/tags/package-b@1.1.1")).combinedOutput
).toMatchInlineSnapshot(``);
});
});
});
});