Install
spire-plugin-semantic-release
semantic-release plugin for Spire.
Quick start
- Install
spire-plugin-semantic-release
yarn add --dev spire-plugin-semantic-release
- Add
spire-plugin-semantic-release
to list of plugins
{
"spire": {
"plugins": ["spire-plugin-semantic-release"]
}
}
Hooks
setup
Addsrelease
command and prepares semantic-release arguments.run
Runs semantic-release.
Options
-
Plugin
['spire-plugin-semantic-release', options]
command
<string> Command to run semantic-release on. Defaults to
release
.config
<string> Default semantic-release configuration. Defaults to
one of the configs in./config/
based on the setting of
provider.provider
<['auto'|'none'|'github'|'gitlab']> Provider where the
repository is hosted. Has no effect ifconfig
is set.auto
will try to
detect the provider based on the git remote url. Defaults toauto
.allowCustomConfig
<boolean> Whether to allow user-provided config. If
this option isfalse
and there's custom semantic-release config found it
will throw an error. Defaults totrue
.changelogName
<string> Case-sensitive changelog name. Defaults to
changelog.md
.gitAuthorName
<string> Git author and commiter name. Defaults to
undefined
, which falls back to default value of semantic-release.gitAuthorEmail
<string> Git author and commiter email. Defaults to
undefined
, which falls back to default value of semantic-release.
-
CLI
npx spire release [args]
- Passes all arguments as-is to semantic-release.
License
MIT © ResearchGate