TMWaresemantic-release-npm-github-publish
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-releaseto scripts:
"scripts": {
"semantic-release": "semantic-release"
}- Install
semantic-release-npm-github-publish:
npm install --save-dev @tmware/semantic-release-npm-github-publish- Add
npx semantic-releaseto 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: "@tmware/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