react-components-docs/bee-tools集成changelog使用方式.md

# bee-tools集成changelog使用方式

## 1、安装Commitizen、bee-tools

> Commitizen是一个格式化commit message的工具。
> bee-tools 请更新到最新版本。【0.4.2】

    npm install -g commitizen
    
    npm install bee-tools/npm update bee-tools

## 2、初始化配置

>如果你项目中已经安装了changelog忽略此步骤

    在项目中执行  
    
    bee-tools run changelogInit

## 3、带log的提交

完成上面2步骤后，如果想生成带log的提交，执行
    
    git cz
    ....(参考git cz命令截图)。
    
## 4、发布上线
    
    执行 bee-tools run pub

1. 如果修改一次性把bug修复完毕，且提交不用执行第3步骤,在执行pub是可以设置log。
2. 如果分批提交，且修改同一个bug，生成多条log记录。需要在每次提交时执行git cz，最后一次次可以直接执行。

        执行 bee-tools run pub
        
        1. please enter the package version to publish (should be xx.xx.xx) (1.0.2) //输入即将要发布的版本号
        
        2. do you wang run changelog ?(y/n) (y) // y或直接回车
        
        3. Select the type of change that you're committing: (Use arrow keys) // 选择本次修改的类型。
        ❯ feat:     A new feature
          fix:      A bug fix
          docs:     Documentation only changes
          style:    Changes that do not affect the meaning of the code (white-space, formatting, missing semi
        -colons, etc)
          refactor: A code change that neither fixes a bug nor adds a feature
          perf:     A code change that improves performance
          test:     Adding missing tests or correcting existing tests
         
          
          
        4. What is the scope of this change (e.g. component or file name)? (press enter to skip) //输入描述(50字以内)
        
        eg: > 本次修复了弹出框的问题。
    
        5. Write a short, imperative tense description of the change: //
        
        eg: > 请参考issues中回复。
        
        6. Provide a longer description of the change: (press enter to skip)
        
        eg: > 回车
        
        7. Are there any breaking changes?
        
        eg: > y
       
        8. Describe the breaking changes
        eg: > 1. 修改了弹出框的问题。
              2. 修复了xx问题。
                    
        9. Does this change affect any open issues? (y/N)
        
        eg: > y
        
        10. Add issue references (e.g. "fix #123", "re #123".):
        
        Closes #x //issues 的编号


如果确定修改完毕，执行发布命令，在发布命令中，会让你输入是否是否再次生成log 的提交。(可选)

## 5、关闭issues
 
      Closes issues编号
      eg：Closes #8

## 6、git cz 命令截图
![](media/15093486333182/15094390880861.jpg)

## 7、效果截图
![](media/15093486333182/15094393010120.jpg)


## 注解

用来标识 commit 的类型，总共有以下 11 个标识：

	feat: 添加了一个新功能
	fix: 修复了一个 bug
	docs: 文档发生修改
	style: 不影响代码运行的更改（空格，格式，缺少分号等）
	refactor: 重构代码且不引进新的功能或修复 bug
	perf: 代码优化
	test: 添加或修改测试用例
	build: 构建工具或外部依赖的更改（npm，webpack，gulp等）
	ci: 更改项目级的配置文件或脚本
	chore: 除上述之外的修改
	revert: 撤销改动先前的提交