From 46d6a956dccdf15b7c5ac2e8c9e15258fa3ad1a8 Mon Sep 17 00:00:00 2001 From: Jitendra Adhikari Date: Wed, 3 Mar 2021 19:25:29 +0700 Subject: [PATCH] docs: add new options in usage and readme --- README.md | 7 +++++-- please | 3 +++ 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b8ea1ef..b7500dd 100644 --- a/README.md +++ b/README.md @@ -72,7 +72,7 @@ please [Scope|Command] [Options] ``` ``` -please v0.9.0 | (c) Jitendra Adhikari | please is semver release made easy. +please v0.11.0 | (c) Jitendra Adhikari | please is semver release made easy. Usage: please [command|scope] [--options] @@ -88,8 +88,11 @@ Options: -H --chash Prepends commit hash into log. -o --organize Commit types as CSV for changelog or release notes. (Default: feat,fix,refactor,perf,docs,infra,chore) + -L | --label Set custom release label. + -N | --no-sync Do not sync the DEPLOY_BRANCH with remote (faster but unsafe). -p --public Set scoped npm package for public access. - -u --update Update _please to latest version. + --prev-version Fix the previous version (skips API call). + -u --update Update please to latest version. -v --vfile Forces creation of VERSION file. -V --version Forces the exact version to be released. -y --yes Assume yes for any confirmation. diff --git a/please b/please index ba549a6..cbf8fda 100755 --- a/please +++ b/please @@ -55,7 +55,10 @@ $(ok Options:) $(info "-H --chash") $(comment "Prepends commit hash into log.") $(info "-o --organize") $(comment "Commit types as CSV for changelog or release notes.") $(comment "(Default: feat,fix,refactor,perf,docs,infra,chore)") + $(info "-L | --label") $(comment "Set custom release label.") + $(info "-N | --no-sync") $(comment "Do not sync the DEPLOY_BRANCH with remote (faster but unsafe).") $(info "-p --public") $(comment "Set scoped npm package for public access.") + $(info "--prev-version") $(comment "Fix the previous version (skips API call).") $(info "-u --update") $(comment "Update $PLIZ to latest version.") $(info "-v --vfile") $(comment "Forces creation of VERSION file.") $(info "-V --version") $(comment "Forces the exact version to be released.")