mirror of
https://github.com/terraform-docs/terraform-docs.git
synced 2026-03-27 12:58:35 +07:00
Update Changelog
This commit is contained in:
15
CHANGELOG.md
15
CHANGELOG.md
@@ -9,10 +9,13 @@
|
||||
- Move doc.Doc to tfconf.Module ([#136](https://github.com/segmentio/terraform-docs/issues/136))
|
||||
|
||||
### Enhancements
|
||||
- Rename flag to '--sort-by-required' ([#150](https://github.com/segmentio/terraform-docs/issues/150))
|
||||
- Mark '--with-aggregate-type-defaults' as deprecated ([#148](https://github.com/segmentio/terraform-docs/issues/148))
|
||||
- Bump homebrew formula version on release ([#135](https://github.com/segmentio/terraform-docs/issues/135))
|
||||
- Enable new go linters and fix the existing issues ([#132](https://github.com/segmentio/terraform-docs/issues/132))
|
||||
|
||||
### Features
|
||||
- Add '--no-escape' flag to 'json' command ([#147](https://github.com/segmentio/terraform-docs/issues/147))
|
||||
- Add flags to not show different sections ([#144](https://github.com/segmentio/terraform-docs/issues/144))
|
||||
- Add '--no-color' flag to 'pretty' command ([#143](https://github.com/segmentio/terraform-docs/issues/143))
|
||||
- Show 'providers' information ([#140](https://github.com/segmentio/terraform-docs/issues/140))
|
||||
@@ -21,6 +24,18 @@
|
||||
|
||||
### BREAKING CHANGE
|
||||
|
||||
- For simplicity we've decided to
|
||||
deprecated the old `--sort-inputs-by-required` flag
|
||||
to the simpler and more generic `--sort--by-required`.
|
||||
The deprecated flags will get removed second release
|
||||
from now.
|
||||
|
||||
- As of Terraform 0.12, the default value of
|
||||
input variables are shown in full JSON format (if available)
|
||||
and `--with-aggregate-type-defaults` is not needed anymore.
|
||||
The flag is marked as soft deprecated and will get removed in
|
||||
the second release from now.
|
||||
|
||||
- With Terraform 0.12 the information about `providers` being used in the module will be generated by default. This will cause the first generation of documents with the latest release of `terraform-docs` binary be slightly different than before, now there will be `Providers` section in Markdown and `providers` block in JSON. You can ignore this by using new `--no-providers` flag if you choose to.
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user