@viacomcbs-labs/semantic-release-npm-github-config

semantic-release-npm-github-config

Semantic-release shareable configuration for easy publishing to NPM Github Package Registry.

About

This sharable configuration conforms to Conventional Commits spec

Using plugins

• @semantic-release/commit-analyzer
  • Ensures that commits are conformed to the conventional commits specification
• @semantic-release/release-notes-generator
  • Generate changelog content with conventional-changelog
• @semantic-release/github
  • Publish a GitHub release and comment on released Pull Requests.

Install

npm i --save-dev semantic-release @viacomcbs-labs/semantic-release-npm-github-config

Usage in GitHub Action

Basic usage:

steps:
  - name: Checkout
    uses: actions/checkout@v2
  - name: Semantic Release
	  id: semantic
    uses: cycjimmy/semantic-release-action@v2
		extends: |
			@viacomcbs-labs/semantic-release-npm-github-config@v1.0.0
    env:
      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

The shareable config can be configured in the semantic-release configuration file.

Example of .releaserc.yaml:

extends: "@viacomcbs-labs/semantic-release-npm-github-config"
branch: master