From a3136316a9f26c8f58c1e65a989b230bf1752801 Mon Sep 17 00:00:00 2001 From: userhas404d <29389186+userhas404d@users.noreply.github.com> Date: Mon, 28 Oct 2019 10:50:38 -0400 Subject: [PATCH 1/2] Pins tfdocs-awk version - Updates documentation generation make targets - Adds documentation to the test modules --- CHANGELOG.md | 12 ++++++++++++ Makefile | 21 +++++++++------------ tests/baseline/README.md | 3 +++ tests/baseline/_docs/MAIN.md | 1 + tests/no_create/README.md | 3 +++ tests/no_create/_docs/MAIN.md | 1 + tests/premade_policy/README.md | 3 +++ tests/premade_policy/_docs/MAIN.md | 1 + tests/premade_policy/prereq/README.md | 9 +++++++++ tests/premade_policy/prereq/_docs/MAIN.md | 1 + 10 files changed, 43 insertions(+), 12 deletions(-) create mode 100644 tests/baseline/README.md create mode 100644 tests/baseline/_docs/MAIN.md create mode 100644 tests/no_create/README.md create mode 100644 tests/no_create/_docs/MAIN.md create mode 100644 tests/premade_policy/README.md create mode 100644 tests/premade_policy/_docs/MAIN.md create mode 100644 tests/premade_policy/prereq/README.md create mode 100644 tests/premade_policy/prereq/_docs/MAIN.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 09f9f1d..b4e1cb1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,18 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](http://semver.org/). +### 1.0.6 + +**Commit Delta**: [Change from 1.0.5 release](https://github.com/plus3it/terraform-aws-tardigrade-inspector/compare/1.0.5...1.0.6) + +**Released**: 2019.10.28 + +**Summary**: + +* Pins tfdocs-awk version +* Updates documentation generation make targets +* Adds documentation to the test modules + ### 1.0.5 **Commit Delta**: [Change from 1.0.4 release](https://github.com/plus3it/terraform-aws-tardigrade-inspector/compare/1.0.4...1.0.5) diff --git a/Makefile b/Makefile index 58c83ff..2736452 100644 --- a/Makefile +++ b/Makefile @@ -101,22 +101,19 @@ json/format: | guard/program/jq @ echo "[$@]: Successfully formatted JSON files!" tfdocs-awk/install: $(BIN_DIR) -tfdocs-awk/install: ARCHIVE := https://github.com/plus3it/tfdocs-awk/archive/master.tar.gz +tfdocs-awk/install: ARCHIVE := https://github.com/plus3it/tfdocs-awk/archive/0.0.0.tar.gz tfdocs-awk/install: $(CURL) $(ARCHIVE) | tar -C $(BIN_DIR) --strip-components=1 --wildcards '*.sh' --wildcards '*.awk' -xzvf - -docs/%: README_PARTS := _docs/MAIN.md <(echo) <($(BIN_DIR)/terraform-docs.sh markdown table .) -docs/%: README_FILE ?= README.md - -docs/lint: | guard/program/terraform-docs tfdocs-awk/install - @ echo "[$@]: Linting documentation files.." - diff $(README_FILE) <(cat $(README_PARTS)) - @ echo "[$@]: Documentation files PASSED lint test!" - -docs/generate: | guard/program/terraform-docs tfdocs-awk/install +docs/generate: | tfdocs-awk/install guard/program/terraform-docs @ echo "[$@]: Creating documentation files.." - cat $(README_PARTS) > $(README_FILE) - @ echo "[$@]: Documentation files creation complete!" + @ bash -eu -o pipefail autodocs.sh -g + @ echo "[$@]: Documentation generated!" + +docs/lint: | tfdocs-awk/install guard/program/terraform-docs + @ echo "[$@] Linting documentation files.." + @ bash -eu -o pipefail autodocs.sh -l + @ echo "[$@] documentation linting complete!" terratest/install: | guard/program/go cd tests && go mod init terraform-aws-tardigrade-inspector/tests diff --git a/tests/baseline/README.md b/tests/baseline/README.md new file mode 100644 index 0000000..8e9a48c --- /dev/null +++ b/tests/baseline/README.md @@ -0,0 +1,3 @@ +# Baseline Test + + diff --git a/tests/baseline/_docs/MAIN.md b/tests/baseline/_docs/MAIN.md new file mode 100644 index 0000000..947ca2b --- /dev/null +++ b/tests/baseline/_docs/MAIN.md @@ -0,0 +1 @@ +# Baseline Test diff --git a/tests/no_create/README.md b/tests/no_create/README.md new file mode 100644 index 0000000..d7d7fa7 --- /dev/null +++ b/tests/no_create/README.md @@ -0,0 +1,3 @@ +# Don't Create Resources Test + + diff --git a/tests/no_create/_docs/MAIN.md b/tests/no_create/_docs/MAIN.md new file mode 100644 index 0000000..2d19323 --- /dev/null +++ b/tests/no_create/_docs/MAIN.md @@ -0,0 +1 @@ +# Don't Create Resources Test diff --git a/tests/premade_policy/README.md b/tests/premade_policy/README.md new file mode 100644 index 0000000..74c9df4 --- /dev/null +++ b/tests/premade_policy/README.md @@ -0,0 +1,3 @@ +# Premade Policy Test + + diff --git a/tests/premade_policy/_docs/MAIN.md b/tests/premade_policy/_docs/MAIN.md new file mode 100644 index 0000000..b7b7674 --- /dev/null +++ b/tests/premade_policy/_docs/MAIN.md @@ -0,0 +1 @@ +# Premade Policy Test diff --git a/tests/premade_policy/prereq/README.md b/tests/premade_policy/prereq/README.md new file mode 100644 index 0000000..48bff91 --- /dev/null +++ b/tests/premade_policy/prereq/README.md @@ -0,0 +1,9 @@ +# Prereq + +## Outputs + +| Name | Description | +|------|-------------| +| iam\_role\_arn | | +| random\_name | | + diff --git a/tests/premade_policy/prereq/_docs/MAIN.md b/tests/premade_policy/prereq/_docs/MAIN.md new file mode 100644 index 0000000..9ec008c --- /dev/null +++ b/tests/premade_policy/prereq/_docs/MAIN.md @@ -0,0 +1 @@ +# Prereq From a04ed6ca03e0eb8d21819c73ee7d2e2646b88799 Mon Sep 17 00:00:00 2001 From: userhas404d <29389186+userhas404d@users.noreply.github.com> Date: Mon, 28 Oct 2019 10:51:10 -0400 Subject: [PATCH 2/2] =?UTF-8?q?Bump=20version:=201.0.5=20=E2=86=92=201.0.6?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .bumpversion.cfg | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.bumpversion.cfg b/.bumpversion.cfg index 76c8d7a..42140aa 100644 --- a/.bumpversion.cfg +++ b/.bumpversion.cfg @@ -1,5 +1,5 @@ [bumpversion] -current_version = 1.0.5 +current_version = 1.0.6 commit = True tag = False tag_name = {new_version}