Skip to content

Commit 1856bda

Browse files
Update changelog
1 parent 6dec712 commit 1856bda

7 files changed

+46
-40
lines changed

.changes/0.17.0.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
## 0.17.0 (January 17, 2024)
2+
3+
BREAKING CHANGES:
4+
5+
* generate: templates using `printf` with either `codefile` or `tffile` to render code examples in markdown will need to switch to using those functions directly.
6+
For example, switch the following template code:
7+
`{{printf "{{codefile \"shell\" %q}}" .ImportFile}}`
8+
to
9+
`{{codefile "shell" .ImportFile}}` ([#300](https://github.com/hashicorp/terraform-plugin-docs/issues/300))
10+
11+
FEATURES:
12+
13+
* 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))
14+
15+
ENHANCEMENTS:
16+
17+
* 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))
18+
19+
BUG FIXES:
20+
21+
* 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))
22+
* 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))
23+

.changes/unreleased/BREAKING CHANGES-20231206-140932.yaml

-15
This file was deleted.

.changes/unreleased/BUG FIXES-20231108-172558.yaml

-6
This file was deleted.

.changes/unreleased/BUG FIXES-20231121-150034.yaml

-6
This file was deleted.

.changes/unreleased/ENHANCEMENTS-20231117-151029.yaml

-6
This file was deleted.

.changes/unreleased/FEATURES-20231220-141244.yaml

-7
This file was deleted.

CHANGELOG.md

+23
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,26 @@
1+
## 0.17.0 (January 17, 2024)
2+
3+
BREAKING CHANGES:
4+
5+
* generate: templates using `printf` with either `codefile` or `tffile` to render code examples in markdown will need to switch to using those functions directly.
6+
For example, switch the following template code:
7+
`{{printf "{{codefile \"shell\" %q}}" .ImportFile}}`
8+
to
9+
`{{codefile "shell" .ImportFile}}` ([#300](https://github.com/hashicorp/terraform-plugin-docs/issues/300))
10+
11+
FEATURES:
12+
13+
* 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))
14+
15+
ENHANCEMENTS:
16+
17+
* 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))
18+
19+
BUG FIXES:
20+
21+
* 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))
22+
* 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))
23+
124
## 0.16.0 (July 06, 2023)
225

326
ENHANCEMENTS:

0 commit comments

Comments
 (0)