centersl/terraform-docs
1
0
Fork 0
mirror of https://github.com/terraform-docs/terraform-docs.git synced 2026-03-27 04:48:33 +07:00
Code Issues Packages Projects Releases Wiki Activity
475 Commits 9 Branches 38 Tags
10cd6decf1bf2f17e110a9d0b56b5626244f4b21
Commit Graph

475 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
Khosrow Moossavi
10cd6decf1 Add DCO file 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-03-17 20:13:51 -04:00
Khosrow Moossavi
694afc3755 Merge pull request #434 from khos2ow/golangci 
Update golangci-lint and fix issues
 2021-03-16 17:35:56 -04:00
Khosrow Moossavi
3cc4f4416f Fix issues reported by golangci-lint 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-03-16 17:33:10 -04:00
Khosrow Moossavi
0c25f7bee7 Update golangci-lint configuration 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-03-16 16:54:20 -04:00
Khosrow Moossavi
5b57ea4b7f Disable codecov patch status 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-03-16 13:57:35 -04:00
Khosrow Moossavi
2ed9d64100 Merge pull request #433 from khos2ow/cleanup 
Cleanup unused changelog and authors
 2021-03-16 13:52:14 -04:00
Khosrow Moossavi
8faaf9f863 Remove authors file and corresponding scripts 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-03-16 13:49:06 -04:00
Khosrow Moossavi
c24644257d Remove changelog and corresponding scripts 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-03-16 13:41:31 -04:00
Khosrow Moossavi
eb67206a50 Merge pull request #432 from khos2ow/module-enhancements 
Overall terraform module enhancements
 2021-03-16 10:02:59 -04:00
Khosrow Moossavi
eeee58ceda Update reference documentation 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-03-16 09:54:45 -04:00
Khosrow Moossavi
a69d53868c Overall terraform module items test improvements 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-03-16 09:53:36 -04:00
Khosrow Moossavi
caebead84d Normalize resource attributes for various formats 
for:

- json
- toml
- xml
- and yaml

Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-03-15 18:29:27 -04:00
Khosrow Moossavi
8e9d7ac450 Normalize requirement attributes for toml format 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-03-15 18:28:39 -04:00
Khosrow Moossavi
acb09d2984 Normalize module attributes for various formats 
for:

- json
- pretty
- toml
- xml
- and yaml

Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-03-15 18:27:17 -04:00
Khosrow Moossavi
ac5a29c6f6 Implement module sort by position (no sort) 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-03-15 18:26:54 -04:00
Khosrow Moossavi
2109520db0 Merge pull request #383 from si-c613/368-Add-Footer-Option 
feat: Add support for footer docs (#368)
 2021-03-15 14:56:10 -04:00
Simon Clifford
aa1e6bbf59 Add support for footer docs 
Enables a footer to be appended to the end of a generated document
sourced from tf files or documents in the same way as the header

Adds the `footer-from` field to the config yml
Adds the `--footer-from` flag to the cli

Signed-off-by: Simon Clifford <siclifford@gmail.com>
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-03-15 14:51:00 -04:00
Khosrow Moossavi
fa4dc120a6 Merge pull request #428 from edgarsandi/feat/add-resource-mode-to-generated-docs 
Feat/add resource mode to generated docs
 2021-03-15 14:05:43 -04:00
Edgar R. Sandi
243fb27ca5 add mode resource or data source to generated docs 
Signed-off-by: Edgar R. Sandi <edgar.r.sandi@gmail.com>
 2021-03-15 12:40:31 -03:00
Khosrow Moossavi
5fae473131 Merge pull request #429 from khos2ow/header-line-ending 
Do not modify header lines and trailing whitespaces
 2021-03-13 13:45:51 -05:00
Khosrow Moossavi
7e489d2bbb Do not modify header lines and trailing whitespaces 
This is going to preserve line-ending of extracted header text as they
are provided by users. In other words we are going to always assume the
header text is formatted in the "intended" way by users. So we're never
going to modify line-endings and won't append `<SPACE><SPACE>` at the
end of paragraph lines.

Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-03-13 13:43:03 -05:00
Khosrow Moossavi
5468410625 Update github token for prereleases 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-03-09 17:15:31 -05:00
Khosrow Moossavi
d982399d36 Merge pull request #425 from khos2ow/output-file 
Save generated content directly into a file
v0.12.0-beta.1 		2021-03-09 16:42:53 -05:00
Khosrow Moossavi
a3bafd6018 Save generated content directly into a file 
There are two modes for saving into file:

- inject: partially replace the target file with generated output
- replace: completely replace the target file with generated output

The output generated by formatters (markdown, asciidoc, etc) will be
inserted into a template before getting saved into the file. This
template can be customized with '--output-template' CLI flag or
corresponding item in '.terraform-docs.yml' config file. Its default
value is:

```
<!-- BEGIN_TF_DOCS -->
{{ .Content }}
<!-- END_TF_DOCS -->
```

This consists of three items, all of them are mandatory:

- begin comment
- content variable
- end comment

You may change the wording of comment as you wish, but the comment must
be present in the template.

Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-03-09 16:40:22 -05:00
Khosrow Moossavi
644ddc4477 Merge pull request #424 from andreswebs/docs 
fix shellcheck warnings in git hook example
 2021-03-09 14:04:27 -05:00
Khosrow Moossavi
f39601bd5c Merge pull request #421 from edgarsandi/feat/add-resource-name-to-generated-docs 
Feat/add resource name to generated docs
 2021-03-09 13:28:25 -05:00
Edgar R. Sandi
8c05cb9b17 Add resource 'Name' to generated docs 
Signed-off-by: Edgar R. Sandi <edgar.r.sandi@gmail.com>
 2021-03-09 15:11:39 -03:00
andreswebs
9cdcbbe7f4 fix shellcheck warnings in git hook example 
Signed-off-by: andreswebs <andreswebs@pm.me>
 2021-03-08 22:30:37 -03:00
Khosrow Moossavi
9d9edfa38a Fix broken links 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-03-04 20:15:11 -05:00
Khosrow Moossavi
ce2d8e6a6e Merge pull request #418 from khos2ow/site 
Enable site deploy preview for pull requests
 2021-03-04 19:36:28 -05:00
Khosrow Moossavi
ada745bbe4 Add developer-guide documentation 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-03-04 19:33:34 -05:00
Khosrow Moossavi
780242b506 Add user-guide documentation 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-03-04 18:17:49 -05:00
Khosrow Moossavi
2b150c1876 Enable site deploy preview for pull requests 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-03-04 17:28:21 -05:00
Khosrow Moossavi
124aa37559 Merge pull request #416 from khos2ow/default-column 
Add option to hide Type and Default columns
 2021-03-02 14:19:57 -05:00
Khosrow Moossavi
3d39a94e39 Add option to hide Type and Default columns 
Two new flags are added: '--default bool' and '--type bool' to
control the visibility of Default and Type columns and section
respectively in Markdown and AsciiDoc.

Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-03-02 14:17:03 -05:00
Khosrow Moossavi
7b7a86f962 Merge pull request #415 from khos2ow/go-makefile 
Add ability to override go binary for make targets
 2021-03-02 12:54:15 -05:00
Khosrow Moossavi
1ed380bdbc Add ability to override go binary for make targets 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-03-02 12:51:35 -05:00
Khosrow Moossavi
d1fea032a5 Merge pull request #409 from nitrocode/anchors 
Anchors
 2021-03-02 12:50:43 -05:00
nitrocode
02f490dc65 --anchor to add anchors for markdown, asciidocs 
Signed-off-by: nitrocode <nitrocode@users.noreply.github.com>
 2021-03-02 12:47:44 -05:00
Khosrow Moossavi
03075ec855 Merge pull request #414 from khos2ow/embed-tmpl 
Use embedded template files
 2021-03-01 17:02:30 -05:00
Khosrow Moossavi
92d7a60d5e Use embedded template files 
Embedding files was added in go1.16, so instead of defining required
templates as constant in .go files, they are moved to dedicated .tmpl
files.

Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-03-01 16:49:38 -05:00
Khosrow Moossavi
ded9b9b080 Merge pull request #411 from khos2ow/tests 
Overhaul refactor of test suites
 2021-03-01 16:46:08 -05:00
Khosrow Moossavi
152928007f Update reference documentation and guide 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-03-01 16:42:59 -05:00
Khosrow Moossavi
44d5fabe5c Move common tests outside of each format test file 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-03-01 16:42:25 -05:00
Khosrow Moossavi
94fa3d2b07 Overhaul refactor of test suites 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-03-01 15:39:31 -05:00
Khosrow Moossavi
8ade41399e Remove irrelevant sort information from Settings 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-02-28 20:37:12 -05:00
Khosrow Moossavi
8c2756dc41 Merge pull request #406 from khos2ow/obsolete-flags 
Completely remove deprecated '--no-XXX' flags
 2021-02-24 15:19:17 -05:00
Khosrow Moossavi
25d2ff4e53 Completely remove deprecated '--no-XXX' flags 
In v0.10.0 flags '--no-XXX' have been deprecated in favor of their
counterparts in the format of '--X=false' (e.g. --no-header and
--header=false). And they are completely being removed now (two releases
after original announcement)

Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-02-23 18:46:02 -05:00
Khosrow Moossavi
a91c3dbebb Merge pull request #396 from khos2ow/go1.16 
Update to go1.16
 2021-02-23 18:33:47 -05:00
Khosrow Moossavi
4920bfd411 Build darwin/arm64 as part of goreleaser 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-02-23 18:31:26 -05:00