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 Apr 15, 2024
1 parent 1f28b7c commit 45dd248
Show file tree
Hide file tree
Showing 16 changed files with 56 additions and 83 deletions.
28 changes: 28 additions & 0 deletions .changes/0.19.0.md
Original file line number Diff line number Diff line change
@@ -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))

6 changes: 0 additions & 6 deletions .changes/unreleased/BREAKING CHANGES-20240410-161445.yaml

This file was deleted.

6 changes: 0 additions & 6 deletions .changes/unreleased/BREAKING CHANGES-20240410-161540.yaml

This file was deleted.

6 changes: 0 additions & 6 deletions .changes/unreleased/BUG FIXES-20240124-131519.yaml

This file was deleted.

6 changes: 0 additions & 6 deletions .changes/unreleased/BUG FIXES-20240327-161037.yaml

This file was deleted.

6 changes: 0 additions & 6 deletions .changes/unreleased/BUG FIXES-20240410-154619.yaml

This file was deleted.

6 changes: 0 additions & 6 deletions .changes/unreleased/ENHANCEMENTS-20240327-160831.yaml

This file was deleted.

5 changes: 0 additions & 5 deletions .changes/unreleased/FEATURES-20240305-135426.yaml

This file was deleted.

6 changes: 0 additions & 6 deletions .changes/unreleased/FEATURES-20240305-135726.yaml

This file was deleted.

6 changes: 0 additions & 6 deletions .changes/unreleased/FEATURES-20240305-135933.yaml

This file was deleted.

6 changes: 0 additions & 6 deletions .changes/unreleased/FEATURES-20240305-140106.yaml

This file was deleted.

6 changes: 0 additions & 6 deletions .changes/unreleased/FEATURES-20240305-140234.yaml

This file was deleted.

6 changes: 0 additions & 6 deletions .changes/unreleased/FEATURES-20240305-140346.yaml

This file was deleted.

6 changes: 0 additions & 6 deletions .changes/unreleased/FEATURES-20240305-140451.yaml

This file was deleted.

6 changes: 0 additions & 6 deletions .changes/unreleased/FEATURES-20240305-140622.yaml

This file was deleted.

28 changes: 28 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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:
Expand Down

0 comments on commit 45dd248

Please sign in to comment.