Test GHA (#3)

* Test GHA * Fix branch workflow * Update outputs.tf * Added workflows * Added workflows * Added workflows * chore: update README.md * Update main.tf * Update outputs.tf * Update Makefile * Added readme * chore: update README.md * Update outputs.tf * chore: update README.md * Update outputs.tf * chore: update README.md * Update outputs.tf * chore: update README.md * Update outputs.tf * chore: update README.md * Update outputs.tf * Update outputs.tf * chore: update README.md * Added labels to PR on commit * chore: update README.md * Update outputs.tf * chore: update README.md * Update outputs.tf * chore: update README.md * Update outputs.tf * chore: update README.md * Update outputs.tf * Update Makefile * chore: update README.md * Update README.yaml * chore: update README.md --------- Co-authored-by: readme-action 📖 <[email protected]>
cloudposse-terraform-components · Oct 10, 2024 · adc44fd · adc44fd
1 parent 72f1eb0
commit adc44fd
Show file tree

Hide file tree

Showing 7 changed files with 46 additions and 98 deletions.
diff --git a/.github/banner.png b/.github/banner.png
diff --git a/.github/workflows/branch.yml b/.github/workflows/branch.yml
@@ -17,7 +17,10 @@ on:
       - 'test/**'
       - 'README.md'
 
-permissions: {}
+permissions:
+  contents: write
+  id-token: write
+  pull-requests: write
 
 jobs:
   component:

diff --git a/.gitignore b/.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*
 

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

diff --git a/README.md b/README.md
diff --git a/README.yaml b/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