Skip to content

Github template for sharable configuration of semantic-release It helps with publishing to npm & Github generates changelog & release notes for any type of keywords.

License

Notifications You must be signed in to change notification settings

oleg-koval/semantic-release-npm-github-publish

Repository files navigation

semantic-release-npm-github-publish

Version Version Documentation Maintenance License: MIT

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

About

This sharable configuration conforms to angular standard

  • Using @semantic-release/commit-analyzer ensures that commits are conformed to the conventional commits specification.
    • PATCH version created if any of build, ci, chore, docs, refactor, style, test commit types pushed to master
    • MINOR version created if fix commit type pushed
    • MAJOR version created if feat commit type pushed
  • Publishes the new version to NPM.
  • Bumps a version in package.json.
  • Generates or updates a changelog file including all PATCH keywords (not included in default angular package).
  • Releases new release for NPM & Github.

This repository can be also used as a template repository for creation of sharable semantic-release configurations.

Install

  • Install semantic-release:
npm install --save-dev semantic-release
  • Add semantic-release to scripts:
"scripts": {
	"semantic-release": "semantic-release"
}
  • Install semantic-release-npm-github-publish:
npm install --save-dev semantic-release-npm-github-publish
  • Add npx semantic-release to a "Release" step of your CD setup

Usage

To use this sharable config, extend your semantic release configuration in .releaserc.yaml:

branch: master
ci: false
dryRun: false
debug: false
extends: "semantic-release-npm-github-publish"

Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page.

Build with


This README was generated with ❤️ by readme-md-generator