Skip to content

Commit b838de7

Browse files
authored
ci: merge changelog generation into release workflow (#228)
1 parent 26de524 commit b838de7

3 files changed

Lines changed: 32 additions & 59 deletions

File tree

.github/workflows/changelog.yml

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

.github/workflows/release.yml

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,18 +22,31 @@ jobs:
2222
contents: write
2323
steps:
2424
- uses: actions/checkout@v6
25+
with:
26+
fetch-depth: 0
2527

2628
- uses: actions/setup-node@v6
2729
with:
2830
node-version: 24
2931

3032
- run: npm version --no-git-tag-version ${{ env.NPM_VERSION }}
3133

32-
- name: Commit package.json
34+
- uses: orhun/git-cliff-action@v4
35+
with:
36+
config: cliff.toml
37+
args: --tag v${{ env.NPM_VERSION }}
38+
env:
39+
OUTPUT: CHANGELOG.md
40+
GITHUB_REPO: ${{ github.repository }}
41+
42+
- name: Commit package.json and CHANGELOG.md
3343
uses: ryancyq/github-signed-commit@v1
3444
env:
3545
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
3646
with:
37-
files: package*.json
47+
files: |
48+
package.json
49+
package-lock.json
50+
CHANGELOG.md
3851
commit-message: "release: Bump version for ${{ env.NPM_VERSION }}"
39-
tag: v${{ env.NPM_VERSION }}
52+
tag: v${{ env.NPM_VERSION }}

cliff.toml

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -62,22 +62,25 @@ commit_preprocessors = [
6262
]
6363
# regex for parsing and grouping commits
6464
commit_parsers = [
65-
{ message = "^feat", group = "Features" },
66-
{ message = "^fix", group = "Bug Fixes" },
67-
{ message = "^doc", group = "Documentation" },
68-
{ message = "^perf", group = "Performance" },
69-
{ message = "^refactor", group = "Refactoring" },
70-
{ message = "^style", group = "Style" },
71-
{ message = "^revert", group = "Revert" },
72-
{ message = "^test", group = "Tests" },
73-
{ message = "^chore\\(version\\):", skip = true },
74-
{ message = "^chore", group = "Miscellaneous Chores", skip = true },
75-
{ message = "^ci", skip = true },
76-
{ message = "^release", skip = true },
65+
{ message = "^feat[\\(:]", group = "Features" },
66+
{ message = "^fix[\\(:]", group = "Bug Fixes" },
67+
{ message = "^doc[\\(:]", group = "Documentation" },
68+
{ message = "^perf[\\(:]", group = "Performance" },
69+
{ message = "^refactor[\\(:]", group = "Refactoring" },
70+
{ message = "^style[\\(:]", group = "Style" },
71+
{ message = "^revert[\\(:]", group = "Revert" },
72+
{ message = "^test[\\(:]", group = "Tests" },
73+
{ message = "^lib[\\(:]", group = "Dependencies" },
74+
{ message = "^build[\\(:]", group = "Dependencies" },
75+
{ message = "^Bump .+ from .+ to .+", group = "Dependencies" },
76+
{ message = "^Update .+ requirement from .+ to .+", group = "Dependencies" },
77+
{ message = "^chore[\\(:]", skip = true },
78+
{ message = "^ci[\\(:]", skip = true },
79+
{ message = "^release[\\(:]", skip = true },
7780
{ body = ".*security", group = "Security" },
7881
]
7982
# filter out the commits that are not matched by commit parsers
80-
filter_commits = false
83+
filter_commits = true
8184
# sort the tags topologically
8285
topo_order = false
8386
# sort the commits inside sections by oldest/newest order

0 commit comments

Comments
 (0)