Skip to content

jack0pan/semantic-release-npm-config

Repository files navigation

semantic-release-npm-config

standard-readme compliant Commitizen friendly

semantic-release shareable config to publish npm packages.

Table of Contents

Plugins

This shareable configuration use the following plugins:

Usage

Install

yarn add --dev semantic-release semantic-release-npm-config

Configuration

The shareable config can be configured in the release.config.js file:

module.exports = {
  extends: "semantic-release-npm-config",
}

Extension

See each plugin documentation for required installation and configuration steps.

With github

  1. install the github plugin:
yarn add --dev @semantic-release/github
  1. change release.config.js:
module.exports = {
  extends: "semantic-release-npm-config",
  plugins: ["@semantic-release/github"],
}

With gitlab

  1. install the gitlab plugin:
yarn add --dev @semantic-release/gitlab
  1. change release.config.js file:
module.exports = {
  extends: "semantic-release-npm-config",
  plugins: ["@semantic-release/gitlab"],
}

License

MIT