semantic-release-config

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

Commit message rules

| Commit message type | Semver | | ------------------- | ------ | | perf | patch | | refactor | patch | | fix | patch | | feat | minor | | BREAKING CHANGE | major |

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"
}

2. Create NPM token and add it into Github repository secret as NPM_TOKEN.

   Read more in documentation.

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

"publishConfig": {
    "access": "public"
  },

4. (optional) if you get SemanticReleaseError: Invalid npm token please create .npmrc in repository root, and add this:

registry=https://registry.npmjs.org/

5. (optional) Release is created from main branch. Please update .releaserc.json with preferred branch name:

{
  "extends": "@rdeak/semantic-release-config",
  "branches": ["main"]
}

Additional configurations

Release only

{
  "extends": "@rdeak/semantic-release-config/release-only",
  "branches": ["main"]
}

It creates just Github release with changelog and tag.

License

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