Skip to content

Commit bacbbb5

Browse files
author
Benjamin E. Coe
authored
feat(changelog.json): include referenced issues/prs (#1830)
1 parent 9324af7 commit bacbbb5

4 files changed

Lines changed: 18 additions & 4 deletions

File tree

__snapshots__/changelog-json.js

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,20 @@ exports['changelog.json prepends latest release to existing changelog 1'] = `
77
{
88
"type": "feat",
99
"sha": "81228f3507ad6f742242474628ff58b2",
10-
"message": "some feature"
10+
"message": "some feature",
11+
"issues": []
1112
},
1213
{
1314
"type": "fix",
1415
"sha": "26fff5655027c8e7b799cb450acca568",
15-
"message": "some bugfix"
16+
"message": "some bugfix",
17+
"issues": []
1618
},
1719
{
1820
"type": "docs",
1921
"sha": "abbf5480ac552b33404be825a817df2a",
20-
"message": "some documentation"
22+
"message": "some documentation",
23+
"issues": []
2124
}
2225
],
2326
"version": "14.0.0",
@@ -42,18 +45,21 @@ exports['changelog.json prepends new release to empty changelog 1'] = `
4245
{
4346
"type": "feat",
4447
"sha": "81228f3507ad6f742242474628ff58b2",
45-
"message": "some feature"
48+
"message": "some feature",
49+
"issues": []
4650
},
4751
{
4852
"type": "fix",
4953
"sha": "05670cf2e850beffe53bb2691f8701c7",
5054
"message": "some bugfix",
55+
"issues": [],
5156
"breakingChangeNote": "some bugfix"
5257
},
5358
{
5459
"type": "docs",
5560
"sha": "e0a7c3eb307bdca5f9d4c991c82338da",
5661
"message": "some documentation",
62+
"issues": [],
5763
"scope": "perf",
5864
"breakingChangeNote": "some documentation"
5965
}

__snapshots__/java-yoshi-mono-repo.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,14 @@ exports['JavaYoshiMonoRepo buildUpdates omits non-breaking chores from changelog
1111
"type": "fix",
1212
"sha": "845db1381b3d5d20151cad2588f85feb",
1313
"message": "update dependency com.google.cloud:google-cloud-storage to v1.120.0",
14+
"issues": [],
1415
"scope": "deps"
1516
},
1617
{
1718
"type": "chore",
1819
"sha": "b3f8966b023b8f21ce127142aa91841c",
1920
"message": "update a very important dep",
21+
"issues": [],
2022
"breakingChangeNote": "update a very important dep"
2123
}
2224
],
@@ -40,6 +42,7 @@ exports['JavaYoshiMonoRepo buildUpdates updates changelog.json 1'] = `
4042
"type": "fix",
4143
"sha": "845db1381b3d5d20151cad2588f85feb",
4244
"message": "update dependency com.google.cloud:google-cloud-storage to v1.120.0",
45+
"issues": [],
4346
"scope": "deps"
4447
}
4548
],

__snapshots__/node.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,21 @@ exports['Node buildReleasePullRequest updates changelog.json if present 1'] = `
77
"type": "fix",
88
"sha": "845db1381b3d5d20151cad2588f85feb",
99
"message": "update dependency com.google.cloud:google-cloud-storage to v1.120.0",
10+
"issues": [],
1011
"scope": "deps"
1112
},
1213
{
1314
"type": "chore",
1415
"sha": "b3f8966b023b8f21ce127142aa91841c",
1516
"message": "update a very important dep",
17+
"issues": [],
1618
"breakingChangeNote": "update a very important dep"
1719
},
1820
{
1921
"type": "fix",
2022
"sha": "08ca01180a91c0a1ba8992b491db9212",
2123
"message": "update dependency com.google.cloud:google-cloud-spanner to v1.50.0",
24+
"issues": [],
2225
"scope": "deps"
2326
}
2427
],

src/updaters/changelog-json.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ interface Change {
3030
type: string;
3131
scope?: string;
3232
sha: string;
33+
issues: string[];
3334
message: string;
3435
breakingChangeNote?: string;
3536
}
@@ -70,6 +71,7 @@ export class ChangelogJson extends DefaultUpdater {
7071
type: commit.type,
7172
sha: commit.sha,
7273
message: message,
74+
issues: commit.references.map(ref => ref.issue),
7375
};
7476
if (commit.scope) change.scope = commit.scope;
7577
for (const note of commit.notes) {

0 commit comments

Comments
 (0)