0%

2019-12-23 如何自定义conventional-changelog

2019-12-23 如何自定义conventional-changelog

参考:https://juejin.im/post/5d27f84a6fb9a07ed064ddf1

https://zhuanlan.zhihu.com/p/51894196

进阶篇:2020-02-18 自定义changelog及自动化github-release

2019年7月在写一个小项目的时候用到过conventional-changelog这个工具来自动生成更新日志。

虽然对 git commit 的格式约束严格了,也就是不能随心所欲的提交代码了。但对于后期的自动生成更新日志来讲,以及对于整个团队协作,项目的开发来讲是十分划算的,可以节省下大把写更新日志的时间,免得自己都忘了更新了啥。【看没有格式的git commit ,真的不要太痛苦】

主要的用法在两个参考链接中有提,因此本文就重点讲一下如何自定义changelog。

首先还得感谢https://juejin.im/post/5d27f84a6fb9a07ed064ddf1这篇文章。教会了我很多东西。

这篇文章的作者还写了一个 conventional-changelog-angular的预设扩展项目地址 。正是这个项目让我搞明白了怎么自定义。

自定义的关键,显然就在根目录的changelog-option.js文件,观察这个文件后,发现正是这个文件定义了哪些git commit 要写入更新日志,以及生成日志的每块内容的标题。

例如,如果我只关注 feat(新功能) 、fix(Bug 修复) 、perf(性能优化)、revert(回退),那么我就可以在配置中这样写。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
module.exports = {
writerOpts: {
transform: (commit, context) => {
if (commit.type === 'feat') {
commit.type = '✨ Features | 新功能'
} else if (commit.type === 'fix') {
commit.type = '🐛 Bug Fixes | Bug 修复'
} else if (commit.type === 'perf') {
commit.type = '⚡ Performance Improvements | 性能优化'
} else if (commit.type === 'revert' || commit.revert) {
commit.type = '⏪ Reverts | 回退'
}
return
}

这样一来就只会生成需要的日志而不会生成其他的日志。

而聪明的读者肯定也观察到了,commit.type正是我们需要改动的标题

用这种方法生成的日志参考图

mark

完整的changelog-option.js如下

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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
const compareFunc = require('compare-func')
module.exports = {
writerOpts: {
transform: (commit, context) => {
let discard = true
const issues = []

commit.notes.forEach(note => {
note.title = 'BREAKING CHANGES'
discard = false
})
if (commit.type === 'feat') {
commit.type = '✨ Features | 新功能'
} else if (commit.type === 'fix') {
commit.type = '🐛 Bug Fixes | Bug 修复'
} else if (commit.type === 'perf') {
commit.type = '⚡ Performance Improvements | 性能优化'
} else if (commit.type === 'revert' || commit.revert) {
commit.type = '⏪ Reverts | 回退'
} else if (discard) {
return
} else if (commit.type === 'docs') {
commit.type = '📝 Documentation | 文档'
} else if (commit.type === 'style') {
commit.type = '💄 Styles | 风格'
} else if (commit.type === 'refactor') {
commit.type = '♻ Code Refactoring | 代码重构'
} else if (commit.type === 'test') {
commit.type = '✅ Tests | 测试'
} else if (commit.type === 'build') {
commit.type = '👷‍ Build System | 构建'
} else if (commit.type === 'ci') {
commit.type = '🔧 Continuous Integration | CI 配置'
} else if (commit.type === 'chore') {
commit.type = '🎫 Chores | 其他更新'
}


if (commit.scope === '*') {
commit.scope = ''
}
if (typeof commit.hash === 'string') {
commit.hash = commit.hash.substring(0, 7)

}
if (typeof commit.subject === 'string') {
let url = context.repository
? `${context.host}/${context.owner}/${context.repository}`
: context.repoUrl
if (url) {
url = `${url}/issues/`
// Issue URLs.
commit.subject = commit.subject.replace(/#([0-9]+)/g, (_, issue) => {
issues.push(issue)
return `[#${issue}](${url}${issue})`
})
}
if (context.host) {
// User URLs.
commit.subject = commit.subject.replace(/\B@([a-z0-9](?:-?[a-z0-9/]){0,38})/g, (_, username) => {
if (username.includes('/')) {
return `@${username}`
}

return `[@${username}](${context.host}/${username})`
})
}
}

// remove references that already appear in the subject
commit.references = commit.references.filter(reference => {
if (issues.indexOf(reference.issue) === -1) {
return true
}

return false
})
return commit
},
groupBy: 'type',
commitGroupsSort: 'title',
commitsSort: ['scope', 'subject'],
noteGroupsSort: 'title',
notesSort: compareFunc
}
}

最后在package.json中的scripts添加一条语句

1
2
3
4
5
6
7
8
 "changelog": "conventional-changelog -p custom-config -i CHANGELOG.md -s -r 0  -n ./changelog-option.js"
//在这指定配置文件位置,本人放在了根目录,也可以指定其他地方
/*配置项说明:
-p custom-config 指定风格
-i CHANGELOG.md 指定输出的文件名称
-s -r 0 指定增量更新,不会覆盖以前的更新日志
-n ./changelog-option.js 指定自定义配置
*/

注意本项目中用到了custom-config,因此需要先安装custom-config【单纯的changelog-option.js是不完整的配置,在此只修改了自己需要的部分,其他部分默认】

1
npm i conventional-changelog-custom-config -D

最后运行

1
npm run changelog

即可

这就是关于如何自定义conventional-changelog的方法了。之前上百度、谷歌都有搜过,但没有一个教程是讲如何自定义日志的。为了防止以后忘了,因此记录。

【2020/1/2:最近去搜了下, 讲如何自定义配置的依旧只有我这一篇文章,结果就是在谷歌上的权重还挺高的hhh】

2020/2/18 更新

之前要手动配置毕竟不爽,因此草梅将conventional-changelog-custom-config fork了一份,添加了一些自己的改动并发布到npm上了,包名是conventional-changelog-cmyr-config。使用方法也是类似的,即:

1
2
npm i conventional-changelog-cmyr-config -D 
conventional-changelog -p cmyr-config -i CHANGELOG.md -s -r 0

移除原有的配置文件,改为从包中获取配置。

本文作者:草梅友仁
本文地址: https://blog.cmyr.ltd/archives/caf24092.html
版权声明:转载请注明出处!

坚持原创技术分享,您的支持将鼓励我继续创作!