Skip to content

Commit

Permalink
docs: Improve documentation on providing an empty tag-prefix (convent…
Browse files Browse the repository at this point in the history
…ional-changelog#579)

Co-authored-by: Benjamin E. Coe <bencoe@google.com>
Co-authored-by: Joe Bottigliero <694253+jbottigliero@users.noreply.github.com>

fixes conventional-changelog#490
  • Loading branch information
jorenbroekema authored Feb 20, 2021
1 parent 843c572 commit f5bff12
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -309,7 +309,9 @@ standard-version -t @scope/package\@

This will prefix your tags to look something like `@scope/package@2.0.0`

If you do not want to have any tag prefix you can use the `-t` flag without value.
If you do not want to have any tag prefix you can use the `-t` flag and provide it with an **empty string** as value.

> Note: simply -t or --tag-prefix without any value will fallback to the default 'v'
### CLI Help

Expand Down Expand Up @@ -368,9 +370,7 @@ As of version `7.1.0` you can configure multiple `bumpFiles` and `packageFiles`.

1. Specify a custom `bumpFile` "`filename`", this is the path to the file you want to "bump"
2. Specify the `bumpFile` "`updater`", this is _how_ the file will be bumped.

a. If you're using a common type, you can use one of `standard-version`'s built-in `updaters` by specifying a `type`.

b. If your using an less-common version file, you can create your own `updater`.

```js
Expand Down

0 comments on commit f5bff12

Please sign in to comment.