spire-plugin-semantic-release

spire-plugin-semantic-release

semantic-release plugin for Spire.

• Quick start
• Hooks
• Options
• License

Quick start

1. Install spire-plugin-semantic-release

yarn add --dev spire-plugin-semantic-release

2. Add spire-plugin-semantic-release to list of plugins

{
  "spire": {
    "plugins": ["spire-plugin-semantic-release"]
  }
}

Hooks

• setup Adds release 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 if config is set. auto will try to detect the provider based on the git remote url. Defaults to auto.
  • allowCustomConfig <boolean> Whether to allow user-provided config. If this option is false and there's custom semantic-release config found it will throw an error. Defaults to true.
  • 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