@@ -175,13 +175,13 @@ Create markdown output and sent to stdout:
175
175
docker run --rm \
176
176
-v $( pwd) :/data \
177
177
cytopia/terraform-docs \
178
- terraform-docs --sort-inputs- by-required --with-aggregate-type-defaults md .
178
+ terraform-docs --sort-by-required md .
179
179
180
180
# [Terraform >= 0.12]
181
181
docker run --rm \
182
182
-v $( pwd) :/data \
183
183
cytopia/terraform-docs \
184
- terraform-docs-012 --sort-inputs- by-required --with-aggregate-type-defaults md .
184
+ terraform-docs-012 --sort-by-required md .
185
185
` ` `
186
186
187
187
# ## Store in file
@@ -191,13 +191,13 @@ Create README.md with `terraform-docs` output:
191
191
docker run --rm \
192
192
-v $( pwd) :/data \
193
193
cytopia/terraform-docs \
194
- terraform-docs --sort-inputs- by-required --with-aggregate-type-defaults md . > README.md
194
+ terraform-docs --sort-by-required md . > README.md
195
195
196
196
# [Terraform >= 0.12]
197
197
docker run --rm \
198
198
-v $( pwd) :/data \
199
199
cytopia/terraform-docs \
200
- terraform-docs-012 --sort-inputs- by-required --with-aggregate-type-defaults md . > README.md
200
+ terraform-docs-012 --sort-by-required md . > README.md
201
201
` ` `
202
202
203
203
# ## Replace in README.md
@@ -220,15 +220,15 @@ following delimiter by default:
220
220
docker run --rm \
221
221
-v $( pwd) :/data \
222
222
cytopia/terraform-docs \
223
- terraform-docs-replace --sort-inputs- by-required --with-aggregate-type-defaults md README.md
223
+ terraform-docs-replace --sort-by-required md README.md
224
224
225
225
# [Terraform >= 0.12]
226
226
# Path to README.md must be specified as last command.
227
227
# Note that the command changes from terraform-docs to terraform-docs-replace
228
228
docker run --rm \
229
229
-v $( pwd) :/data \
230
230
cytopia/terraform-docs \
231
- terraform-docs-replace-012 --sort-inputs- by-required --with-aggregate-type-defaults md README.md
231
+ terraform-docs-replace-012 --sort-by-required md README.md
232
232
` ` `
233
233
234
234
# ## Replace in INFO.md with different delimiter
@@ -251,7 +251,7 @@ docker run --rm \
251
251
-e DELIM_START=' < ! -- TFDOC_START --> ' \
252
252
-e DELIM_CLOSE=' < ! -- TFDOC_END --> ' \
253
253
cytopia/terraform-docs \
254
- terraform-docs-replace --sort-inputs- by-required --with-aggregate-type-defaults md INFO.md
254
+ terraform-docs-replace --sort-by-required md INFO.md
255
255
256
256
# [Terraform >= 0.12]
257
257
# Path to INFO.md must be specified as last command.
@@ -261,7 +261,7 @@ docker run --rm \
261
261
-e DELIM_START=' < ! -- TFDOC_START --> ' \
262
262
-e DELIM_CLOSE=' < ! -- TFDOC_END --> ' \
263
263
cytopia/terraform-docs \
264
- terraform-docs-replace-012 --sort-inputs- by-required --with-aggregate-type-defaults md INFO.md
264
+ terraform-docs-replace-012 --sort-by-required md INFO.md
265
265
```
266
266
267
267
### Example Makefile
@@ -301,7 +301,7 @@ _gen-main:
301
301
-e DELIM_START=' $( DELIM_START) ' \
302
302
-e DELIM_CLOSE=' $( DELIM_CLOSE) ' \
303
303
cytopia/terraform-docs:$(TF_DOCS_VERSION) \
304
- terraform-docs-replace --sort-inputs- by-required --with-aggregate-type-defaults md README.md; then \
304
+ terraform-docs-replace --sort-by-required md README.md; then \
305
305
echo "OK"; \
306
306
else \
307
307
echo "Failed"; \
@@ -320,7 +320,7 @@ _gen-examples:
320
320
-e DELIM_START=' $( DELIM_START) ' \
321
321
-e DELIM_CLOSE=' $( DELIM_CLOSE) ' \
322
322
cytopia/terraform-docs:$(TF_DOCS_VERSION) \
323
- terraform-docs-replace --sort-inputs- by-required --with-aggregate-type-defaults md $${DOCKER_PATH}/README.md; then \
323
+ terraform-docs-replace --sort-by-required md $${DOCKER_PATH}/README.md; then \
324
324
echo "OK"; \
325
325
else \
326
326
echo "Failed"; \
@@ -340,7 +340,7 @@ _gen-modules:
340
340
-e DELIM_START=' $( DELIM_START) ' \
341
341
-e DELIM_CLOSE=' $( DELIM_CLOSE) ' \
342
342
cytopia/terraform-docs:$(TF_DOCS_VERSION) \
343
- terraform-docs-replace --sort-inputs- by-required --with-aggregate-type-defaults md $${DOCKER_PATH}/README.md; then \
343
+ terraform-docs-replace --sort-by-required md $${DOCKER_PATH}/README.md; then \
344
344
echo "OK"; \
345
345
else \
346
346
echo "Failed"; \
0 commit comments