Skip to content

Commit 67ed551

Browse files
rishav-karanjitrishav-karanjit
authored
chore: separate changelog for Java and .NET (#2242)
1 parent 909b34a commit 67ed551

3 files changed

Lines changed: 184 additions & 49 deletions

File tree

.releaserc.cjs renamed to .releaserc-java.cjs

Lines changed: 88 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -56,14 +56,20 @@ const Runtimes = {
5656
module.exports = {
5757
branches: ["main"],
5858
repositoryUrl: "git@github.com:aws/aws-database-encryption-sdk-dynamodb.git",
59+
tagFormat: "v${version}-java",
5960
plugins: [
6061
// Check the commits since the last release
6162
[
6263
"@semantic-release/commit-analyzer",
6364
{
6465
preset: "conventionalcommits",
6566
parserOpts: {
66-
noteKeywords: ["BREAKING-CHANGE", "BREAKING-CHANGES"],
67+
noteKeywords: [
68+
"JAVA-BREAKING-CHANGE",
69+
"JAVA-BREAKING-CHANGES",
70+
"JAVA BREAKING CHANGE",
71+
"JAVA BREAKING CHANGES",
72+
],
6773
},
6874
presetConfig: {
6975
types: [
@@ -79,9 +85,14 @@ module.exports = {
7985
],
8086
},
8187
releaseRules: [
82-
{ type: "docs", release: "patch" },
83-
{ type: "revert", release: "patch" },
84-
{ type: "chore", release: "patch" },
88+
// go is in main but not in prod. Mentioning go as we do make PR scoping Go in this repo
89+
// python is not in main and not in prod. Mentioning python for defensive coding.
90+
{ scope: "python", release: false },
91+
{ scope: "dotnet", release: false },
92+
{ scope: ".net", release: false },
93+
{ scope: "net", release: false },
94+
{ scope: "go", release: false },
95+
{ scope: "rust", release: false },
8596
],
8697
},
8798
],
@@ -91,7 +102,12 @@ module.exports = {
91102
{
92103
preset: "conventionalcommits",
93104
parserOpts: {
94-
noteKeywords: ["BREAKING-CHANGE", "BREAKING-CHANGES"],
105+
noteKeywords: [
106+
"JAVA-BREAKING-CHANGE",
107+
"JAVA-BREAKING-CHANGES",
108+
"JAVA BREAKING CHANGE",
109+
"JAVA BREAKING CHANGES",
110+
],
95111
},
96112
presetConfig: {
97113
types: [
@@ -107,13 +123,12 @@ module.exports = {
107123
section: "Features -- Java",
108124
hidden: false,
109125
},
110-
{
111-
type: "feat",
112-
scope: "rust",
113-
section: "Features -- Rust",
114-
hidden: false,
115-
},
116-
126+
{ type: "feat", scope: ".net", hidden: true },
127+
{ type: "feat", scope: "net", hidden: true },
128+
{ type: "feat", scope: "dotnet", hidden: true },
129+
{ type: "feat", scope: "python", hidden: true },
130+
{ type: "feat", scope: "go", hidden: true },
131+
{ type: "feat", scope: "rust", hidden: true },
117132
{
118133
type: "fix",
119134
scope: "dafny",
@@ -126,13 +141,12 @@ module.exports = {
126141
section: "Fixes -- Java",
127142
hidden: false,
128143
},
129-
{
130-
type: "fix",
131-
scope: "rust",
132-
section: "Fixes -- Rust",
133-
hidden: false,
134-
},
135-
144+
{ type: "fix", scope: ".net", hidden: true },
145+
{ type: "fix", scope: "net", hidden: true },
146+
{ type: "fix", scope: "dotnet", hidden: true },
147+
{ type: "fix", scope: "python", hidden: true },
148+
{ type: "fix", scope: "go", hidden: true },
149+
{ type: "fix", scope: "rust", hidden: true },
136150
{
137151
type: "chore",
138152
scope: "dafny",
@@ -145,12 +159,12 @@ module.exports = {
145159
section: "Maintenance -- Java",
146160
hidden: false,
147161
},
148-
{
149-
type: "chore",
150-
scope: "rust",
151-
section: "Maintenance -- Rust",
152-
hidden: false,
153-
},
162+
{ type: "chore", scope: ".net", hidden: true },
163+
{ type: "chore", scope: "net", hidden: true },
164+
{ type: "chore", scope: "dotnet", hidden: true },
165+
{ type: "chore", scope: "python", hidden: true },
166+
{ type: "chore", scope: "go", hidden: true },
167+
{ type: "chore", scope: "rust", hidden: true },
154168
{
155169
type: "chore",
156170
section: "Miscellaneous",
@@ -168,12 +182,11 @@ module.exports = {
168182
section: "Maintenance -- Java",
169183
hidden: false,
170184
},
171-
{
172-
type: "docs",
173-
scope: "rust",
174-
section: "Maintenance -- Rust",
175-
hidden: false,
176-
},
185+
{ type: "docs", scope: ".net", hidden: true },
186+
{ type: "docs", scope: "dotnet", hidden: true },
187+
{ type: "docs", scope: "python", hidden: true },
188+
{ type: "docs", scope: "go", hidden: true },
189+
{ type: "docs", scope: "rust", hidden: true },
177190
{
178191
type: "revert",
179192
scope: "dafny",
@@ -186,10 +199,50 @@ module.exports = {
186199
section: "Fixes -- Java",
187200
hidden: false,
188201
},
202+
{ type: "revert", scope: ".net", hidden: true },
203+
{ type: "revert", scope: "dotnet", hidden: true },
204+
{ type: "revert", scope: "python", hidden: true },
205+
{ type: "revert", scope: "go", hidden: true },
206+
{ type: "revert", scope: "rust", hidden: true },
207+
{
208+
type: "feat",
209+
section: "Features -- All Languages",
210+
hidden: false,
211+
},
212+
{ type: "fix", section: "Fixes -- All Languages", hidden: false },
213+
{
214+
type: "chore",
215+
section: "Maintenance -- All Languages",
216+
hidden: false,
217+
},
218+
{
219+
type: "docs",
220+
section: "Maintenance -- All Languages",
221+
hidden: false,
222+
},
189223
{
190224
type: "revert",
191-
scope: "rust",
192-
section: "Fixes -- Rust",
225+
section: "Fixes -- All Languages",
226+
hidden: false,
227+
},
228+
{
229+
type: "style",
230+
section: "Miscellaneous -- All Languages",
231+
hidden: false,
232+
},
233+
{
234+
type: "refactor",
235+
section: "Miscellaneous -- All Languages",
236+
hidden: false,
237+
},
238+
{
239+
type: "perf",
240+
section: "Miscellaneous -- All Languages",
241+
hidden: false,
242+
},
243+
{
244+
type: "test",
245+
section: "Miscellaneous -- All Languages",
193246
hidden: false,
194247
},
195248
{ type: "style", section: "Miscellaneous", hidden: false },
@@ -204,7 +257,7 @@ module.exports = {
204257
[
205258
"@semantic-release/changelog",
206259
{
207-
changelogFile: "CHANGELOG.md",
260+
changelogFile: "CHANGELOG-java.md",
208261
changelogTitle: "# Changelog",
209262
},
210263
],
@@ -231,7 +284,7 @@ module.exports = {
231284
"@semantic-release/git",
232285
{
233286
assets: [
234-
"CHANGELOG.md",
287+
"CHANGELOG-java.md",
235288
...Object.values(Runtimes).flatMap((r) => Object.keys(r)),
236289
],
237290
message:

‎.releaserc-net.cjs‎

Lines changed: 89 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,16 @@ module.exports = {
6565
{
6666
preset: "conventionalcommits",
6767
parserOpts: {
68-
noteKeywords: ["DOTNET-BREAKING-CHANGE", "DOTNET-BREAKING-CHANGES"],
68+
noteKeywords: [
69+
"DOTNET-BREAKING-CHANGE",
70+
"DOTNET-BREAKING-CHANGES",
71+
"DOTNET BREAKING CHANGE",
72+
"DOTNET BREAKING CHANGES",
73+
"NET-BREAKING-CHANGE",
74+
"NET-BREAKING-CHANGES",
75+
"NET BREAKING CHANGE",
76+
"NET BREAKING CHANGES",
77+
],
6978
},
7079
presetConfig: {
7180
types: [
@@ -81,9 +90,12 @@ module.exports = {
8190
],
8291
},
8392
releaseRules: [
84-
{ type: "docs", release: "patch" },
85-
{ type: "revert", release: "patch" },
86-
{ type: "chore", release: "patch" },
93+
// go is in main but not in prod. Mentioning go as we do make PR scoping Go in this repo
94+
// python is not in main and not in prod. Mentioning python for defensive coding.
95+
{ scope: "python", release: false },
96+
{ scope: "java", release: false },
97+
{ scope: "go", release: false },
98+
{ scope: "rust", release: false },
8799
],
88100
},
89101
],
@@ -93,7 +105,16 @@ module.exports = {
93105
{
94106
preset: "conventionalcommits",
95107
parserOpts: {
96-
noteKeywords: ["DOTNET-BREAKING-CHANGE", "DOTNET-BREAKING-CHANGES"],
108+
noteKeywords: [
109+
"DOTNET-BREAKING-CHANGE",
110+
"DOTNET-BREAKING-CHANGES",
111+
"DOTNET BREAKING CHANGE",
112+
"DOTNET BREAKING CHANGES",
113+
"NET-BREAKING-CHANGE",
114+
"NET-BREAKING-CHANGES",
115+
"NET BREAKING CHANGE",
116+
"NET BREAKING CHANGES",
117+
],
97118
},
98119
presetConfig: {
99120
types: [
@@ -109,6 +130,10 @@ module.exports = {
109130
section: "Features -- DotNet",
110131
hidden: false,
111132
},
133+
{ type: "feat", scope: "java", hidden: true },
134+
{ type: "feat", scope: "python", hidden: true },
135+
{ type: "feat", scope: "go", hidden: true },
136+
{ type: "feat", scope: "rust", hidden: true },
112137
{
113138
type: "fix",
114139
scope: "dafny",
@@ -121,6 +146,10 @@ module.exports = {
121146
section: "Fixes -- DotNet",
122147
hidden: false,
123148
},
149+
{ type: "fix", scope: "java", hidden: true },
150+
{ type: "fix", scope: "python", hidden: true },
151+
{ type: "fix", scope: "go", hidden: true },
152+
{ type: "fix", scope: "rust", hidden: true },
124153
{
125154
type: "chore",
126155
scope: "dafny",
@@ -133,6 +162,10 @@ module.exports = {
133162
section: "Maintenance -- DotNet",
134163
hidden: false,
135164
},
165+
{ type: "chore", scope: "java", hidden: true },
166+
{ type: "chore", scope: "python", hidden: true },
167+
{ type: "chore", scope: "go", hidden: true },
168+
{ type: "chore", scope: "rust", hidden: true },
136169
{
137170
type: "docs",
138171
scope: "dafny",
@@ -145,6 +178,10 @@ module.exports = {
145178
section: "Maintenance -- DotNet",
146179
hidden: false,
147180
},
181+
{ type: "docs", scope: "java", hidden: true },
182+
{ type: "docs", scope: "python", hidden: true },
183+
{ type: "docs", scope: "go", hidden: true },
184+
{ type: "docs", scope: "rust", hidden: true },
148185
{
149186
type: "revert",
150187
scope: "dafny",
@@ -157,6 +194,51 @@ module.exports = {
157194
section: "Fixes -- DotNet",
158195
hidden: false,
159196
},
197+
{ type: "revert", scope: "java", hidden: true },
198+
{ type: "revert", scope: "python", hidden: true },
199+
{ type: "revert", scope: "go", hidden: true },
200+
{ type: "revert", scope: "rust", hidden: true },
201+
{
202+
type: "feat",
203+
section: "Features -- All Languages",
204+
hidden: false,
205+
},
206+
{ type: "fix", section: "Fixes -- All Languages", hidden: false },
207+
{
208+
type: "chore",
209+
section: "Maintenance -- All Languages",
210+
hidden: false,
211+
},
212+
{
213+
type: "docs",
214+
section: "Maintenance -- All Languages",
215+
hidden: false,
216+
},
217+
{
218+
type: "revert",
219+
section: "Fixes -- All Languages",
220+
hidden: false,
221+
},
222+
{
223+
type: "style",
224+
section: "Miscellaneous -- All Languages",
225+
hidden: false,
226+
},
227+
{
228+
type: "refactor",
229+
section: "Miscellaneous -- All Languages",
230+
hidden: false,
231+
},
232+
{
233+
type: "perf",
234+
section: "Miscellaneous -- All Languages",
235+
hidden: false,
236+
},
237+
{
238+
type: "test",
239+
section: "Miscellaneous -- All Languages",
240+
hidden: false,
241+
},
160242
{ type: "style", section: "Miscellaneous", hidden: false },
161243
{ type: "refactor", section: "Miscellaneous", hidden: false },
162244
{ type: "perf", section: "Miscellaneous", hidden: false },
@@ -169,7 +251,7 @@ module.exports = {
169251
[
170252
"@semantic-release/changelog",
171253
{
172-
changelogFile: "CHANGELOG.md",
254+
changelogFile: "CHANGELOG-net.md",
173255
changelogTitle: "# Changelog",
174256
},
175257
],
@@ -213,7 +295,7 @@ module.exports = {
213295
"@semantic-release/git",
214296
{
215297
assets: [
216-
"CHANGELOG.md",
298+
"CHANGELOG-net.md",
217299
...Object.values(Runtimes).flatMap((r) => Object.keys(r)),
218300
...Object.values(Runtimes.net).flatMap((r) => r.assemblyInfo),
219301
],

‎Makefile‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -79,22 +79,22 @@ generate_properties_file:
7979
setup_semantic_release:
8080
npm i --no-save semantic-release @semantic-release/changelog semantic-release-replace-plugin conventional-changelog-conventionalcommits @semantic-release/git
8181

82-
run_semantic_release:
82+
run_java_semantic_release:
83+
mv .releaserc-java.cjs .releaserc.cjs
8384
npx semantic-release --no-ci
85+
mv .releaserc.cjs .releaserc-java.cjs
8486

8587
run_net_semantic_release:
86-
mv .releaserc.cjs .releaserc-main.cjs
8788
mv .releaserc-net.cjs .releaserc.cjs
8889
npx semantic-release --no-ci
8990
mv .releaserc.cjs .releaserc-net.cjs
90-
mv .releaserc-main.cjs .releaserc.cjs
9191

92-
dry_run_semantic_release:
92+
dry_run_java_semantic_release:
93+
mv .releaserc-java.cjs .releaserc.cjs
9394
npx semantic-release --dry-run
95+
mv .releaserc.cjs .releaserc-java.cjs
9496

9597
dry_run_net_semantic_release:
96-
mv .releaserc.cjs .releaserc-main.cjs
9798
mv .releaserc-net.cjs .releaserc.cjs
9899
npx semantic-release --dry-run
99-
mv .releaserc.cjs .releaserc-net.cjs
100-
mv .releaserc-main.cjs .releaserc.cjs
100+
mv .releaserc.cjs .releaserc-net.cjs

0 commit comments

Comments
 (0)