fix(docs): add main.tf

lablabs · Mar 18, 2024 · 78b0f60 · 78b0f60
1 parent 94675e4
commit 78b0f60
Show file tree

Hide file tree

Showing 6 changed files with 198 additions and 13 deletions.
diff --git a/.gitignore b/.gitignore
@@ -32,5 +32,3 @@ override.tf.json
 # Ignore CLI configuration files
 .terraformrc
 terraform.rc
-
-.terraform.lock.hcl
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -12,17 +12,17 @@ repos:
   - repo: https://github.com/antonbabenko/pre-commit-terraform
     rev: v1.88.2
     hooks:
-    - id: terraform_fmt
-    - id: terraform_tflint
-      args:
-        - --args=--config=__GIT_WORKING_DIR__/.tflint.hcl
-    - id: terraform_validate
-    - id: terraform_checkov
-      args:
-        - '--args=--skip-check CKV_TF_1' #CKV_TF_1: "Ensure Terraform module sources use a commit hash"
-    - id: terraform_docs
-      args:
-        - '--args=--config=.terraform-docs.yml'
+      - id: terraform_fmt
+      - id: terraform_tflint
+        args:
+          - --args=--config=__GIT_WORKING_DIR__/.tflint.hcl
+      - id: terraform_validate
+      - id: terraform_checkov
+        args:
+          - '--args=--skip-check CKV_TF_1' #CKV_TF_1: "Ensure Terraform module sources use a commit hash"
+      - id: terraform_docs
+        args:
+          - '--args=--config=.terraform-docs.yml'
 
   - repo: https://github.com/Yelp/detect-secrets
     rev: v1.4.0

diff --git a/.terraform.lock.hcl b/.terraform.lock.hcl
diff --git a/README.md b/README.md
@@ -1,4 +1,9 @@
+# AWS EKS Universal Addon Terraform module
 
+A Terraform module to deploy the universal addon on Amazon EKS cluster.
+
+[![Terraform validate](https://github.com/lablabs/terraform-aws-eks-universal-addon/actions/workflows/validate.yaml/badge.svg)](https://github.com/lablabs/terraform-aws-eks-universal-addon/actions/workflows/validate.yaml)
+[![pre-commit](https://github.com/lablabs/terraform-aws-eks-universal-addon/actions/workflows/pre-commit.yml/badge.svg)](https://github.com/lablabs/terraform-aws-eks-universal-addon/actions/workflows/pre-commit.yml)
 
 ---
 

diff --git a/examples/basic/.terraform.lock.hcl b/examples/basic/.terraform.lock.hcl
diff --git a/main.tf b/main.tf
@@ -0,0 +1,8 @@
+/**
+ * # AWS EKS Universal Addon Terraform module
+ *
+ * A Terraform module to deploy the universal addon on Amazon EKS cluster.
+ *
+ * [![Terraform validate](https://github.com/lablabs/terraform-aws-eks-universal-addon/actions/workflows/validate.yaml/badge.svg)](https://github.com/lablabs/terraform-aws-eks-universal-addon/actions/workflows/validate.yaml)
+ * [![pre-commit](https://github.com/lablabs/terraform-aws-eks-universal-addon/actions/workflows/pre-commit.yml/badge.svg)](https://github.com/lablabs/terraform-aws-eks-universal-addon/actions/workflows/pre-commit.yml)
+ */