Skip to content

Commit

Permalink
feat(ar-changelog): 使用文档更新
Browse files Browse the repository at this point in the history
  • Loading branch information
spencer17x committed Jul 15, 2022
1 parent 3155f95 commit 8f4c66b
Showing 1 changed file with 26 additions and 2 deletions.
28 changes: 26 additions & 2 deletions packages/scripts/ar-changelog/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,34 @@ Automate the workflow for generating Monorepo's changelog, which will ask you so
$ pnpm add ar-changelog -D
```

if you don't install conventional-changelog-cli, you can install it by:

```shell
$ pnpm add conventional-changelog-cli -D
```

## Usage

* add ar-changelog script to your package.json scripts
* run `pnpm run ar-changelog`
### commands

#### release

**Feature**:

* Generate a changelog based on commits.
* Create a tag with package.

```shell
$ ar-changelog release
```

#### publish

It is mainly responsible for publishing package to NPM

```shell
$ ar-changelog publish
```

## Custom config

Expand Down

0 comments on commit 8f4c66b

Please sign in to comment.