From 94ae562830cd7169080e7e7d0921fd83ad835c83 Mon Sep 17 00:00:00 2001 From: zjkjzj Date: Thu, 18 Mar 2021 20:29:01 +0800 Subject: [PATCH] docs(tool): add commitizen/commitlint/huksy/conventional-changelog/generator-standard-readme --- ...mmitizen]信息交互工具.md => commitizen.md} | 8 ++--- ...ky]消息校验工具.md => commitlint-husky.md} | 10 +++--- ...化及CHANGELOG生成.md => standard-version.md} | 36 +++++++++---------- mkdocs.yml | 6 +++- 4 files changed, 31 insertions(+), 29 deletions(-) rename docs/tool/{[Commitizen]信息交互工具.md => commitizen.md} (90%) rename docs/tool/{[CommitLint][Husky]消息校验工具.md => commitlint-husky.md} (95%) rename docs/tool/{[standard-version]版本自动化及CHANGELOG生成.md => standard-version.md} (66%) diff --git a/docs/tool/[Commitizen]信息交互工具.md b/docs/tool/commitizen.md similarity index 90% rename from docs/tool/[Commitizen]信息交互工具.md rename to docs/tool/commitizen.md index 27a9c56..c87721e 100644 --- a/docs/tool/[Commitizen]信息交互工具.md +++ b/docs/tool/commitizen.md @@ -1,18 +1,18 @@ -# [Commitizen]信息交互工具 +# [Commitizen]信息提交 [Commitizen](http://commitizen.github.io/cz-cli/)是一个提交日志工具，辅助开发者使用提交规则 ## 预配置 -需要安装`NodeJS`，参考：[nodeJS安装](https://hexo-guide.readthedocs.io/zh_CN/latest/node/nodeJS%E5%AE%89%E8%A3%85.html) +* 安装`NodeJS` -## 安装`Commitizen` +## 安装Commitizen # 全局安装 $ npm install -g commitizen -## 安装`Adapter` +## 安装Adapter `Commitizen`支持多种不同的提交规范，可以安装和配置不同的适配器实现 diff --git a/docs/tool/[CommitLint][Husky]消息校验工具.md b/docs/tool/commitlint-husky.md similarity index 95% rename from docs/tool/[CommitLint][Husky]消息校验工具.md rename to docs/tool/commitlint-husky.md index 35a91c4..ac8a00f 100644 --- a/docs/tool/[CommitLint][Husky]消息校验工具.md +++ b/docs/tool/commitlint-husky.md @@ -1,7 +1,5 @@ -# [CommitLint][Husky]消息校验工具 - -参考：[commitlint](https://conventional-changelog.github.io/commitlint/#/) +# [CommitLint][Husky]消息校验 使用`commitizen`可以规范化提交信息，同样的，可以设置工具来检查提交信息是否符合格式要求 @@ -122,4 +120,8 @@ language: node_js script: - - commitlint-travis \ No newline at end of file + - commitlint-travis + +## 相关阅读 + +* [commitlint](https://conventional-changelog.github.io/commitlint/#/) \ No newline at end of file diff --git a/docs/tool/[standard-version]版本自动化及CHANGELOG生成.md b/docs/tool/standard-version.md similarity index 66% rename from docs/tool/[standard-version]版本自动化及CHANGELOG生成.md rename to docs/tool/standard-version.md index 60ebabd..ee5ce0a 100644 --- a/docs/tool/[standard-version]版本自动化及CHANGELOG生成.md +++ b/docs/tool/standard-version.md @@ -1,23 +1,9 @@ -# [standard-version]版本自动化及CHANGELOG生成 - -参考： - -[conventional-changelog/standard-version](https://github.com/conventional-changelog/standard-version) - -[Closing issues using keywords](https://help.github.com/en/articles/closing-issues-using-keywords) - -[如何维护更新日志](https://keepachangelog.com/zh-CN/1.0.0/) - -## conventioanl-changelog - -参考： - -[conventional-changelog-cli](https://www.cnblogs.com/zivxiaowei/p/10089201.html) +# 版本自动化及CHANGELOG生成 使用工具[conventional-changelog](https://www.npmjs.com/package/conventional-changelog)进行`CHANGELOG`文件的自动生成 -### 安装 +## 安装 全局安装: @@ -25,7 +11,7 @@ $ npm install -g conventional-changelog-cli ``` -### 使用 +## 使用 基本使用命令如下： @@ -47,9 +33,7 @@ $ conventional-changelog -p angular -i CHANGELOG.md -s -r 0 * 参数`-r`默认为`1`，设为`0`将重新生成所有版本的变更信息 -### 快捷方式 - -参考：[五、生成 Change log](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html) +## 快捷方式 在工程`package.json`中加入以下脚本 @@ -66,3 +50,15 @@ $ conventional-changelog -p angular -i CHANGELOG.md -s -r 0 ``` $ npm run changelog ``` + +## 相关阅读 + +* [conventional-changelog/standard-version](https://github.com/conventional-changelog/standard-version) + +* [Closing issues using keywords](https://help.github.com/en/articles/closing-issues-using-keywords) + +* [如何维护更新日志](https://keepachangelog.com/zh-CN/1.0.0/) + +* [conventional-changelog-cli](https://www.cnblogs.com/zivxiaowei/p/10089201.html) + +* [五、生成 Change log](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html) \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index c29782b..e190832 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -76,4 +76,8 @@ nav: - 拉取指定远程分支到本地: git/advanced/拉取指定远程分支到本地.md - 远程分支替换本地分支: git/advanced/远程分支替换本地分支.md - 为每个项目单独设置用户名和邮箱: git/advanced/为每个项目单独设置用户名和邮箱.md - - ERROR: git/error.md \ No newline at end of file + - ERROR: git/error.md + - '[Commitizen]消息提交': tool/commitizen.md + - '[CommitLint][Husky]消息校验': tool/commitlint-husky.md + - README生成器: tool/generator-standard-readme.md + - '版本自动化及CHANGELOG生成': tool/standard-version.md \ No newline at end of file