Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/jortfal/semantic-release-terraform-config

semantic-release shareable config to create release of Terraform Modules
https://github.com/jortfal/semantic-release-terraform-config

automation conventional-changelog release semantic-release semantic-release-config semantic-releases terraform terraform-modules-pattern

Last synced: 3 months ago
JSON representation

semantic-release shareable config to create release of Terraform Modules

Host: GitHub
URL: https://github.com/jortfal/semantic-release-terraform-config
Owner: jortfal
License: apache-2.0
Created: 2021-04-17T18:45:00.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2024-06-01T16:35:45.000Z (7 months ago)
Last Synced: 2024-09-27T19:21:44.356Z (3 months ago)
Topics: automation, conventional-changelog, release, semantic-release, semantic-release-config, semantic-releases, terraform, terraform-modules-pattern
Language: JavaScript
Homepage: https://www.npmjs.com/package/@jortfal/semantic-release-terraform-config
Size: 253 KB
Stars: 1
Watchers: 3
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        # @jortfal/semantic-release-terraform-config

[**semantic-release**](https://github.com/semantic-release/semantic-release) shareable config to create release of [Terraform](https://www.terraform.io/) Modules

![GitHub release (latest by date)](https://img.shields.io/github/v/release/jortfal/semantic-release-terraform-config)

![GitHub Release Date](https://img.shields.io/github/release-date/jortfal/semantic-release-terraform-config)

![GitHub license](https://img.shields.io/github/license/jortfal/semantic-release-terraform-config)

![Maintenance](https://img.shields.io/maintenance/yes/2024?color=green)

![Maintainer](https://img.shields.io/badge/maintainer-jortfal-green)

[![Build Status](https://github.com/jortfal/semantic-release-terraform-config/workflows/Test/badge.svg)](https://github.com/jortfal/semantic-release-terraform-config/actions?query=workflow%3ATest+branch%3Amaster) [![npm latest version](https://img.shields.io/npm/v/@jortfal/semantic-release-terraform-config/latest.svg)](https://www.npmjs.com/package/jortfal/semantic-release-terraform-config)

## 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)

- [`@google/semantic-release-replace-plugin`](https://github.com/google/semantic-release-replace-plugin)

- [`@semantic-release/git`](https://github.com/semantic-release/git)

## Install

```bash

$ npm install --save-dev semantic-release @jortfal/semantic-release-terraform-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": "@jortfal/semantic-release-terraform-config"

}

```

## Configuration

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

### Overwritten options

This following options are set by this shareable config:

| Option                                                                          | Value                                                                                                                          |

| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |

|[`replacements`](https://github.com/google/semantic-release-replace-plugin#usage)| {"files": ["locals.tf"], "from": "\"Terraform Module Version\" = \".*\"", "to": "\"Terraform Module Version\" = \"${nextRelease.version}\""} |

| [`assets`](https://github.com/semantic-release/git#assets) | ["locals.tf", "CHANGELOG.md"] |

| [`message`](https://github.com/semantic-release/git#message) | chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes} |

**NOTE**: other options use their default values. See each [plugin](#plugins) documentation for available options.