Test GHA

.github/workflows/branch.yml

@@ -17,7 +17,10 @@ on:
  - 'test/**'
  - 'README.md'
 
-permissions: {}
+permissions:
+ contents: write
+ id-token: write
+ pull-requests: write
 
 jobs:
  component:

.gitignore

@@ -58,6 +58,10 @@ aws-assumed-role/
 # deps
 Brewfile.lock.json
 
+# docs targets
+docs/terraform.md
+docs/targets.md
+
 # custom direnv and .env
 .env*
 

Makefile

@@ -2,8 +2,6 @@
 
 all: init readme
 
-readme: readme/build
-
 test::
  @echo "🚀 Starting tests..."
  ./test/run.sh

README.yaml

@@ -7,8 +7,21 @@ github_repo: "cloudposse-terraform-components/template"
 description: |-
  Description of this component
 
+usage: |-
+ **Stack Level**: Regional
+
+ Here's an example snippet for how to use this component.
+
+ ```yaml
+ components:
+ terraform:
+ foo:
+ vars:
+ enabled: true
+ ```
+
 include:
- - "src/README.md"
+ - "docs/terraform.md"
 
 tags:
  - terraform