Skip to content

Commit

Permalink
Set up CI and releasing (#1)
Browse files Browse the repository at this point in the history
* Add GitHub release configuration

* Add CI workflow

* Use terraform-docs

* Use simpler release labels
  • Loading branch information
rswrz authored Jun 7, 2024
1 parent d4dc96e commit 5f38d38
Show file tree
Hide file tree
Showing 5 changed files with 91 additions and 0 deletions.
22 changes: 22 additions & 0 deletions .github/release.yaml
Original file line number Diff line number Diff line change
@@ -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:
- "*"
5 changes: 5 additions & 0 deletions .github/workflows/module-ci.yaml
Original file line number Diff line number Diff line change
@@ -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
32 changes: 32 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,35 @@
# terraform-azurerm-helloworld

Terraform "Hello World!" Module

<!-- BEGIN_TF_DOCS -->
## 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 |
<!-- END_TF_DOCS -->
3 changes: 3 additions & 0 deletions examples/main/usage.tf
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module "helloworld" {
source = "cloudeteer/helloworld/azurerm"
}
29 changes: 29 additions & 0 deletions terraform-docs.yaml
Original file line number Diff line number Diff line change
@@ -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 }}

0 comments on commit 5f38d38

Please sign in to comment.