生成项目CHANGELOG文件
2022/4/9 大约 2 分钟
在前一篇中我们通过
@commitlint/cli完成了提交规范，本篇将介绍如何自动化生成log文件CHANGELOG.md。
# 安装
# 全局安装
npm install -g conventional-changelog-cli
1
2
2
# 查看帮助
$ conventional-changelog --help
Generate a changelog from git metadata
Usage
conventional-changelog
Example
conventional-changelog -i CHANGELOG.md --same-file
Options
-i, --infile Read the CHANGELOG from this file
-o, --outfile Write the CHANGELOG to this file
If unspecified, it prints to stdout
-s, --same-file Outputting to the infile so you don't need to specify the same file as outfile
-p, --preset Name of the preset you want to use. Must be one of the following:
angular, atom, codemirror, conventionalcommits, ember, eslint, express, jquery or jshint
-k, --pkg A filepath of where your package.json is located
Default is the closest package.json from cwd
-a, --append Should the newer release be appended to the older release
Default: false
-r, --release-count How many releases to be generated from the latest
If 0, the whole changelog will be regenerated and the outfile will be overwritten
Default: 1
--skip-unstable If given, unstable tags will be skipped, e.g., x.x.x-alpha.1, x.x.x-rc.2
-u, --output-unreleased Output unreleased changelog
-v, --verbose Verbose output. Use this for debugging
Default: false
-n, --config A filepath of your config script
Example of a config script: https://github.com/conventional-changelog/conventional-changelog/blob/master/packages/conventional-changel
og-cli/test/fixtures/config.js
-c, --context A filepath of a json that is used to define template variables
-l, --lerna-package Generate a changelog for a specific lerna package (:pkg-name@1.0.0)
-t, --tag-prefix Tag prefix to consider when reading the tags
--commit-path Generate a changelog scoped to a specific directory
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
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
# 生成CHANGELOG
执行完下面的命令后会自动生成一个
CHANGELOG.md文件。
conventional-changelog -p conventionalcommits -i CHANGELOG.md -s -r 0
1
如果你的项目已经有
CHANGELOG.md文件了，那么此命令会覆写你已经存在的文件，如果不想覆盖请使用以下命令：
conventional-changelog -p conventionalcommits -i CHANGELOG.md -s
1
示例：你也可以直接执行此命令 则会在控制台打印出msg信息，不会生成日志文件。
$ conventional-changelog
## <small>3.0.52 (2022-04-09)</small>
* fix: 修复了一个bug，该bug曾导致使用了自定义权限的接口，在实际调用时无法生成logPerimitId ([e1a64cc](xxx/apps/kylin-operation/commit/e1a64cc))
1
2
3
4
5
2
3
4
5
# 配合脚本使用
{
"scripts": {
"version": "conventional-changelog -p conventionalcommits -i CHANGELOG.md -s && git add CHANGELOG.md"
}
}
1
2
3
4
5
2
3
4
5
# 注意事项
- 我这里使用的预处理器是：
conventionalcommits,此处理器在上篇中已经有过介绍这里不做说明。