Skip to content

Commit 2170c6d

Browse files
authored
Docs: [AEA-0000] - use custom release notes template (#143)
## Summary - Routine Change ### Details - use custom release notes template
1 parent ce747f0 commit 2170c6d

File tree

3 files changed

+87
-80
lines changed

3 files changed

+87
-80
lines changed

.releaserc

Lines changed: 0 additions & 80 deletions
This file was deleted.

release.config.js

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
// eslint-disable-next-line @typescript-eslint/no-var-requires
2+
const {readFileSync} = require("fs")
3+
4+
const commitTemplate = readFileSync("./releaseNotesTemplates/commit.hbs").toString()
5+
module.exports = {
6+
tagFormat: "v${version}",
7+
branches: [
8+
{
9+
name: "main"
10+
}
11+
],
12+
plugins: [
13+
[
14+
"@semantic-release/commit-analyzer",
15+
{
16+
preset: "eslint",
17+
releaseRules: [
18+
{
19+
reminder: "Please update CONTRIBUTING.md if you change this",
20+
release: false
21+
},
22+
{
23+
tag: "Fix",
24+
release: "patch"
25+
},
26+
{
27+
tag: "Update",
28+
release: "patch"
29+
},
30+
{
31+
tag: "New",
32+
release: "minor"
33+
},
34+
{
35+
tag: "Breaking",
36+
release: "major"
37+
},
38+
{
39+
tag: "Docs",
40+
release: "patch"
41+
},
42+
{
43+
tag: "Build",
44+
release: false
45+
},
46+
{
47+
tag: "Upgrade",
48+
release: "patch"
49+
},
50+
{
51+
tag: "Chore",
52+
release: "patch"
53+
}
54+
]
55+
}
56+
],
57+
[
58+
"@semantic-release/release-notes-generator",
59+
{
60+
preset: "eslint",
61+
writerOpts: {
62+
commitPartial: commitTemplate
63+
}
64+
}
65+
],
66+
[
67+
"@semantic-release/changelog",
68+
{
69+
changelogFile: "CHANGELOG.md"
70+
}
71+
],
72+
[
73+
"@semantic-release/github",
74+
{
75+
assets: [
76+
{
77+
path: "CHANGELOG.md",
78+
label: "CHANGELOG.md"
79+
}
80+
],
81+
successComment: false,
82+
failComment: false,
83+
failTitle: false
84+
}
85+
]
86+
]
87+
}

releaseNotesTemplates/commit.hbs

Whitespace-only changes.

0 commit comments

Comments
 (0)