Skip to content

Commit

Permalink
Update changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
hc-github-team-tf-provider-devex committed Jan 17, 2024
1 parent 6dec712 commit 1856bda
Show file tree
Hide file tree
Showing 7 changed files with 46 additions and 40 deletions.
23 changes: 23 additions & 0 deletions .changes/0.17.0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
## 0.17.0 (January 17, 2024)

BREAKING CHANGES:

* generate: templates using `printf` with either `codefile` or `tffile` to render code examples in markdown will need to switch to using those functions directly.
For example, switch the following template code:
`{{printf "{{codefile \"shell\" %q}}" .ImportFile}}`
to
`{{codefile "shell" .ImportFile}}` ([#300](https://github.com/hashicorp/terraform-plugin-docs/issues/300))

FEATURES:

* migrate: Added new `migrate` subcommand that migrates existing provider docs using the rendered website source directories (`website/docs/` or `/docs/`) to a `terraform-plugin-docs`-supported templates directory. ([#314](https://github.com/hashicorp/terraform-plugin-docs/issues/314))

ENHANCEMENTS:

* generate: Add `provider-schema` flag to pass in a file path to a provider schema JSON file, allowing the command to skip building the provider and calling Terraform CLI ([#299](https://github.com/hashicorp/terraform-plugin-docs/issues/299))

BUG FIXES:

* generate: fix `no such file or directory` error when running `generate` with no existing rendered website directory. ([#296](https://github.com/hashicorp/terraform-plugin-docs/issues/296))
* generate: fix incorrect rendering of example and import files for providers with no docs templates or with generic fallback templates. ([#300](https://github.com/hashicorp/terraform-plugin-docs/issues/300))

15 changes: 0 additions & 15 deletions .changes/unreleased/BREAKING CHANGES-20231206-140932.yaml

This file was deleted.

6 changes: 0 additions & 6 deletions .changes/unreleased/BUG FIXES-20231108-172558.yaml

This file was deleted.

6 changes: 0 additions & 6 deletions .changes/unreleased/BUG FIXES-20231121-150034.yaml

This file was deleted.

6 changes: 0 additions & 6 deletions .changes/unreleased/ENHANCEMENTS-20231117-151029.yaml

This file was deleted.

7 changes: 0 additions & 7 deletions .changes/unreleased/FEATURES-20231220-141244.yaml

This file was deleted.

23 changes: 23 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,26 @@
## 0.17.0 (January 17, 2024)

BREAKING CHANGES:

* generate: templates using `printf` with either `codefile` or `tffile` to render code examples in markdown will need to switch to using those functions directly.
For example, switch the following template code:
`{{printf "{{codefile \"shell\" %q}}" .ImportFile}}`
to
`{{codefile "shell" .ImportFile}}` ([#300](https://github.com/hashicorp/terraform-plugin-docs/issues/300))

FEATURES:

* migrate: Added new `migrate` subcommand that migrates existing provider docs using the rendered website source directories (`website/docs/` or `/docs/`) to a `terraform-plugin-docs`-supported templates directory. ([#314](https://github.com/hashicorp/terraform-plugin-docs/issues/314))

ENHANCEMENTS:

* generate: Add `provider-schema` flag to pass in a file path to a provider schema JSON file, allowing the command to skip building the provider and calling Terraform CLI ([#299](https://github.com/hashicorp/terraform-plugin-docs/issues/299))

BUG FIXES:

* generate: fix `no such file or directory` error when running `generate` with no existing rendered website directory. ([#296](https://github.com/hashicorp/terraform-plugin-docs/issues/296))
* generate: fix incorrect rendering of example and import files for providers with no docs templates or with generic fallback templates. ([#300](https://github.com/hashicorp/terraform-plugin-docs/issues/300))

## 0.16.0 (July 06, 2023)

ENHANCEMENTS:
Expand Down

0 comments on commit 1856bda

Please sign in to comment.