1.0.4 • Published 3 months ago

@rdeak/semantic-release-config v1.0.4

Weekly downloads
-
License
MIT
Repository
github
Last release
3 months ago

semantic-release-config

npm version License: MIT

Configuration for semantic-release for GitHub with conventional commit messages, GitHub releases, changelog and npm publishing.

Commit message typeSemver
perfpatch
refactorpatch
fixpatch
featminor
BREAKING CHANGEmajor

Installation

npm install --save-dev semantic-release @rdeak/semantic-release-config

Usage

  1. Create .releaserc.json file in repository root, and add this into it:
{
  "extends": "@rdeak/semantic-release-config"
}
  1. Create NPM token and add it into Github repository secret as NPM_TOKEN.

    Read more in documentation.

  2. (optional) if you have scoped package add this into your package.json

"publishConfig": {
    "access": "public"
  },
  1. (optional) if you get SemanticReleaseError: Invalid npm token please create .npmrc in repository root, and add this:
registry=https://registry.npmjs.org/
  1. (optional) Release is created from main branch. Please update .releaserc.json with preferred branch name:
{
  "extends": "@rdeak/semantic-release-config",
  "branches": ["release"]
}

License

This project is licensed under the terms of the MIT license.