From ff9c4763d6f74dcae1f9dd0ec59719027bb4d13c Mon Sep 17 00:00:00 2001 From: Kirill Konshin Date: Tue, 16 Apr 2019 12:46:21 -0700 Subject: [PATCH] fix(docs): Add missing docs for `--tag-version-prefix` (#2035) Closes #1924 --- commands/publish/README.md | 14 ++++++++++++++ commands/version/README.md | 14 ++++++++++++++ 2 files changed, 28 insertions(+) diff --git a/commands/publish/README.md b/commands/publish/README.md index ac3530b4ed..8a632e52d4 100644 --- a/commands/publish/README.md +++ b/commands/publish/README.md @@ -57,6 +57,7 @@ This is useful when a previous `lerna publish` failed to publish all packages to - [`--ignore-scripts`](#--ignore-scripts) - [`--ignore-prepublish`](#--ignore-prepublish) - [`--yes`](#--yes) +- [`--tag-version-prefix`](#--tag-version-prefix) ### `--canary` @@ -191,6 +192,19 @@ lerna publish --canary --yes When run with this flag, `lerna publish` will skip all confirmation prompts. Useful in [Continuous integration (CI)](https://en.wikipedia.org/wiki/Continuous_integration) to automatically answer the publish confirmation prompt. +### `---tag-version-prefix` + +This option allows to provide custom prefix instead of the default one: `v`. + +Keep in mind that currently you have to supply it twice: for `version` command and for `publish` command: + +```bash +# locally +lerna version --tag-version-prefix='' +# on ci +lerna publish from-git --tag-version-prefix='' +``` + ## Deprecated Options ### `--skip-npm` diff --git a/commands/version/README.md b/commands/version/README.md index b787311732..735d52d4ba 100644 --- a/commands/version/README.md +++ b/commands/version/README.md @@ -55,6 +55,7 @@ If you have any packages with a prerelease version number (e.g. `2.0.0-beta.3`) - [`--sign-git-commit`](#--sign-git-commit) - [`--sign-git-tag`](#--sign-git-tag) - [`--yes`](#--yes) +- [`--tag-version-prefix`](#--tag-version-prefix) ### `--allow-branch ` @@ -308,6 +309,19 @@ lerna version --yes When run with this flag, `lerna version` will skip all confirmation prompts. Useful in [Continuous integration (CI)](https://en.wikipedia.org/wiki/Continuous_integration) to automatically answer the publish confirmation prompt. +### `---tag-version-prefix` + +This option allows to provide custom prefix instead of the default one: `v`. + +Keep in mind that currently you have to supply it twice: for `version` command and for `publish` command: + +```bash +# locally +lerna version --tag-version-prefix='' +# on ci +lerna publish from-git --tag-version-prefix='' +``` + ## Deprecated Options ### `--cd-version`