centersl/terraform-docs
1
0
Fork 0
mirror of https://github.com/terraform-docs/terraform-docs.git synced 2026-03-27 12:58:35 +07:00
Code Issues Packages Projects Releases Wiki Activity
823 Commits 9 Branches 38 Tags
dependabot/github_actions/stefanzweifel/git-auto-commit-action-7
Commit Graph

70 Commits

Author SHA1 Message Date
dependabot[bot]
06ca95c6b7 chore(deps): bump library/alpine in /scripts/release 
Bumps library/alpine from 3.20.3 to 3.21.3.

---
updated-dependencies:
- dependency-name: library/alpine
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
 2025-02-18 06:27:24 +00:00
dependabot[bot]
a639fbd424 chore(deps): bump library/alpine in /scripts/release 
Bumps library/alpine from 3.20.2 to 3.20.3.

---
updated-dependencies:
- dependency-name: library/alpine
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
 2024-09-09 06:22:55 +00:00
dependabot[bot]
0562dbd6c1 Bump library/alpine from 3.20.0 to 3.20.2 in /scripts/release 
Bumps library/alpine from 3.20.0 to 3.20.2.

---
updated-dependencies:
- dependency-name: library/alpine
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
 2024-07-23 06:57:50 +00:00
Khosrow Moossavi
19194525e4 ci: enhance release workflows 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2024-06-04 11:28:09 -04:00
Khosrow Moossavi
2b71b4da7e chore: add release-cut workflow 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2024-05-30 17:48:24 -04:00
Ingmar Delsink
d0862bd555 Update Dockerfile FROM command to use non-ambiguous container sources 
Signed-off-by: Ingmar Delsink <ingmardelsink@hotmail.com>
 2024-05-28 22:54:28 +02:00
dependabot[bot]
b87d0e014a Bump alpine from 3.19.1 to 3.20.0 in /scripts/release 
Bumps alpine from 3.19.1 to 3.20.0.

---
updated-dependencies:
- dependency-name: alpine
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
 2024-05-23 06:49:23 +00:00
dependabot[bot]
e5a9ee09a0 --- 
updated-dependencies:
- dependency-name: alpine
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
 2024-05-21 15:18:07 +00:00
dependabot[bot]
89b52d5c9c Bump alpine from 3.18.5 to 3.19.0 
Bumps alpine from 3.18.5 to 3.19.0.

---
updated-dependencies:
- dependency-name: alpine
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
 2023-12-21 11:39:48 -05:00
Khosrow Moossavi
a89c52edf6 Enhance release script 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2023-12-19 13:29:23 -05:00
Khosrow Moossavi
5cfb2f2615 Bump golangci-lint to 1.55.2 and fix issues 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2023-12-19 12:51:04 -05:00
Khosrow Moossavi
e5abff0187 Bump alpine to 3.18.5 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2023-12-19 11:57:20 -05:00
x4e-jonas
89666c08d1 Update container to Alpine 3.18.2 and Go 1.18.10 
Signed-off-by: x4e-jonas <x4e-jonas@users.noreply.github.com>
 2023-12-18 13:01:05 -05:00
Florent Monbillard
5638b290af Update Alpine base image to 3.16.1 
3.16.1 fixes 4 high vulnerabilities present in Alpine 3.16.0

Signed-off-by: Florent Monbillard <f.monbillard@gmail.com>
 2022-07-28 13:48:17 -04:00
Khosrow Moossavi
f09375367d Bump golangci-lint to 1.47.2 and fix issues 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2022-07-26 18:47:40 -04:00
Khosrow Moossavi
c51e1ac6e8 Bump alpine to 3.16.0 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2022-07-26 17:38:58 -04:00
Khosrow Moossavi
4eb50ae5b9 Bump alpine to 3.14.2 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-11-11 15:26:06 -05:00
Khosrow Moossavi
bb109711a1 Deprecate Settings and Options in favor of Config 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-09-28 15:47:27 -04:00
Khosrow Moossavi
d2fe2b1b29 Move print package from internal to public 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-09-28 15:04:07 -04:00
Khosrow Moossavi
90942f73b8 Move format package from internal to public 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-09-28 14:43:26 -04:00
Khosrow Moossavi
ca8f8333d4 Move template package from internal to public 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-09-28 14:18:05 -04:00
Poojitha Bikki
045707beee feat: Add new flag 'read-comments' to optionally process comments as description 
fixes issue #552

- process description from comments

Signed-off-by: Poojitha Bikki <50849668+poojitha-bikki@users.noreply.github.com>

- fix module tests

Signed-off-by: Poojitha Bikki <50849668+poojitha-bikki@users.noreply.github.com>

- optionally read comments for output vars description

Signed-off-by: Poojitha Bikki <50849668+poojitha-bikki@users.noreply.github.com>

- set default to true

Signed-off-by: Poojitha Bikki <50849668+poojitha-bikki@users.noreply.github.com>

- run make docs

Signed-off-by: Poojitha Bikki <50849668+poojitha-bikki@users.noreply.github.com>

- change option name

Signed-off-by: Poojitha Bikki <50849668+poojitha-bikki@users.noreply.github.com>

- add option in doc generator; make docs

Signed-off-by: Poojitha Bikki <50849668+poojitha-bikki@users.noreply.github.com>

- add config 'ReadComments'

Signed-off-by: Poojitha Bikki <50849668+poojitha-bikki@users.noreply.github.com>

- Fix alphabetic order for 'ReadComments' setting

Signed-off-by: Poojitha Bikki <50849668+poojitha-bikki@users.noreply.github.com>

- add read-comments in docs

Signed-off-by: Poojitha Bikki <50849668+poojitha-bikki@users.noreply.github.com>

- add test for readcomments option

Signed-off-by: Poojitha Bikki <50849668+poojitha-bikki@users.noreply.github.com>

- update 'read-comments' flag description

Co-authored-by: Khosrow Moossavi <khos2ow@gmail.com>
Signed-off-by: Poojitha Bikki <50849668+poojitha-bikki@users.noreply.github.com>
 2021-09-24 18:04:39 -05:00
Khosrow Moossavi
f33826c5df Cleanup documentations 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-09-13 18:07:57 -04:00
Khosrow Moossavi
77bc7801b1 Bump alpine to 3.14.0 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-07-28 20:05:33 -04:00
Khosrow Moossavi
6777364257 Customize content with individual sections output 
Generated content can be customized further away with `content` in configuration.
If the `content` is empty the default orders of section is used. `content` is a
Go template with following additional variables:

- `{{ .Header }}`
- `{{ .Footer }}`
- `{{ .Inputs }}`
- `{{ .Modules }}`
- `{{ .Outputs }}`
- `{{ .Providers }}`
- `{{ .Requirements }}`
- `{{ .Resources }}`

```yaml
content: |-
  Any arbitrary text can be placed anywhere in the content

  {{ .Header }}

  and even in between sections

  {{ .Providers }}

  and they don't even need to be in the default order

  {{ .Outputs }}

  {{ .Inputs }}
```

These variables are the generated output of individual sections in the selected
formatter. For example `{{ .Inputs }}` is Markdown Table representation of inputs
when formatter is set to `markdown table` and AsciiDoc Document representation
when formatter is set to `asciidoc document` and so on.

Compatible formats for customized content are:

- `asciidoc document`
- `asciidoc table`
- `markdown document`
- `markdown table`

Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-05-12 16:12:38 -04:00
Khosrow Moossavi
23436be006 Update release scripts 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-05-06 15:09:31 -04:00
Khosrow Moossavi
b8b0edcb9f Cosmetic cleanup 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-04-22 13:53:36 -04:00
Khosrow Moossavi
efe3ad97ee Merge pull request #394 from pujan14/Switch-to-scratch-as-docker-base-image 
Remove unused build tools from dockerfile
 2021-04-22 13:53:00 -04:00
Pujan Shah
c721db0d54 Remove old comment 
Signed-off-by: Pujan Shah <pujan14@gmail.com>
 2021-03-31 20:37:10 +02:00
Pujan Shah
396c60cf71 Switch to alpine as base image 
Signed-off-by: Pujan Shah <pujan14@gmail.com>
 2021-03-31 20:37:09 +02:00
Pujan Shah
c009b12cc2 Switch to scratch as docker base image for release dockerfile 
Signed-off-by: Pujan Shah <pujan14@gmail.com>
 2021-03-31 20:37:09 +02: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
c24644257d Remove changelog and corresponding scripts 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-03-16 13:41:31 -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
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
152928007f Update reference documentation and guide 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-03-01 16:42:59 -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
304bce9bb0 Refactor docs to be published on website 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-02-23 17:28:12 -05:00
Khosrow Moossavi
fb204ca773 Fix release scripts for chocolatey 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-02-10 18:30:45 -05:00
Khosrow Moossavi
aecd044ee0 Use goreleaser for release workflow and tasks 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-02-04 12:58:24 -05:00
Khosrow Moossavi
89d7f6cf86 Move pkg/print to internal/print 
Originally pkg/print was intended to be public to be used by plugin
developers, but this setting has to be defined by plugin-sdk and as such
it's moved to internal/format to be only used by terraform-docs core
project.

Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-02-02 18:19:58 -05:00
Khosrow Moossavi
44b3361b22 Add license header to codebase files 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-01-28 12:29:11 -05:00
Khosrow Moossavi
e3a19ea9dd Move pkg/tfconf to internal/terraform 
Originally pkg/tfconf was set to be public to be used by plugin
developers, but these structs have to be defined by plugin-sdk and as
such it's moved to internal/terraform to be only used by terraform-docs
core project.

Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-01-26 15:39:30 -05:00
Khosrow Moossavi
63750c1784 fix: Normalize last empty line of the generated output (#336) 
Generated output will not have any empty line or
carriage return at the end of the last line and
one carriage return (\n) will be added when we
print that to stdout.

Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2020-10-15 18:51:30 -04:00
Khosrow Moossavi
dac90f1948 chore: Enhance release scripts (#326) 2020-09-25 12:05:10 -04:00
Khosrow Moossavi
38316ec246 chore: Custom order of changelog items (#245) 
* Custom order of changelog items

* Use forked built of git-chglog instead of upstream

* Update Changelog
 2020-09-07 11:59:00 -04:00
Khosrow Moossavi
38a86cbdc5 feat: Build and push docker image (#289) 2020-07-11 19:36:55 -04:00
Khosrow Moossavi
dfeaaecdc4 Migrate to github.com/terraform-docs org (#288) 
* Migrate to github.com/terraform-docs org

* remove codecov token

* update maintenance notice in README
 2020-07-06 19:43:25 -04:00
Khosrow Moossavi
04a9ef49eb refactor: Refactor cli implemention and configuration (#266) 
* Refactor cli implemention and configuration

* cleanup
 2020-05-20 22:21:19 -04:00
Khosrow Moossavi
c196c7cc49 refactor: Add factory function to return format types (#243) 2020-04-10 19:08:37 -04:00