Fix autodoc CI/CD Errors (#146)

* update gitignore * update autodocs * disable required module variables for azure
slalom · Nov 25, 2020 · 94cd6c9 · 94cd6c9
1 parent c0f9018
commit 94cd6c9
Show file tree

Hide file tree

Showing 28 changed files with 1,397 additions and 42 deletions.
diff --git a/.github/workflows/terraform-ci-cd.yml b/.github/workflows/terraform-ci-cd.yml
@@ -34,14 +34,14 @@ jobs:
           GO111MODULE="on" go get github.com/terraform-docs/[email protected]
           export PATH=$HOME/go/bin:$PATH
           pip3 install --pre slalom.dataops
-          s-infra check_tf_metadata ./catalog \
+          s-infra check_tf_metadata ./catalog/aws \
               --check_module_headers \
               --required_input_vars=[name_prefix,resource_tags,environment] \
               --required_output_vars=[summary] \
               --check_input_descriptions \
               --check_output_descriptions \
               --raise_error
-          s-infra check_tf_metadata ./components \
+          s-infra check_tf_metadata ./components/aws \
               --check_module_headers \
               --required_input_vars=[name_prefix,resource_tags,environment] \
               --required_output_vars=[] \

diff --git a/.gitignore b/.gitignore
@@ -26,21 +26,32 @@ plan.out.json
 !**/.secrets/*sample*
 !**/.secrets/*template*
 
-# .tfstate files
+# Terraform local state and lock files
 *.tfstate
 *.tfstate.*
+*.tfstate-*
+.terraform.lock.hcl
 
 # tfplan
 tfplan
 
 # .tfvars files
 *.tfvars
 
-# .vs files 
+# .vs files
 **/.vs/**
 
 # Other (Python)
 __pycache__
 .mypy_cache
 **.pyc
 .gitignore
+
+# Terraform executable
+
+terraform
+terraform.exe
+
+# Other
+
+.DS_Store
diff --git a/autodocs/README.md b/autodocs/README.md
@@ -2,8 +2,16 @@
 
 _These documents are published automatically to [infra.dataops.tk](https://infra.dataops.tk) using [Github Pages](https://help.github.com/en/github/working-with-github-pages) and [Jekyll](https://jekyllrb.com/docs/)._
 
+## Dependencies
+
+```bash
+pip3 install uio logless runnow
+brew install terraform-docs
+```
+
 ## Rebuilding Docs
 
+
 To rebuild or update all module README docs, run the following command on your dev machine:
 
 ```bash

diff --git a/autodocs/requirements.txt b/autodocs/requirements.txt
@@ -0,0 +1,3 @@
+logless
+runnow
+uio
diff --git a/catalog/README.md b/catalog/README.md
diff --git a/catalog/aws/bastion-host/README.md b/catalog/aws/bastion-host/README.md
diff --git a/catalog/aws/bastion-host/main.tf b/catalog/aws/bastion-host/main.tf
@@ -7,7 +7,7 @@
 * - Debugging network firewall and routing rules
 * - Debugging components which can only be run from whitelisted IP ranges
 * - Offloading heavy processing from the developer's local laptop
-* - Mitigating network relability issues when working from WiFi or home networks
+* - Mitigating network reliability issues when working from WiFi or home networks
 *
 */
 

diff --git a/catalog/aws/data-lake-users/README.md b/catalog/aws/data-lake-users/README.md
diff --git a/catalog/aws/ml-ops/README.md b/catalog/aws/ml-ops/README.md
diff --git a/catalog/aws/singer-taps/README.md b/catalog/aws/singer-taps/README.md
-Original file line number
+Diff line change
@@ -0,0 +1,3 @@
+    logless
+    runnow
+    uio