docs: added README

quixoticmonk · Apr 23, 2024 · 25a4c7f · 25a4c7f
1 parent 228cb35
commit 25a4c7f
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/.github/workflows/deploy_dev.yaml b/.github/workflows/deploy_dev.yaml
@@ -2,9 +2,13 @@
 name: Dev deployment
 on:
     pull_request:
+        paths-ignore:
+            - README.md
         branches:
             main
     push:
+        paths-ignore:
+            - README.md
         branches:
             main
     workflow_dispatch:

diff --git a/README.md b/README.md
@@ -0,0 +1,8 @@
+# Sample Github actions based workflow for Terraform based infrastructure.
+
+The workflows referenced in the repo utilize the following capabilities:
+- Target AWS account
+- GitHub Environments
+- GitHub's OIDC based IAM Role assumption
+- Action marketplace for some of the common actions.
+- Terraform AWS provider