5-提交代码.

Posted 2021-02-13 tomandjerry

写代码

重新编译

写文档和写测试用例

• 到项目根目录下，运行npm i gitbook-cli -g，然后创建SUMMARY.md

SUMMARY.md内容如下
* [项目介绍](README.md)
* [使用文档](doc/use/README.md)
   * [使用1](doc/use/use1.md)
     * [使用2](doc/use/use2.md)
* [二次开发](doc/dev/README.md)
   * [开发1](doc/dev/dev1.md)
     * [开发2](doc/dev/dev2.md)

• 运行gitbook init，创建各个文档，完善各个文档的内容。
• 最后再修改根目录下面的README.md，把文档的链接加上

[如何使用](./doc/use/README.md)
[二次开发](./doc/dev/README.md)

• 运行gitbook build 可以将md文件发布为html文件，默认放在_book文件夹下。
• 运行npm run example，访问http://localhost:8080/_book可以查看效果

提交第一版本代码

• 首先在.gitigore文件上加一行_book，把打包出来的文件忽略掉。
• 创建tag并提交

git tag -a 'v0.0.0' -m '第一版本'
git push origin v0.0.0

提交之后，下载地址就有了，https://github.com/fast-cache/fast-cache/releases 可以下载各个版本的代码。

• 最后要提交到npm上，让使用者通过npm进行安装。

//先登录npm
npm add user
npm login
//发布
npm publish .

升级代码

• 创建一个dev分支，不要在master分支上开发
• 修改package.json版本号，按照之前既定的版本规则修改，不能乱改。
• 修改代码、文档和测试用例
• 自测
• 将dev分支提交到远程

git stadus //查看修改哪些东西
git diff //查看修改了哪些位置
git branch //查看当前是哪个分支
git checkout -b dev // 新建dev分支

代码开发完成后，提交流程

• 再次确认版本号，因为版本非常重要。
• 将dev合并到master，并提交master到远程。

原先在dev分支上，先切换分支
git checkout master
git merge dev
git push origin master

• 创建tag并提交到远程。

git tag -a v0.0.3
git push origin v0.0.3

• 提交到npm。

合并pr