Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mantoso/github-semantic-release-config

Semantic release config files for Mantoso projects.
https://github.com/mantoso/github-semantic-release-config

meta semantic-release workflow

Last synced: 2 days ago
JSON representation

Semantic release config files for Mantoso projects.

Awesome Lists containing this project

README

        

# @mantoso/github-semantic-release-config

[**semantic-release**](https://github.com/semantic-release/semantic-release) shareable config to create GitHub releases.

## Plugins

This shareable configuration uses the following plugins:

- [`@semantic-release/commit-analyzer`](https://github.com/semantic-release/commit-analyzer)
- [`@semantic-release/release-notes-generator`](https://github.com/semantic-release/release-notes-generator)
- [`@semantic-release/github`](https://github.com/semantic-release/github)
- [`@semantic-release/changelog`](https://github.com/semantic-release/changelog)
- [`@semantic-release/git`](https://github.com/semantic-release/git)

## Install

```bash
$ npm install --save-dev semantic-release @mantoso/github-semantic-release-config
```

## Usage

The shareable config can be configured in the [**semantic-release** configuration file](https://github.com/semantic-release/semantic-release/blob/master/docs/usage/configuration.md#configuration):

```json
{
"extends": "@mantoso/github-semantic-release-config"
}
```

## Configuration

See each [plugin](#plugins) documentation for required installation and configuration steps.