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

1.5.5 (2023-12-22)

chore

• deps: Update and reconfigure needed packages (#46) (e25e6e7)

ci

• update release workflows to node version 18 (#52) (dc4f4b8)

1.5.4 (2022-08-19)

chore

• deps: bump node-fetch from 2.6.5 to 2.6.7 (#37) (153934b)
• deps: bump semver-regex from 3.1.3 to 3.1.4 (#38) (78ae149)

1.5.3 (2022-08-19)

chore

• deps: bump minimist from 1.2.5 to 1.2.6 (#36) (8387054)

1.5.2 (2022-08-19)

fix

• package.json & package-lock.json to reduce vulnerabilities (#35) (e678692)

1.5.1 (2021-09-23)

chore

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

1.5.0 (2021-09-23)

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)

1.4.0 (2019-11-26)

Features

• backwards compatibility for commits without keyword (90deac9)

1.3.7 (2019-11-03)

Documentation

• install: update install notes (93d849d)

1.3.6 (2019-11-03)

Documentation

• instructions: update configuration instructions (3c8b0fd)

1.3.5 (2019-11-03)

Code Refactoring

• use object literal to transform commit type (3b7ff9a)

1.3.4 (2019-10-09)

Bug Fixes

• package.json & package-lock.json to reduce vulnerabilities (b6c8ad193f17679d4307da4c63b0026b71ea6c91)

1.3.3 (2019-10-05)

Documentation

• readme: update description, fix typos (92f9b9fcb26d5747f728c267cb35c3ec3eeef435)

1.3.2 (2019-10-05)

Documentation

• description: update descriptions in package.json (3521a76f84c61734a9172d1ca8032214b73cd54b)

1.3.1 (2019-10-05)

Documentation

• readme: update descriptions, fix links (7a54dcc529c107eda3388089e649254c494b9017)

1.3.0 (2019-10-05)

Features

• type: add chore type (3aaa92d076da1aa4a1a8c6b177c50a338ae6466e)

1.2.1 (2019-10-04)

Bug Fixes

• manifest: add plugins.json to a bundle (22c1a28db3a189d06a354c621e5b24c6df94f38c)

1.2.0 (2019-10-04)

Features

• release: add custom release-notes generator (ed4a8e567ec57cfed456be9af968d9918d6fe522)

1.1.10 (2019-09-29)

1.1.9 (2019-09-29)

1.1.8 (2019-09-29)

1.1.7 (2019-09-29)

1.1.6 (2019-09-29)

1.1.5 (2019-09-26)

1.1.4 (2019-09-26)

1.1.3 (2019-09-26)

Bug Fixes

• commit-message: fix commit message: skip-ci (cc7c983)

1.1.2 (2019-09-26)

Bug Fixes

• commit-message: use release keyword (a33577a)

1.1.1 (2019-09-26)

Bug Fixes

• release: change release message (0109020)

1.1.0 (2019-09-26)

Features

• file-format: use json file instead of yaml (acd3f8d)

1.0.1 (2019-09-26)

Bug Fixes

• releaserc: remove unused fields (24606ed)

1.0.0 (2019-09-26)

Features

• init: initial commit (6fbca52)