semantic-release-npm-github-publish

semantic-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-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

• Github actions
• semantic-release

---

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

Changelog

1.5.1 (2021-09-23)

chore

• add code scanning (#31) (1d956cb)

chore

• debug (8cd2bb1)
• debug (7122387)
• dependencies: fix vulnerabilities (#29) (c94afa0)
• deps-dev: bump semantic-release from 15.13.24 to 17.2.3 (7534da8)
• deps: bump glob-parent from 5.1.0 to 5.1.2 (#20) (785ef6d)
• deps: bump handlebars from 4.3.1 to 4.7.7 (e670a11)
• deps: bump lodash from 4.17.15 to 4.17.21 (#17) (ce63108)
• deps: bump node-fetch from 2.6.0 to 2.6.1 (#18) (8acf1f1)
• deps: bump normalize-url from 4.4.1 to 4.5.1 (#21) (c8ff856)
• deps: bump npm from 6.11.3 to 6.13.4 (4aee5ac)
• deps: bump path-parse from 1.0.6 to 1.0.7 (#28) (6675454)

docs

• install: update readme (4c174a5)

feat

• update transformer (da775d1)

fix

• package.json & package-lock.json to reduce vulnerabilities (8658905)
• package.json & package-lock.json to reduce vulnerabilities (#12) (ffd4a06)
• update config (aa6fd16)
• update dependencies (#30) (5498c03)