Skip to content

Commit

Permalink
skip: automated release process
Browse files Browse the repository at this point in the history
  • Loading branch information
Dirrk committed Jan 8, 2020
1 parent ba27020 commit 8cc7c36
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 8 deletions.
2 changes: 1 addition & 1 deletion .github/meta.yml
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
major_version: 1
version: 1.0.3
version: 1.0.4
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
FROM derekrada/terraform-docs:v1.0.3
FROM derekrada/terraform-docs:v1.0.4
COPY ./src/common.sh /common.sh
COPY ./src/docker-entrypoint.sh /docker-entrypoint.sh
COPY ./src/pre-release.sh /pre-release.sh
Expand Down
22 changes: 16 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# terraform-docs
A Github action for generating terraform module documentation using terraform-docs and gomplate. In addition to statically defined directory modules, this module can search specific sub folders or parse atlantis.yaml for module identification and doc generation. This action has the ability to auto commit docs to an open PR or after a push to a specific branch.
## Version
v1.0.3
v1.0.4

Supported and tested on terraform version 0.11+ & 0.12+ but may work for others.

Expand All @@ -20,7 +20,7 @@ jobs:
ref: ${{ github.event.pull_request.head.ref }}

- name: Render terraform docs inside the USAGE.md and push changes back to PR branch
uses: Dirrk/terraform-docs@v1.0.3
uses: Dirrk/terraform-docs@v1.0.4
with:
tf_docs_working_dir: .
tf_docs_output_file: USAGE.md
Expand All @@ -30,6 +30,7 @@ jobs:
| WARNING: If USAGE.md already exists it will need to be updated, with the block delimeters `<!--- BEGIN_TF_DOCS --->` and `<!--- END_TF_DOCS --->`, where the generated markdown will be injected. |
| --- |

### Renders
![Example](examples/example.png?raw=true "Example Output")

# Configuration
Expand Down Expand Up @@ -115,26 +116,35 @@ jobs:
## Simple / Single folder
```
- name: Generate TF Docs
uses: Dirrk/terraform-docs@v1.0.3
uses: Dirrk/terraform-docs@v1.0.4
with:
tf_docs_working_dir: .
tf_docs_output_file: README.md
```
## Multi folder
```
- name: Generate TF Docs
uses: Dirrk/terraform-docs@v1.0.4
with:
tf_docs_working_dir: .,example1,example3/modules/test
tf_docs_output_file: README.md
```
## Use atlantis.yaml v3 to find all dirs
```
- name: Generate TF docs
uses: Dirrk/terraform-docs@v1.0.3
uses: Dirrk/terraform-docs@v1.0.4
with:
tf_docs_atlantis_file: atlantis.yaml
```
## Find all .tf file folders under a given directory
```yaml
- name: Generate TF docs
uses: Dirrk/terraform-docs@v1.0.3
uses: Dirrk/terraform-docs@v1.0.4
with:
tf_docs_find_dir: examples/
```

Complete examples can be found [here](https://github.com/Dirrk/terraform-docs/tree/v1.0.3/examples)
Complete examples can be found [here](https://github.com/Dirrk/terraform-docs/tree/v1.0.4/examples)

0 comments on commit 8cc7c36

Please sign in to comment.