Skip to content

Commit

Permalink
docs: wrong prerelease example (semantic-release#2307)
Browse files Browse the repository at this point in the history
The documentation says:

> If the `prerelease` property is set to `true` the `name` value will be used.

But then the example referring to this behaviour has the the `prerelease` value set to `'beta'` instead of `true`.
  • Loading branch information
maxiride authored and morey-tech committed Sep 12, 2022
1 parent 6fde4c7 commit b54600b
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/usage/workflow-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ For example the configuration `['master', {name: 'pre/rc', prerelease: '${name.r
branches: [
{name: 'master'},
{name: 'pre/rc', channel: 'pre/rc', prerelease: 'rc'}, // `prerelease` is built with the template `${name.replace(/^pre\\//g, "")}`
{name: 'beta', channel: 'beta', prerelease: 'beta'}, // `prerelease` is set to `beta` as it is the value of `name`
{name: 'beta', channel: 'beta', prerelease: true}, // `prerelease` is set to `beta` as it is the value of `name`
]
}
```
Expand Down

0 comments on commit b54600b

Please sign in to comment.