Skip to content

Commit 01ef659

Browse files
committed
update output-file according to new changes
Signed-off-by: Khosrow Moossavi <[email protected]>
1 parent 8990213 commit 01ef659

File tree

9 files changed

+34
-13
lines changed

9 files changed

+34
-13
lines changed

.github/workflows/ci.yml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ jobs:
2424
uses: ./
2525
with:
2626
working-dir: examples/tf11_basic
27+
output-file: USAGE.md
2728
template: |-
2829
<!-- BEGIN_TF_DOCS -->
2930
# Test tf11 basic
@@ -44,6 +45,7 @@ jobs:
4445
with:
4546
working-dir: examples/tf11_extra_args
4647
output-format: markdown document
48+
output-file: USAGE.md
4749
output-method: replace
4850
args: --sensitive=false --hide requirements --required=false
4951
indention: 3
@@ -52,41 +54,40 @@ jobs:
5254
uses: ./
5355
with:
5456
working-dir: examples/tf12_basic
55-
output-file: README.md
5657
indention: 3
5758

5859
- name: Should generate README.md for tf12_atlantis
5960
uses: ./
6061
with:
6162
atlantis-file: atlantis.yaml
62-
output-file: README.md
6363
args: --hide providers
6464
indention: 3
6565

66-
- name: Should generate README.md for tf12_find and its submodules
66+
- name: Should generate USAGE.md for tf12_find and its submodules
6767
uses: ./
6868
with:
6969
find-dir: examples/tf12_find
70+
output-file: USAGE.md
7071

71-
- name: Should generate README.md for tf12_find and its submodules recursively
72+
- name: Should generate USAGE.md for tf12_find and its submodules recursively
7273
uses: ./
7374
with:
75+
# TODO
7476
working-dir: examples/tf12_find
77+
output-file: USAGE.md
7578
recursive: true
7679
recursive-path: modules
7780

7881
- name: Should generate README.md for tf12_config
7982
uses: ./
8083
with:
8184
working-dir: examples/tf12_config
82-
output-file: README.md
8385
config-file: .terraform-docs.yml
8486

8587
- name: Should generate README.md for tf12_inject and push up all changes
8688
uses: ./
8789
with:
8890
working-dir: examples/tf12_inject
89-
output-file: README.md
9091
args: --sort-by required
9192
indention: 3
9293
git-push: true
@@ -97,7 +98,6 @@ jobs:
9798
uses: ./
9899
with:
99100
working-dir: examples/tf12_fail_diff
100-
output-file: README.md
101101
indention: 3
102102
fail-on-diff: true
103103

examples/tf11_basic/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
uses: ./
88
with:
99
working-dir: examples/tf11_basic
10+
output-file: USAGE.md
1011
template: |-
1112
<!-- BEGIN_TF_DOCS -->
1213
# Test tf11 basic

examples/tf11_extra_args/README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Test tf11 basic extra args
2+
3+
## Input
4+
5+
```yaml
6+
- name: Should generate USAGE.md for tf11_extra_args
7+
uses: ./
8+
with:
9+
working-dir: examples/tf11_extra_args
10+
output-format: markdown document
11+
output-file: USAGE.md
12+
output-method: replace
13+
args: --sensitive=false --hide requirements --required=false
14+
indention: 3
15+
```
16+
17+
## Verify
18+
19+
- Should not have requirements section
20+
- Should not have sensitive and required columns
21+
22+
## Output
23+
24+
See USAGE.md

examples/tf12_atlantis/README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@
77
uses: ./
88
with:
99
atlantis-file: atlantis.yaml
10-
output-file: README.md
1110
args: --hide providers
1211
indention: 3
1312
```

examples/tf12_basic/README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@
77
uses: ./
88
with:
99
working-dir: examples/tf12_basic
10-
output-file: README.md
1110
indention: 3
1211
```
1312

examples/tf12_config/README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@
77
uses: ./
88
with:
99
working-dir: examples/tf12_config
10-
output-file: README.md
1110
config-file: .terraform-docs.yml
1211
```
1312

examples/tf12_fail_diff/README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@
77
uses: ./
88
with:
99
working-dir: examples/tf12_fail_diff
10-
output-file: README.md
1110
indention: 3
1211
fail-on-diff: true
1312
```

examples/tf12_find/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,11 @@
33
## Input
44

55
```yaml
6-
- name: Should generate README.md for tf12_find and its submodules
6+
- name: Should generate USAGE.md for tf12_find and its submodules
77
uses: ./
88
with:
99
find-dir: examples/tf12_find
10+
output-file: USAGE.md
1011
```
1112
1213
## Verify

examples/tf12_inject/README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@
77
uses: ./
88
with:
99
working-dir: examples/tf12_inject
10-
output-file: README.md
1110
args: --sort-by-required
1211
indention: 3
1312
git-push: true

0 commit comments

Comments
 (0)