Skip to content

Commit

Permalink
fix(docs): Add missing docs for --tag-version-prefix (#2035)
Browse files Browse the repository at this point in the history
Closes #1924
  • Loading branch information
kirill-konshin authored and evocateur committed Apr 16, 2019
1 parent be65eb7 commit ff9c476
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 0 deletions.
14 changes: 14 additions & 0 deletions commands/publish/README.md
Expand Up @@ -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`

Expand Down Expand Up @@ -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`
Expand Down
14 changes: 14 additions & 0 deletions commands/version/README.md
Expand Up @@ -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 <glob>`

Expand Down Expand Up @@ -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`
Expand Down

0 comments on commit ff9c476

Please sign in to comment.