From 5f38d38c3d0dd27dd53fe57a00739973b362583e Mon Sep 17 00:00:00 2001 From: Roman Schwarz Date: Fri, 7 Jun 2024 10:34:00 +0200 Subject: [PATCH] Set up CI and releasing (#1) * Add GitHub release configuration * Add CI workflow * Use terraform-docs * Use simpler release labels --- .github/release.yaml | 22 ++++++++++++++++++++++ .github/workflows/module-ci.yaml | 5 +++++ README.md | 32 ++++++++++++++++++++++++++++++++ examples/main/usage.tf | 3 +++ terraform-docs.yaml | 29 +++++++++++++++++++++++++++++ 5 files changed, 91 insertions(+) create mode 100644 .github/release.yaml create mode 100644 .github/workflows/module-ci.yaml create mode 100644 examples/main/usage.tf create mode 100644 terraform-docs.yaml diff --git a/.github/release.yaml b/.github/release.yaml new file mode 100644 index 0000000..1b3755e --- /dev/null +++ b/.github/release.yaml @@ -0,0 +1,22 @@ +changelog: + exclude: + labels: + - ignore-for-release + authors: + - cloudeteerbot + categories: + - title: Breaking Changes 💥 + labels: + - breaking + - title: New Features ✨ + labels: + - feature + - title: Bug Fixes 🐛 + labels: + - fix + - title: Documentation Changes 📝 + labels: + - documentation + - title: Other Changes + labels: + - "*" diff --git a/.github/workflows/module-ci.yaml b/.github/workflows/module-ci.yaml new file mode 100644 index 0000000..0d5a2cb --- /dev/null +++ b/.github/workflows/module-ci.yaml @@ -0,0 +1,5 @@ +name: module-ci +on: [push, pull_request] +jobs: + module-ci: + uses: cloudeteer/terraform-governance/.github/workflows/module-ci.yaml@349-epic-the-revival-of-tf-mod-lib diff --git a/README.md b/README.md index 9b1d08e..418e40c 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,35 @@ # terraform-azurerm-helloworld Terraform "Hello World!" Module + + +## Usage + +```hcl +module "helloworld" { + source = "cloudeteer/helloworld/azurerm" +} +``` + +## Providers + +No providers. + +## Modules + +No modules. + +## Resources + +No resources. + +## Inputs + +No inputs. + +## Outputs + +| Name | Description | +|------|-------------| +| hello\_world | n/a | + \ No newline at end of file diff --git a/examples/main/usage.tf b/examples/main/usage.tf new file mode 100644 index 0000000..44a7e99 --- /dev/null +++ b/examples/main/usage.tf @@ -0,0 +1,3 @@ +module "helloworld" { + source = "cloudeteer/helloworld/azurerm" +} diff --git a/terraform-docs.yaml b/terraform-docs.yaml new file mode 100644 index 0000000..7fb1fc1 --- /dev/null +++ b/terraform-docs.yaml @@ -0,0 +1,29 @@ +formatter: markdown + +settings: + anchor: false + lockfile: false + +output: + file: README.md + +sort: + enabled: true + by: name + +content: |- + ## Usage + + ```hcl + {{ include "examples/main/usage.tf" }} + ``` + + {{ .Providers }} + + {{ .Modules }} + + {{ .Resources }} + + {{ .Inputs }} + + {{ .Outputs }}