diff --git a/.changes/0.19.0.md b/.changes/0.19.0.md new file mode 100644 index 00000000..628bf9ee --- /dev/null +++ b/.changes/0.19.0.md @@ -0,0 +1,28 @@ +## 0.19.0 (April 15, 2024) + +BREAKING CHANGES: + +* schemamd: The `schemamd` package has moved to `internal/schemamd` and can no longer be imported ([#354](https://github.com/hashicorp/terraform-plugin-docs/issues/354)) +* functionmd: The `functionmd` package has moved to `internal/functionmd` and can no longer be imported ([#354](https://github.com/hashicorp/terraform-plugin-docs/issues/354)) + +FEATURES: + +* validate: Added support for Provider-defined Function documentation to all checks ([#341](https://github.com/hashicorp/terraform-plugin-docs/issues/341)) +* validate: Added `InvalidDirectoriesCheck` which checks for valid provider documentation folder structure ([#341](https://github.com/hashicorp/terraform-plugin-docs/issues/341)) +* validate: Added `MixedDirectoriesCheck` which throws an error if both legacy documentation and registry documentation are found ([#341](https://github.com/hashicorp/terraform-plugin-docs/issues/341)) +* validate: Added `NumberOfFilesCheck` which checks the number of provider documentation files against the registry limit ([#341](https://github.com/hashicorp/terraform-plugin-docs/issues/341)) +* validate: Added `FileSizeCheck` which checks the provider documentation file size against the registry limit ([#341](https://github.com/hashicorp/terraform-plugin-docs/issues/341)) +* validate: Added `FileExtensionCheck` which checks for valid provider documentation file extensions ([#341](https://github.com/hashicorp/terraform-plugin-docs/issues/341)) +* validate: Added `FrontMatterCheck` which checks the YAML frontmatter of provider documentation for missing required fields or invalid fields ([#341](https://github.com/hashicorp/terraform-plugin-docs/issues/341)) +* validate: Added `FileMismatchCheck` which checks the names/number of provider documentation files against the provider schema ([#341](https://github.com/hashicorp/terraform-plugin-docs/issues/341)) + +ENHANCEMENTS: + +* migrate: Added `--provider-name` flag to override the default provider name when any file names that contain provider name prefixes are removed during migration ([#349](https://github.com/hashicorp/terraform-plugin-docs/issues/349)) + +BUG FIXES: + +* migrate: use relative paths (from provider directory) instead of absolute paths for migrated code templates ([#330](https://github.com/hashicorp/terraform-plugin-docs/issues/330)) +* migrate: fixed a bug where documentation files with provider name prefixes were migrated to templates directory as-is, causing `generate` to create duplicate templates ([#349](https://github.com/hashicorp/terraform-plugin-docs/issues/349)) +* generate: fixed a bug where incorrect attribute titles were being generated for certain nested schemas ([#350](https://github.com/hashicorp/terraform-plugin-docs/issues/350)) + diff --git a/.changes/unreleased/BREAKING CHANGES-20240410-161445.yaml b/.changes/unreleased/BREAKING CHANGES-20240410-161445.yaml deleted file mode 100644 index 54257eb4..00000000 --- a/.changes/unreleased/BREAKING CHANGES-20240410-161445.yaml +++ /dev/null @@ -1,6 +0,0 @@ -kind: BREAKING CHANGES -body: 'schemamd: The `schemamd` package has moved to `internal/schemamd` and can no - longer be imported' -time: 2024-04-10T16:14:45.685307-04:00 -custom: - Issue: "354" diff --git a/.changes/unreleased/BREAKING CHANGES-20240410-161540.yaml b/.changes/unreleased/BREAKING CHANGES-20240410-161540.yaml deleted file mode 100644 index bd67abfe..00000000 --- a/.changes/unreleased/BREAKING CHANGES-20240410-161540.yaml +++ /dev/null @@ -1,6 +0,0 @@ -kind: BREAKING CHANGES -body: 'functionmd: The `functionmd` package has moved to `internal/functionmd` and - can no longer be imported' -time: 2024-04-10T16:15:40.388578-04:00 -custom: - Issue: "354" diff --git a/.changes/unreleased/BUG FIXES-20240124-131519.yaml b/.changes/unreleased/BUG FIXES-20240124-131519.yaml deleted file mode 100644 index 6babe667..00000000 --- a/.changes/unreleased/BUG FIXES-20240124-131519.yaml +++ /dev/null @@ -1,6 +0,0 @@ -kind: BUG FIXES -body: 'migrate: use relative paths (from provider directory) instead of absolute paths - for migrated code templates' -time: 2024-01-24T13:15:19.830885-05:00 -custom: - Issue: "330" diff --git a/.changes/unreleased/BUG FIXES-20240327-161037.yaml b/.changes/unreleased/BUG FIXES-20240327-161037.yaml deleted file mode 100644 index b1f57600..00000000 --- a/.changes/unreleased/BUG FIXES-20240327-161037.yaml +++ /dev/null @@ -1,6 +0,0 @@ -kind: BUG FIXES -body: 'migrate: fixed a bug where documentation files with provider name prefixes were - migrated to templates directory as-is, causing `generate` to create duplicate templates' -time: 2024-03-27T16:10:37.029568-04:00 -custom: - Issue: "349" diff --git a/.changes/unreleased/BUG FIXES-20240410-154619.yaml b/.changes/unreleased/BUG FIXES-20240410-154619.yaml deleted file mode 100644 index 4302f892..00000000 --- a/.changes/unreleased/BUG FIXES-20240410-154619.yaml +++ /dev/null @@ -1,6 +0,0 @@ -kind: BUG FIXES -body: 'generate: fixed a bug where incorrect attribute titles were being generated - for certain nested schemas' -time: 2024-04-10T15:46:19.65146-04:00 -custom: - Issue: "350" diff --git a/.changes/unreleased/ENHANCEMENTS-20240327-160831.yaml b/.changes/unreleased/ENHANCEMENTS-20240327-160831.yaml deleted file mode 100644 index d71c550b..00000000 --- a/.changes/unreleased/ENHANCEMENTS-20240327-160831.yaml +++ /dev/null @@ -1,6 +0,0 @@ -kind: ENHANCEMENTS -body: 'migrate: Added `--provider-name` flag to override the default provider name when any - file names that contain provider name prefixes are removed during migration' -time: 2024-03-27T16:08:31.541882-04:00 -custom: - Issue: "349" diff --git a/.changes/unreleased/FEATURES-20240305-135426.yaml b/.changes/unreleased/FEATURES-20240305-135426.yaml deleted file mode 100644 index 12267b80..00000000 --- a/.changes/unreleased/FEATURES-20240305-135426.yaml +++ /dev/null @@ -1,5 +0,0 @@ -kind: FEATURES -body: 'validate: Added support for Provider-defined Function documentation to all checks' -time: 2024-03-05T13:54:26.307742-05:00 -custom: - Issue: "341" diff --git a/.changes/unreleased/FEATURES-20240305-135726.yaml b/.changes/unreleased/FEATURES-20240305-135726.yaml deleted file mode 100644 index fcd2dcab..00000000 --- a/.changes/unreleased/FEATURES-20240305-135726.yaml +++ /dev/null @@ -1,6 +0,0 @@ -kind: FEATURES -body: 'validate: Added `InvalidDirectoriesCheck` which checks for valid provider documentation - folder structure' -time: 2024-03-05T13:57:26.273538-05:00 -custom: - Issue: "341" diff --git a/.changes/unreleased/FEATURES-20240305-135933.yaml b/.changes/unreleased/FEATURES-20240305-135933.yaml deleted file mode 100644 index 3660390d..00000000 --- a/.changes/unreleased/FEATURES-20240305-135933.yaml +++ /dev/null @@ -1,6 +0,0 @@ -kind: FEATURES -body: 'validate: Added `MixedDirectoriesCheck` which throws an error if both legacy - documentation and registry documentation are found' -time: 2024-03-05T13:59:33.741601-05:00 -custom: - Issue: "341" diff --git a/.changes/unreleased/FEATURES-20240305-140106.yaml b/.changes/unreleased/FEATURES-20240305-140106.yaml deleted file mode 100644 index 95e24909..00000000 --- a/.changes/unreleased/FEATURES-20240305-140106.yaml +++ /dev/null @@ -1,6 +0,0 @@ -kind: FEATURES -body: 'validate: Added `NumberOfFilesCheck` which checks the number of provider - documentation files against the registry limit' -time: 2024-03-05T14:01:06.742843-05:00 -custom: - Issue: "341" diff --git a/.changes/unreleased/FEATURES-20240305-140234.yaml b/.changes/unreleased/FEATURES-20240305-140234.yaml deleted file mode 100644 index 1fbb4aa1..00000000 --- a/.changes/unreleased/FEATURES-20240305-140234.yaml +++ /dev/null @@ -1,6 +0,0 @@ -kind: FEATURES -body: 'validate: Added `FileSizeCheck` which checks the provider documentation file - size against the registry limit' -time: 2024-03-05T14:02:34.112782-05:00 -custom: - Issue: "341" diff --git a/.changes/unreleased/FEATURES-20240305-140346.yaml b/.changes/unreleased/FEATURES-20240305-140346.yaml deleted file mode 100644 index 348fab9b..00000000 --- a/.changes/unreleased/FEATURES-20240305-140346.yaml +++ /dev/null @@ -1,6 +0,0 @@ -kind: FEATURES -body: 'validate: Added `FileExtensionCheck` which checks for valid provider documentation - file extensions' -time: 2024-03-05T14:03:46.816256-05:00 -custom: - Issue: "341" diff --git a/.changes/unreleased/FEATURES-20240305-140451.yaml b/.changes/unreleased/FEATURES-20240305-140451.yaml deleted file mode 100644 index 0ed3883a..00000000 --- a/.changes/unreleased/FEATURES-20240305-140451.yaml +++ /dev/null @@ -1,6 +0,0 @@ -kind: FEATURES -body: 'validate: Added `FrontMatterCheck` which checks the YAML frontmatter of provider - documentation for missing required fields or invalid fields' -time: 2024-03-05T14:04:51.781688-05:00 -custom: - Issue: "341" diff --git a/.changes/unreleased/FEATURES-20240305-140622.yaml b/.changes/unreleased/FEATURES-20240305-140622.yaml deleted file mode 100644 index cbb637e7..00000000 --- a/.changes/unreleased/FEATURES-20240305-140622.yaml +++ /dev/null @@ -1,6 +0,0 @@ -kind: FEATURES -body: 'validate: Added `FileMismatchCheck` which checks the names/number of provider - documentation files against the provider schema' -time: 2024-03-05T14:06:22.168518-05:00 -custom: - Issue: "341" diff --git a/CHANGELOG.md b/CHANGELOG.md index 6fe845f6..aad03a33 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,31 @@ +## 0.19.0 (April 15, 2024) + +BREAKING CHANGES: + +* schemamd: The `schemamd` package has moved to `internal/schemamd` and can no longer be imported ([#354](https://github.com/hashicorp/terraform-plugin-docs/issues/354)) +* functionmd: The `functionmd` package has moved to `internal/functionmd` and can no longer be imported ([#354](https://github.com/hashicorp/terraform-plugin-docs/issues/354)) + +FEATURES: + +* validate: Added support for Provider-defined Function documentation to all checks ([#341](https://github.com/hashicorp/terraform-plugin-docs/issues/341)) +* validate: Added `InvalidDirectoriesCheck` which checks for valid provider documentation folder structure ([#341](https://github.com/hashicorp/terraform-plugin-docs/issues/341)) +* validate: Added `MixedDirectoriesCheck` which throws an error if both legacy documentation and registry documentation are found ([#341](https://github.com/hashicorp/terraform-plugin-docs/issues/341)) +* validate: Added `NumberOfFilesCheck` which checks the number of provider documentation files against the registry limit ([#341](https://github.com/hashicorp/terraform-plugin-docs/issues/341)) +* validate: Added `FileSizeCheck` which checks the provider documentation file size against the registry limit ([#341](https://github.com/hashicorp/terraform-plugin-docs/issues/341)) +* validate: Added `FileExtensionCheck` which checks for valid provider documentation file extensions ([#341](https://github.com/hashicorp/terraform-plugin-docs/issues/341)) +* validate: Added `FrontMatterCheck` which checks the YAML frontmatter of provider documentation for missing required fields or invalid fields ([#341](https://github.com/hashicorp/terraform-plugin-docs/issues/341)) +* validate: Added `FileMismatchCheck` which checks the names/number of provider documentation files against the provider schema ([#341](https://github.com/hashicorp/terraform-plugin-docs/issues/341)) + +ENHANCEMENTS: + +* migrate: Added `--provider-name` flag to override the default provider name when any file names that contain provider name prefixes are removed during migration ([#349](https://github.com/hashicorp/terraform-plugin-docs/issues/349)) + +BUG FIXES: + +* migrate: use relative paths (from provider directory) instead of absolute paths for migrated code templates ([#330](https://github.com/hashicorp/terraform-plugin-docs/issues/330)) +* migrate: fixed a bug where documentation files with provider name prefixes were migrated to templates directory as-is, causing `generate` to create duplicate templates ([#349](https://github.com/hashicorp/terraform-plugin-docs/issues/349)) +* generate: fixed a bug where incorrect attribute titles were being generated for certain nested schemas ([#350](https://github.com/hashicorp/terraform-plugin-docs/issues/350)) + ## 0.18.0 (January 24, 2024) FEATURES: