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

1. 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

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

5.0.9 (2022-11-11)

Bug Fixes

• deps: update semantic-release monorepo (#180) (9f9fbdc)

5.0.5 (2022-11-11)

Bug Fixes

• deps: update dependency semantic-release to v19 [security] (#192) (1bcca71)

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

5.0.1 (2021-09-09)

Bug Fixes

• deps: Correct peer dependency spire v5.0 (07464a0)

5.0.0 (2021-09-09)

chore

• deps: Raise node engine to >=12.20 (3916dd8)

BREAKING CHANGES

• deps: Needs at least node v12.20 to work

4.1.0 (2021-05-22)

Note: Version bump only for package spire-plugin-semantic-release

4.0.1 (2021-05-21)

Bug Fixes

• config: Require peer spire v4.0.0 (e51b22a)

4.0.0 (2021-05-21)

Note: Version bump only for package spire-plugin-semantic-release

3.2.3 (2021-05-21)

Reverts

• Revert "fix(semantic-release):Add main to allowed branch" (0061f3e)

3.2.2 (2020-12-03)

Bug Fixes

• deps: update dependency execa to v5 (21d7222)

3.0.2 (2020-08-07)

Bug Fixes

• Fix peer dependency for all plugins (938d5b9)

3.0.0 (2020-07-28)

Note: Version bump only for package spire-plugin-semantic-release

2.1.5 (2020-05-12)

Bug Fixes

• semantic-release: Move provider logic from setup to run (dba578a)

2.1.4 (2020-05-05)

Bug Fixes

• Fix detection of git provider (6061ef2)

2.1.3 (2020-05-05)

Bug Fixes

• semantic-release: Correctly await results of async functions (f467fe6)

2.1.1 (2020-04-30)

Bug Fixes

• semantic-release: Set correct peerDependency (ee316f6)

2.1.0 (2020-04-30)

Features

• semantic-release: Detect provider if set to auto (df9b216)

2.0.2 (2020-04-30)

Bug Fixes

• Upgrade peer dependency of all packages (0988433)

2.0.1 (2020-04-30)

Note: Version bump only for package spire-plugin-semantic-release

2.0.0 (2020-04-30)

Bug Fixes

• Use custom resolve method to resolve from current dir and spire install dir (28743c1)
• deps: update dependency execa to v3 (#31) (29ce452)
• deps: update dependency execa to v4 (ea9e466)
• deps: update semantic-release monorepo (b8c2f69)

chore

• require Node.js >=10.18 (0a2f755)

Features

• semantic-release: Allow different providers(github, gitlab, none) to be specified in config (061ab3e)

BREAKING CHANGES

• semantic-release: Default config does not include github steps
• semantic-release: There are 3 default configs now (default, github, gitlab) and they all moved into the config subfolder
• Require Node.js >= 10.18

1.8.2 (2019-11-15)

Bug Fixes

• Ensure to set preferLocal to true to pick up local installed binaries (aeb8df7)

1.8.0 (2019-11-13)

Bug Fixes

• deps: upgrade execa to v2.0.2 (fbcfc9f)
• deps: upgrade semantic-release dependencies (d78d52c)

1.7.3 (2019-06-07)

Bug Fixes

• rework commands api (b9657e2)

1.7.2 (2019-05-24)

Bug Fixes

• cli: fail on unknown command (98c6149), closes #6 #5

1.7.1 (2019-04-23)

Note: Version bump only for package spire-plugin-semantic-release

1.7.0 (2019-04-03)

Features

• introduce lerna-release plugin (1e46acf)

1.4.1 (2019-03-29)

Bug Fixes

• resolve config from project root with proper error reporting (726fa49)

1.4.0 (2019-03-29)

Features

• introduce spire-plugin-yarn (252a924)

1.3.0 (2019-02-28)

Features

• initial commit (cf8cad0)