From 60f93984a654136d1deb904a662de7efce79e312 Mon Sep 17 00:00:00 2001 From: Joseph Page Date: Tue, 26 Sep 2023 12:02:14 +0200 Subject: [PATCH] ci: better readability for changelog --- .github/workflows/release-please.yml | 11 +++++++++++ README.md | 5 ++++- 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/.github/workflows/release-please.yml b/.github/workflows/release-please.yml index a6a6c24..24316d3 100644 --- a/.github/workflows/release-please.yml +++ b/.github/workflows/release-please.yml @@ -17,3 +17,14 @@ jobs: with: release-type: terraform-module package-name: release-please-action + changelog-types: | + [ + {"type":"feat","section":"✨ New features","hidden":false}, + {"type":"fix","section":"🐛 Bug fixes","hidden":false}, + {"type":"chore","section":"👷 Other changes","hidden":false}, + {"type":"ci","section":"👷 Other changes","hidden":false}, + {"type":"refacto","section":"👷 Other changes","hidden":false}, + {"type":"build","section":"👷 Other changes","hidden":false}, + {"type":"docs","section":"📚 Documentation","hidden":false} + ] + extra-files: README.md diff --git a/README.md b/README.md index c44e489..78af5d1 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,11 @@ An opinionated Terraform module to provision an application and database very ea ## Example usage + ```tf module "my_app" { source = "scalingo-community/app/scalingo" + version = "0.2.0" # Configure the name and the canonical domain of the application name = "my-app" @@ -28,10 +30,11 @@ module "my_app" { # Attach a free PostgreSQL database addons = [{ provider = "postgresql", plan = "postgresql-sandbox" }] - # Configure log drains + # Configure log drains, will be auto-configured for app and every addons log_drains = [{ type = "elk", url = "https://user:password@logstash.example.com" }] } ``` + ## Community