Skip to content

Commit 8cc7c36

Browse files
committed
skip: automated release process
1 parent ba27020 commit 8cc7c36

File tree

3 files changed

+18
-8
lines changed

3 files changed

+18
-8
lines changed

.github/meta.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
major_version: 1
2-
version: 1.0.3
2+
version: 1.0.4

Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
FROM derekrada/terraform-docs:v1.0.3
1+
FROM derekrada/terraform-docs:v1.0.4
22
COPY ./src/common.sh /common.sh
33
COPY ./src/docker-entrypoint.sh /docker-entrypoint.sh
44
COPY ./src/pre-release.sh /pre-release.sh

README.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# terraform-docs
22
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.
33
## Version
4-
v1.0.3
4+
v1.0.4
55

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

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

2222
- name: Render terraform docs inside the USAGE.md and push changes back to PR branch
23-
uses: Dirrk/[email protected].3
23+
uses: Dirrk/[email protected].4
2424
with:
2525
tf_docs_working_dir: .
2626
tf_docs_output_file: USAGE.md
@@ -30,6 +30,7 @@ jobs:
3030
| 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. |
3131
| --- |
3232

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

3536
# Configuration
@@ -115,26 +116,35 @@ jobs:
115116
## Simple / Single folder
116117
```
117118
- name: Generate TF Docs
118-
uses: Dirrk/[email protected].3
119+
uses: Dirrk/[email protected].4
119120
with:
120121
tf_docs_working_dir: .
121122
tf_docs_output_file: README.md
122123
```
123124
125+
## Multi folder
126+
```
127+
- name: Generate TF Docs
128+
uses: Dirrk/[email protected]
129+
with:
130+
tf_docs_working_dir: .,example1,example3/modules/test
131+
tf_docs_output_file: README.md
132+
```
133+
124134
## Use atlantis.yaml v3 to find all dirs
125135
```
126136
- name: Generate TF docs
127-
uses: Dirrk/[email protected].3
137+
uses: Dirrk/[email protected].4
128138
with:
129139
tf_docs_atlantis_file: atlantis.yaml
130140
```
131141
132142
## Find all .tf file folders under a given directory
133143
```yaml
134144
- name: Generate TF docs
135-
uses: Dirrk/[email protected].3
145+
uses: Dirrk/[email protected].4
136146
with:
137147
tf_docs_find_dir: examples/
138148
```
139149

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

0 commit comments

Comments
 (0)