@myparcel/semantic-release-config v5.1.0

MyParcel semantic-release configuration

This package contains multiple semantic-release presets. Additional information, documentation and guides on semantic-release can be found here

Usage

Install the package via yarn:

yarn add -D @myparcel/semantic-release-config

or npm:

npm i -D @myparcel/semantic-release-config

Create a semantic-release config file, if you haven't already, and add the following: (JavaScript example)

// release.config.js
module.exports = {
  extends: '@myparcel/semantic-release-config',
};

Or to use one of the other available presets:

// release.config.js
module.exports = {
  extends: '@myparcel/semantic-release-config/npm',
};

Configurations

Base config

@myparcel/semantic-release-config

This is the base configuration, which other ones should be based on. For more in-depth information on the configurations used with each plugin, see ./src/plugins/<plugin>.js.

• @semantic-release/commit-analyzer
• @semantic-release/release-notes-generator
• @semantic-release/changelog

NPM

@myparcel/semantic-release-config/npm

• Base plugins
• @semantic-release/npm

Composer

@myparcel/semantic-release-config/npm

• Base plugins
• @iwavesmedia/semantic-release-composer
• @semantic-release/npm

GitHub

@myparcel/semantic-release-config/github

• Base plugins
• @semantic-release/github
• @semantic-release/git

GitHub + Composer

@myparcel/semantic-release-config/github-composer

• Base plugins
• @iwavesmedia/semantic-release-composer
• @semantic-release/github
• @semantic-release/git

GitHub + NPM

@myparcel/semantic-release-config/github-npm

• Base plugins
• @semantic-release/npm
• @semantic-release/github
• @semantic-release/git

Debugging

You can run the following command in your project to test your semantic-release configuration:

npx semantic-release --dry-run --debug --branches=$(git branch --show-current)

Flags used:

• --dry-run: If this is on, no files are changed and nothing is actually "released".
• --debug: Enables debug mode to show a lot more output.
• --branches: Set the current branch as a release branch. If you don't pass this and are not on a release branch semantic-release will not process your commits.