From 1856bda3cf43d608c6c127c6bce8b841a0737172 Mon Sep 17 00:00:00 2001 From: hc-github-team-tf-provider-devex Date: Wed, 17 Jan 2024 16:24:04 +0000 Subject: [PATCH] Update changelog --- .changes/0.17.0.md | 23 +++++++++++++++++++ .../BREAKING CHANGES-20231206-140932.yaml | 15 ------------ .../unreleased/BUG FIXES-20231108-172558.yaml | 6 ----- .../unreleased/BUG FIXES-20231121-150034.yaml | 6 ----- .../ENHANCEMENTS-20231117-151029.yaml | 6 ----- .../unreleased/FEATURES-20231220-141244.yaml | 7 ------ CHANGELOG.md | 23 +++++++++++++++++++ 7 files changed, 46 insertions(+), 40 deletions(-) create mode 100644 .changes/0.17.0.md delete mode 100644 .changes/unreleased/BREAKING CHANGES-20231206-140932.yaml delete mode 100644 .changes/unreleased/BUG FIXES-20231108-172558.yaml delete mode 100644 .changes/unreleased/BUG FIXES-20231121-150034.yaml delete mode 100644 .changes/unreleased/ENHANCEMENTS-20231117-151029.yaml delete mode 100644 .changes/unreleased/FEATURES-20231220-141244.yaml diff --git a/.changes/0.17.0.md b/.changes/0.17.0.md new file mode 100644 index 00000000..461a24de --- /dev/null +++ b/.changes/0.17.0.md @@ -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)) + diff --git a/.changes/unreleased/BREAKING CHANGES-20231206-140932.yaml b/.changes/unreleased/BREAKING CHANGES-20231206-140932.yaml deleted file mode 100644 index e2519d9a..00000000 --- a/.changes/unreleased/BREAKING CHANGES-20231206-140932.yaml +++ /dev/null @@ -1,15 +0,0 @@ -kind: BREAKING CHANGES -body: '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}}` -' -time: 2023-12-06T14:09:32.757057-05:00 -custom: - Issue: "300" diff --git a/.changes/unreleased/BUG FIXES-20231108-172558.yaml b/.changes/unreleased/BUG FIXES-20231108-172558.yaml deleted file mode 100644 index d941ce02..00000000 --- a/.changes/unreleased/BUG FIXES-20231108-172558.yaml +++ /dev/null @@ -1,6 +0,0 @@ -kind: BUG FIXES -body: 'generate: fix `no such file or directory` error when running `generate` with - no existing rendered website directory.' -time: 2023-11-08T17:25:58.561956-05:00 -custom: - Issue: "296" diff --git a/.changes/unreleased/BUG FIXES-20231121-150034.yaml b/.changes/unreleased/BUG FIXES-20231121-150034.yaml deleted file mode 100644 index 69a080a8..00000000 --- a/.changes/unreleased/BUG FIXES-20231121-150034.yaml +++ /dev/null @@ -1,6 +0,0 @@ -kind: BUG FIXES -body: 'generate: fix incorrect rendering of example and import files for providers - with no docs templates or with generic fallback templates.' -time: 2023-11-21T15:00:34.216261-05:00 -custom: - Issue: "300" diff --git a/.changes/unreleased/ENHANCEMENTS-20231117-151029.yaml b/.changes/unreleased/ENHANCEMENTS-20231117-151029.yaml deleted file mode 100644 index 4ebbfee0..00000000 --- a/.changes/unreleased/ENHANCEMENTS-20231117-151029.yaml +++ /dev/null @@ -1,6 +0,0 @@ -kind: ENHANCEMENTS -body: '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' -time: 2023-11-17T15:10:29.850914-05:00 -custom: - Issue: "299" diff --git a/.changes/unreleased/FEATURES-20231220-141244.yaml b/.changes/unreleased/FEATURES-20231220-141244.yaml deleted file mode 100644 index ee1fb4d0..00000000 --- a/.changes/unreleased/FEATURES-20231220-141244.yaml +++ /dev/null @@ -1,7 +0,0 @@ -kind: FEATURES -body: '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.' -time: 2023-12-20T14:12:44.820323-05:00 -custom: - Issue: "314" diff --git a/CHANGELOG.md b/CHANGELOG.md index 816f6397..10d3b30d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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: