Skip to content

Commit

Permalink
docs: update standard-version
Browse files Browse the repository at this point in the history
  • Loading branch information
superwf committed Jan 23, 2020
1 parent 54c29df commit 37462af
Show file tree
Hide file tree
Showing 17 changed files with 43 additions and 6 deletions.
Binary file added standard-version/1.apng
Binary file not shown.
49 changes: 43 additions & 6 deletions standard-version/README.md
@@ -1,12 +1,49 @@
# 以git为核心的前端发布工作流
# 以git提交日志为核心的前端发布工作流

## 起因:需要写发布日志吗?
## 问题: 需要写发布日志吗?

* 每次发布之后都可能会想起来,好像忘了写发布日志 (︶︹︺),呵呵,算了就这样吧 ╮(╯▽╰)╭
* 每次发布之后都可能会想起来,好像忘了写发布日志 (︶︹︺),呵呵,算了就这样吧 ╮(╯▽╰)╭

## 使用yarn代替npm
* 我们需要写发布日志,这个需求可能来自领导,或是自我驱动。

## Part 1: commotlint
> 当我们写年终总结的时候,优势突然会觉得,我这一年都干了些神马?
>
> 大的项目基本是不会忘记的,然后开始按项目回想,在然后到每个项目内部,大部分细节也都忘记了。
* 项目有了更新之后,这种更新是否需要及时通知他人?是否将这种更新细节归档,以供之后查询呢?

🍧 以下内容的一个前置小条件: 使用`yarn`代替`npm`

## 由第一个问题带出的问题

```
|_____需要吗,不需要吗?
| |_____不需要
| | |_____game over,然后就没有然后了
| |_____需要,那么如何写呢
| | |_____自己随便写,写着写着估计后来的自己也不认识了
| | |_____找个规范吧,哪种规范合适呢?
```

## 规范概念

### [semver](https://www.npmjs.com/package/semver)

`semver`既是一个概念,也是一个npm工具,该工具就是这个概念的程序实现。

我们在安装一个`npm`包之后,会自动写入项目的`package.json`文件中。

<details><summary>比如</summary>

```json
"prettier": "^1.18.2"
```

</details>

![](./1.apng)

## Part 1: commitlint

### 提交格式

Expand Down Expand Up @@ -72,7 +109,7 @@ cd example
yarn init -y
```

<video media-src="./videos/initExample.ogv" controls="controls"></video>
<video src="./videos/initExample.ogv" controls="controls"></video>

安装:

Expand Down
Binary file removed standard-version/videos/autoGenerateChangelog.ogv
Binary file not shown.
Binary file removed standard-version/videos/configCommitlint.ogv
Binary file not shown.
Binary file removed standard-version/videos/configHusky.ogv
Binary file not shown.
Binary file removed standard-version/videos/initExample.ogv
Binary file not shown.
Binary file removed standard-version/videos/installCommitizen.ogv
Binary file not shown.
Binary file removed standard-version/videos/installCommitlint.ogv
Binary file not shown.
Binary file not shown.
Binary file removed standard-version/videos/installHusky.ogv
Binary file not shown.
Binary file removed standard-version/videos/installStandardVersion.ogv
Binary file not shown.
Binary file removed standard-version/videos/runCommitizen.ogv
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file removed standard-version/videos/testCommitlintAndFail.ogv
Binary file not shown.
Binary file removed standard-version/videos/viewGithooksDir.ogv
Binary file not shown.

0 comments on commit 37462af

Please sign in to comment.