Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs fixup #18

Merged
merged 2 commits into from
Oct 28, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .bumpversion.cfg
Original file line number Diff line number Diff line change
@@ -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
Expand Down
22 changes: 22 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,28 @@ 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-config-aggregator/compare/1.0.2...1.0.3)

**Summary**:

* Pins tfdocs-awk version
* Updates documentation generation make targets
* Adds documentation to the test modules

### 1.0.2

**Released**: 2019.10.17

**Commit Delta**: [Change from 1.0.2 release](https://github.com/plus3it/terraform-aws-tardigrade-config-aggregator/compare/1.0.1...1.0.2)

**Summary**:

* Adds ability to auto approve and merge Dependabot PRs

### 1.0.1

**Released**: 2019.10.03
Expand Down
21 changes: 9 additions & 12 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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-config-aggregator/tests
Expand Down
3 changes: 3 additions & 0 deletions tests/create_config_aggregator/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Create Config Aggregator Test


1 change: 1 addition & 0 deletions tests/create_config_aggregator/_docs/MAIN.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Create Config Aggregator Test
3 changes: 3 additions & 0 deletions tests/create_config_auth/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Create Config Auth Test


1 change: 1 addition & 0 deletions tests/create_config_auth/_docs/MAIN.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Create Config Auth Test
3 changes: 3 additions & 0 deletions tests/no_create/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Don't Create Resources Test


1 change: 1 addition & 0 deletions tests/no_create/_docs/MAIN.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Don't Create Resources Test