@acai_consulting/github-workflow-config-semantic-release/README.md

semantic-release shareable config to create release of Terraform Modules.

# @acai-consulting/github-workflow-config-semantic-release

[**semantic-release**](https://github.com/semantic-release/semantic-release) shareable config to create release of Terraform Modules with [Github Actions](https://github.com/acai-consulting/github-terraform-workflows.git).

## Plugins

This shareable configuration use 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 @acai-consulting/github-workflow-config-semantic-release
```

## 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": "@acai-consulting/github-workflow-config-semantic-release"
}
```

## Configuration

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