Skip to content

Commit 45dd248

Browse files
Update changelog
1 parent 1f28b7c commit 45dd248

16 files changed

+56
-83
lines changed

.changes/0.19.0.md

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
## 0.19.0 (April 15, 2024)
2+
3+
BREAKING CHANGES:
4+
5+
* 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))
6+
* 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))
7+
8+
FEATURES:
9+
10+
* validate: Added support for Provider-defined Function documentation to all checks ([#341](https://github.com/hashicorp/terraform-plugin-docs/issues/341))
11+
* validate: Added `InvalidDirectoriesCheck` which checks for valid provider documentation folder structure ([#341](https://github.com/hashicorp/terraform-plugin-docs/issues/341))
12+
* 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))
13+
* 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))
14+
* validate: Added `FileSizeCheck` which checks the provider documentation file size against the registry limit ([#341](https://github.com/hashicorp/terraform-plugin-docs/issues/341))
15+
* validate: Added `FileExtensionCheck` which checks for valid provider documentation file extensions ([#341](https://github.com/hashicorp/terraform-plugin-docs/issues/341))
16+
* 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))
17+
* 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))
18+
19+
ENHANCEMENTS:
20+
21+
* 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))
22+
23+
BUG FIXES:
24+
25+
* 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))
26+
* 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))
27+
* 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))
28+

.changes/unreleased/BREAKING CHANGES-20240410-161445.yaml

-6
This file was deleted.

.changes/unreleased/BREAKING CHANGES-20240410-161540.yaml

-6
This file was deleted.

.changes/unreleased/BUG FIXES-20240124-131519.yaml

-6
This file was deleted.

.changes/unreleased/BUG FIXES-20240327-161037.yaml

-6
This file was deleted.

.changes/unreleased/BUG FIXES-20240410-154619.yaml

-6
This file was deleted.

.changes/unreleased/ENHANCEMENTS-20240327-160831.yaml

-6
This file was deleted.

.changes/unreleased/FEATURES-20240305-135426.yaml

-5
This file was deleted.

.changes/unreleased/FEATURES-20240305-135726.yaml

-6
This file was deleted.

.changes/unreleased/FEATURES-20240305-135933.yaml

-6
This file was deleted.

.changes/unreleased/FEATURES-20240305-140106.yaml

-6
This file was deleted.

.changes/unreleased/FEATURES-20240305-140234.yaml

-6
This file was deleted.

.changes/unreleased/FEATURES-20240305-140346.yaml

-6
This file was deleted.

.changes/unreleased/FEATURES-20240305-140451.yaml

-6
This file was deleted.

.changes/unreleased/FEATURES-20240305-140622.yaml

-6
This file was deleted.

CHANGELOG.md

+28
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,31 @@
1+
## 0.19.0 (April 15, 2024)
2+
3+
BREAKING CHANGES:
4+
5+
* 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))
6+
* 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))
7+
8+
FEATURES:
9+
10+
* validate: Added support for Provider-defined Function documentation to all checks ([#341](https://github.com/hashicorp/terraform-plugin-docs/issues/341))
11+
* validate: Added `InvalidDirectoriesCheck` which checks for valid provider documentation folder structure ([#341](https://github.com/hashicorp/terraform-plugin-docs/issues/341))
12+
* 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))
13+
* 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))
14+
* validate: Added `FileSizeCheck` which checks the provider documentation file size against the registry limit ([#341](https://github.com/hashicorp/terraform-plugin-docs/issues/341))
15+
* validate: Added `FileExtensionCheck` which checks for valid provider documentation file extensions ([#341](https://github.com/hashicorp/terraform-plugin-docs/issues/341))
16+
* 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))
17+
* 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))
18+
19+
ENHANCEMENTS:
20+
21+
* 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))
22+
23+
BUG FIXES:
24+
25+
* 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))
26+
* 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))
27+
* 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))
28+
129
## 0.18.0 (January 24, 2024)
230

331
FEATURES:

0 commit comments

Comments
 (0)