diff --git a/.bumpversion.cfg b/.bumpversion.cfg index f1e4ea7..e318d2f 100644 --- a/.bumpversion.cfg +++ b/.bumpversion.cfg @@ -1,5 +1,5 @@ [bumpversion] -current_version = 1.0.1 +current_version = 1.0.2 commit = True message = Bumps version to {new_version} tag = False diff --git a/CHANGELOG.md b/CHANGELOG.md index 83c5c91..2644949 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.2 + +**Released**: 2019.10.28 + +**Commit Delta**: [Change from 1.0.1 release](https://github.com/plus3it/terraform-aws-tardigrade-ram-principal-association/compare/1.0.1...1.0.2) + +**Summary**: + +* Pins tfdocs-awk version +* Updates documentation generation make targets +* Adds documentation to the test modules + ### 1.0.1 **Released**: 2019.10.03 diff --git a/Makefile b/Makefile index c898a49..1925a9e 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-ram-principal-association/tests diff --git a/tests/create_ram/README.md b/tests/create_ram/README.md new file mode 100644 index 0000000..731d01f --- /dev/null +++ b/tests/create_ram/README.md @@ -0,0 +1,3 @@ +# Create RAM Test + + diff --git a/tests/create_ram/_docs/MAIN.md b/tests/create_ram/_docs/MAIN.md new file mode 100644 index 0000000..abad149 --- /dev/null +++ b/tests/create_ram/_docs/MAIN.md @@ -0,0 +1 @@ +# Create RAM Test diff --git a/tests/create_ram/prereq/README.md b/tests/create_ram/prereq/README.md new file mode 100644 index 0000000..21f7aeb --- /dev/null +++ b/tests/create_ram/prereq/README.md @@ -0,0 +1,8 @@ +# PreReq + +## Outputs + +| Name | Description | +|------|-------------| +| ram\_arn | | + diff --git a/tests/create_ram/prereq/_docs/MAIN.md b/tests/create_ram/prereq/_docs/MAIN.md new file mode 100644 index 0000000..fa706e4 --- /dev/null +++ b/tests/create_ram/prereq/_docs/MAIN.md @@ -0,0 +1 @@ +# PreReq 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