Skip to content

Commit

Permalink
Merge pull request #16 from userhas404d/docs_fixup
Browse files Browse the repository at this point in the history
Docs fixup
  • Loading branch information
confusdcodr authored Oct 28, 2019
2 parents bddad43 + b4683ab commit e830725
Show file tree
Hide file tree
Showing 9 changed files with 39 additions and 13 deletions.
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.1
current_version = 1.0.2
commit = True
message = Bumps version to {new_version}
tag = False
Expand Down
12 changes: 12 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
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-ram-principal-association/tests
Expand Down
3 changes: 3 additions & 0 deletions tests/create_ram/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Create RAM Test


1 change: 1 addition & 0 deletions tests/create_ram/_docs/MAIN.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Create RAM Test
8 changes: 8 additions & 0 deletions tests/create_ram/prereq/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# PreReq

## Outputs

| Name | Description |
|------|-------------|
| ram\_arn | |

1 change: 1 addition & 0 deletions tests/create_ram/prereq/_docs/MAIN.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# PreReq
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

0 comments on commit e830725

Please sign in to comment.