Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/be-fe/conventional-changelog-befe
conventional-changelog @baidu/preset for baidu BEFE
https://github.com/be-fe/conventional-changelog-befe
Last synced: about 14 hours ago
JSON representation
conventional-changelog @baidu/preset for baidu BEFE
- Host: GitHub
- URL: https://github.com/be-fe/conventional-changelog-befe
- Owner: be-fe
- License: mit
- Created: 2018-10-26T03:09:18.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2022-02-11T00:33:50.000Z (almost 3 years ago)
- Last Synced: 2024-12-06T03:48:06.116Z (19 days ago)
- Language: JavaScript
- Size: 212 KB
- Stars: 0
- Watchers: 10
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: License
Awesome Lists containing this project
README
# conventional-changelog-befe
[](https://travis-ci.org/be-fe/conventional-changelog-befe)
[](https://www.npmjs.com/package/conventional-changelog-befe)
[](https://www.npmjs.com/package/conventional-changelog-befe)
> conventional-changelog preset for baidu BEFE.
## 样例项目
[icode commit-demo](http://icode.baidu.com/repos/baidu/personal-code/commit-demo)
## 规范标准
- [Commit message 和 Change log 编写指南](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html)
- [约定式提交](https://conventionalcommits.org/)
除了上述规范标准以外，befe 规范还支持：
### type 允许大写字母开头
- `build/Build`: 构建相关
- `chore/Chore`: 其他繁杂事务的变动
- `ci/Ci`: ci 相关的变动
- `docs/Docs`: 文档书写改动
- `feat/Feat`: 新功能，新特性 **(体现在 changelog)**
- `fix/Fix`: Bug 修复 **(体现在 changelog)**
- `perf/Perf`: 性能优化相关 **(体现在 changelog)**
- `refactor`: 重构（即不是新增功能，也不是修改 bug 的代码变动）
- `revert/Revert`: 代码回滚 **(体现在 changelog)**
- `style/Style`: Code Style 修改
- `test/Test`: 测试相关
- `temp/Temp`: 临时提交
### scope / subject 允许中文
```text
feat(编辑页面): 添加自动保存
```
### 特殊的
#### 一个提交中包含多个 type (v2.0)
有时候可能一次提交中涉及的操作比较多，这时候需要安装如下的规则提交，才能正常解析生成 changelog，当然更建议的还是分开提交啦。
```text
fix: foo & feat: add something & chore: abc @yucong02
some description
```
```text
fix: foo
feat: add something
chore: abc @yucong02
some description
```
#### 代码回滚 Revert
除了支持规范定义的
```text
revert: fix: something
This reverts commit 05699d0ded15dc35a038612a38185aa71274151.
```
同时支持默认 `git revert` message 模板
```text
Revert "fix: something"
This reverts commit 05699d0ded15dc35a038612a38185aa71274151.
```
### 支持 icode / baidu gitlab / icafe
如果是 icode 或 baidu gitlab 仓库（会读取 `package.json` 中的 `repository` 或者 获取 git 远端地址），需要在 `package.json` 中配置 `icafe` 字段，对应为该项目的 icafe Id。
```json
{
"icafe": "dulife-hr"
}
```
或者
```json
{
"icafe": {
"spaceId": "dulife-hr"
}
}
```
然后在 commit message 中匹配的 `#123` 将会在 changelog 对应为 icafe 对应 issue 地址。
如果是想关联其他项目的卡片，则需要在 commit message 中书写完整的 icafe ID, 如
```text
feat: 完成 changelog 文档任务
closes BEFE-ERP-225 befe-erp-564
```
### changelog 支持中英文
在 `package.json` 中配置
```js
{
"lang": "zh" // 'zh' | 'en'
}
```
默认为系统语言
## 使用
### 安装
```
npm i conventional-changelog-cli conventional-changelog-befe -D
```
### 在项目 (`package.json`) 配置
```json
{
"scripts": {
"changelog": "conventional-changelog -p befe -i CHANGELOG.md -s -r 0 && git add CHANGELOG.md",
"version": "npm run changelog"
}
}
```
### 触发
执行 `npm version [version]` 或直接执行 `npm run changelog`
### 配置
- `package.json`
```json
{
"config": {
"conventional-changelog-befe": {
"i18n": {
"fix.title": "🐛 BugFix"
}
}
}
}
```
#### `i18n`
自定义国际化文本，包含[国际化文本](i18n/zh.js)
- Type: `{}`
- Default: `{}`
## Related
- [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog) - 根据 commit message 生成 changelog
- [commitlint](https://github.com/marionebl/commitlint) - Lint commit messages
- [commitlint-config-befe](http://gitlab.baidu.com/be-fe/commitlint-config-befe) - commitlint lint 预设
## License
MIT