From 80dd4858f511832743194ddeeca559592f862517 Mon Sep 17 00:00:00 2001 From: userhas404d <29389186+userhas404d@users.noreply.github.com> Date: Mon, 28 Oct 2019 11:16:16 -0400 Subject: [PATCH 1/2] Pins tfdocs-awk version - Updates documentation generation make targets - Adds documentation to the test modules - Minor changelog fixup --- CHANGELOG.md | 15 ++++++++++++++- Makefile | 21 +++++++++------------ tests/create_sg/README.md | 3 +++ tests/create_sg/_docs/MAIN.md | 1 + tests/no_create_sg/README.md | 3 +++ tests/no_create_sg/_docs/MAIN.md | 1 + tests/use_all_variables/README.md | 3 +++ tests/use_all_variables/_docs/MAIN.md | 1 + 8 files changed, 35 insertions(+), 13 deletions(-) create mode 100644 tests/create_sg/README.md create mode 100644 tests/create_sg/_docs/MAIN.md create mode 100644 tests/no_create_sg/README.md create mode 100644 tests/no_create_sg/_docs/MAIN.md create mode 100644 tests/use_all_variables/README.md create mode 100644 tests/use_all_variables/_docs/MAIN.md diff --git a/CHANGELOG.md b/CHANGELOG.md index f149a50..da14997 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,11 +4,24 @@ 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.3 + +**Released**: 2019.10.28 + +**Commit Delta**: [Change from 1.0.2 release](https://github.com/plus3it/terraform-aws-tardigrade-security-group/compare/1.0.2...1.0.3) + +**Summary**: + +* Pins tfdocs-awk version +* Updates documentation generation make targets +* Adds documentation to the test modules +* Minor Changelog fix + ### 1.0.2 **Released**: 2019.10.02 -**Commit Delta**: [Change from 1.0.0 release](https://github.com/plus3it/terraform-aws-tardigrade-security-group/compare/1.0.1...1.0.2) +**Commit Delta**: [Change from 1.0.1 release](https://github.com/plus3it/terraform-aws-tardigrade-security-group/compare/1.0.1...1.0.2) **Summary**: diff --git a/Makefile b/Makefile index 7947d76..f71dc6c 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-security-group/tests diff --git a/tests/create_sg/README.md b/tests/create_sg/README.md new file mode 100644 index 0000000..ee7c6ce --- /dev/null +++ b/tests/create_sg/README.md @@ -0,0 +1,3 @@ +# Create SG Test + + diff --git a/tests/create_sg/_docs/MAIN.md b/tests/create_sg/_docs/MAIN.md new file mode 100644 index 0000000..bb367fe --- /dev/null +++ b/tests/create_sg/_docs/MAIN.md @@ -0,0 +1 @@ +# Create SG Test diff --git a/tests/no_create_sg/README.md b/tests/no_create_sg/README.md new file mode 100644 index 0000000..2e96913 --- /dev/null +++ b/tests/no_create_sg/README.md @@ -0,0 +1,3 @@ +# Don't Create SG Test + + diff --git a/tests/no_create_sg/_docs/MAIN.md b/tests/no_create_sg/_docs/MAIN.md new file mode 100644 index 0000000..166ec47 --- /dev/null +++ b/tests/no_create_sg/_docs/MAIN.md @@ -0,0 +1 @@ +# Don't Create SG Test diff --git a/tests/use_all_variables/README.md b/tests/use_all_variables/README.md new file mode 100644 index 0000000..5452190 --- /dev/null +++ b/tests/use_all_variables/README.md @@ -0,0 +1,3 @@ +# Use All Variables Test + + diff --git a/tests/use_all_variables/_docs/MAIN.md b/tests/use_all_variables/_docs/MAIN.md new file mode 100644 index 0000000..6961df0 --- /dev/null +++ b/tests/use_all_variables/_docs/MAIN.md @@ -0,0 +1 @@ +# Use All Variables Test From 34446d3757c615d9cdde47e2e6d8dee39d431ec0 Mon Sep 17 00:00:00 2001 From: userhas404d <29389186+userhas404d@users.noreply.github.com> Date: Mon, 28 Oct 2019 11:16:53 -0400 Subject: [PATCH 2/2] Bumps version to 1.0.3 --- .bumpversion.cfg | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.bumpversion.cfg b/.bumpversion.cfg index e318d2f..647c5f2 100644 --- a/.bumpversion.cfg +++ b/.bumpversion.cfg @@ -1,5 +1,5 @@ [bumpversion] -current_version = 1.0.2 +current_version = 1.0.3 commit = True message = Bumps version to {new_version} tag = False