From 8f4c66bde2196b0ca1c238ce8bc73abae0d98f6c Mon Sep 17 00:00:00 2001 From: Spencer17x <1253478653@qq.com> Date: Fri, 15 Jul 2022 15:18:41 +0800 Subject: [PATCH] =?UTF-8?q?feat(ar-changelog):=20=E4=BD=BF=E7=94=A8?= =?UTF-8?q?=E6=96=87=E6=A1=A3=E6=9B=B4=E6=96=B0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- packages/scripts/ar-changelog/README.md | 28 +++++++++++++++++++++++-- 1 file changed, 26 insertions(+), 2 deletions(-) diff --git a/packages/scripts/ar-changelog/README.md b/packages/scripts/ar-changelog/README.md index 4b97cfa..2bd097b 100644 --- a/packages/scripts/ar-changelog/README.md +++ b/packages/scripts/ar-changelog/README.md @@ -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