# semantic-release-npm-github-publish

<p>
  <a href="https://github.com/TMWare/semantic-release-npm-github-publish/actions" target="_blank">
    <img alt="Version" src="https://github.com/TMWare/semantic-release-npm-github-publish/workflows/Publish/badge.svg?branch=master">
  </a>
  <a href="https://www.npmjs.com/package/@tmware/semantic-release-npm-github-publish" target="_blank">
    <img alt="Version" src="https://img.shields.io/npm/v/@tmware/semantic-release-npm-github-publish.svg">
  </a>
  <a href="https://github.com/TMWare/semantic-release-npm-github-publish#readme" target="_blank">
    <img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" />
  </a>
  <a href="https://github.com/TMWare/semantic-release-npm-github-publish/graphs/commit-activity" target="_blank">
    <img alt="Maintenance" src="https://img.shields.io/badge/Maintained%3F-yes-green.svg" />
  </a>
  <a href="https://github.com/TMWare/semantic-release-npm-github-publish/blob/master/LICENSE" target="_blank">
    <img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-yellow.svg" />
  </a>
</p>

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

## About

> This [sharable configuration](https://github.com/semantic-release/semantic-release/blob/master/docs/extending/shareable-configurations-list.md) conforms to [angular standard](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular)

- Using [@semantic-release/commit-analyzer](https://github.com/semantic-release/commit-analyzer) ensures that commits are conformed to the [conventional commits specification](https://www.conventionalcommits.org/en/v1.0.0-beta.4/).
  - **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](https://npmjs.org).
- Bumps a version in package.json.
- Generates or updates a [changelog](https://github.com/semantic-release/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](https://help.github.com/en/articles/creating-a-template-repository) for creation of sharable semantic-release configurations.**

## Install

- Install `semantic-release`:

```sh
npm install --save-dev semantic-release
```

- Add `semantic-release` to scripts:

```json
"scripts": {
	"semantic-release": "semantic-release"
}
```

- Install `semantic-release-npm-github-publish`:

```sh
npm install --save-dev @tmware/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`:

```yaml
branch: master
ci: false
dryRun: false
debug: false
extends: "@tmware/semantic-release-npm-github-publish"
```

## Contributing

Contributions, issues and feature requests are welcome!<br />Feel free to check [issues page](https://github.com/TMWare/semantic-release-npm-github-publish/issues).

## Build with

- [Github actions](https://github.com/features/actions)
- [semantic-release](https://github.com/semantic-release/semantic-release)

---

_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_