Skip to content

Commit 1e45fdb

Browse files
authored
Update for change log (#299)
1 parent 79cdf3e commit 1e45fdb

File tree

1 file changed

+74
-32
lines changed

1 file changed

+74
-32
lines changed

CHANGELOG.md

Lines changed: 74 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -2,26 +2,42 @@
22

33
## Unreleased
44

5+
What's changed since pre-release v0.4.0-B2107030:
6+
7+
- General improvements:
8+
- Add support for BRM schema changes by @jtracey93.
9+
[#258](https://github.com/Azure/PSDocs.Azure/pull/258)
10+
- Add support for min/max values and length for arrays/string properties by @Gabriel123N.
11+
[#263](https://github.com/Azure/PSDocs.Azure/pull/263)
12+
- Engineering:
13+
- Bump Newtonsoft.Json to v13.0.3.
14+
[#241](https://github.com/Azure/PSDocs.Azure/pull/241)
15+
516
## v0.4.0-B2107030 (pre-release)
617

718
What's changed since pre-release v0.4.0-B2107016:
819

920
- Engineering:
10-
- Bump PSDocs dependency to v0.9.0. [#102](https://github.com/Azure/PSDocs.Azure/issues/102)
21+
- Bump PSDocs to v0.9.0.
22+
[#102](https://github.com/Azure/PSDocs.Azure/issues/102)
1123

1224
## v0.4.0-B2107016 (pre-release)
1325

1426
What's changed since pre-release v0.4.0-B2107004:
1527

1628
- General improvements:
17-
- Secret string parameters now include an example Key Vault reference. [#94](https://github.com/Azure/PSDocs.Azure/issues/94)
18-
- Improved output of parameter object default values. [#84](https://github.com/Azure/PSDocs.Azure/issues/84)
29+
- Secret string parameters now include an example Key Vault reference.
30+
[#94](https://github.com/Azure/PSDocs.Azure/issues/94)
31+
- Improved output of parameter object default values.
32+
[#84](https://github.com/Azure/PSDocs.Azure/issues/84)
1933
- Default values and allowed values now appear in a code block.
20-
- Allow optional parameters to be skipped in snippet. [#96](https://github.com/Azure/PSDocs.Azure/issues/96)
34+
- Allow optional parameters to be skipped in snippet.
35+
[#96](https://github.com/Azure/PSDocs.Azure/issues/96)
2136
- To exclude optional parameters from snippets configure `AZURE_SNIPPET_SKIP_OPTIONAL_PARAMETER`.
2237
- See [about_PSDocs_Azure_Configuration] for details.
2338
- Bug fixes:
24-
- Ignore function default values in snippets. [#95](https://github.com/Azure/PSDocs.Azure/issues/95)
39+
- Ignore function default values in snippets.
40+
[#95](https://github.com/Azure/PSDocs.Azure/issues/95)
2541
- To include parameters using a function default value configure `AZURE_SNIPPET_SKIP_DEFAULT_VALUE_FN`.
2642
- See [about_PSDocs_Azure_Configuration] for details.
2743

@@ -30,26 +46,31 @@ What's changed since pre-release v0.4.0-B2107004:
3046
What's changed since v0.3.0:
3147

3248
- New Features:
33-
- Automatically detect templates in a scan path. [#85](https://github.com/Azure/PSDocs.Azure/issues/85)
49+
- Automatically detect templates in a scan path.
50+
[#85](https://github.com/Azure/PSDocs.Azure/issues/85)
3451
- To scan templates use `Invoke-PSDocument` with `-InputPath`.
3552

3653
## v0.3.0
3754

3855
What's changed since v0.2.0:
3956

4057
- New Features:
41-
- Added support for naming document by parent path using conventions. [#43](https://github.com/Azure/PSDocs.Azure/issues/43)
58+
- Added support for naming document by parent path using conventions.
59+
[#43](https://github.com/Azure/PSDocs.Azure/issues/43)
4260
- Add the `-Convention` parameter with `Azure.NameByParentPath` to use.
4361
- See [about_PSDocs_Azure_Conventions] for details.
4462
- General improvements:
45-
- Added support for reading template metadata from `metadata.json`. [#32](https://github.com/Azure/PSDocs.Azure/issues/32)
63+
- Added support for reading template metadata from `metadata.json`.
64+
[#32](https://github.com/Azure/PSDocs.Azure/issues/32)
4665
- This adds additional compatibility for the Azure Quickstart templates repository.
4766
- Additional metadata from `metadata.json` will be read when it exists.
4867
- Template metadata take priority over `metadata.json`.
49-
- Added support for the `summary` template metadata property. [#60](https://github.com/Azure/PSDocs.Azure/issues/60)
68+
- Added support for the `summary` template metadata property.
69+
[#60](https://github.com/Azure/PSDocs.Azure/issues/60)
5070
- The `summary` template metadata property is intended to provide a short description of the template.
5171
- Use the `description` template metadata property to provide a detailed description of the template.
52-
- Added ability to detect required or optional for each parameter. [#55](https://github.com/Azure/PSDocs.Azure/issues/55)
72+
- Added ability to detect required or optional for each parameter.
73+
[#55](https://github.com/Azure/PSDocs.Azure/issues/55)
5374
- Detects if parameter is either _Optional_ or _Required_ based on the availability of `DefaultValue` or `AllowedValues`.
5475
- Added a _Required_ column in the parameters table.
5576
- Added _Required_ and _Optional_ badge for each parameter in the detailed parameter section.
@@ -63,7 +84,8 @@ What's changed since pre-release v0.3.0-B2103037:
6384
What's changed since pre-release v0.3.0-B2103011:
6485

6586
- General improvements:
66-
- Added ability to detect required or optional for each parameter. [#55](https://github.com/Azure/PSDocs.Azure/issues/55)
87+
- Added ability to detect required or optional for each parameter.
88+
[#55](https://github.com/Azure/PSDocs.Azure/issues/55)
6789
- Detects if parameter is either _Optional_ or _Required_ based on the availability of `DefaultValue` or `AllowedValues`.
6890
- Added a _Required_ column in the parameters table.
6991
- Added _Required_ and _Optional_ badge for each parameter in the detailed parameter section.
@@ -73,15 +95,18 @@ What's changed since pre-release v0.3.0-B2103011:
7395
What's changed since v0.2.0:
7496

7597
- New Features:
76-
- Added support for naming document by parent path using conventions. [#43](https://github.com/Azure/PSDocs.Azure/issues/43)
98+
- Added support for naming document by parent path using conventions.
99+
[#43](https://github.com/Azure/PSDocs.Azure/issues/43)
77100
- Add the `-Convention` parameter with `Azure.NameByParentPath` to use.
78101
- See [about_PSDocs_Azure_Conventions] for details.
79102
- General improvements:
80-
- Added support for reading template metadata from `metadata.json`. [#32](https://github.com/Azure/PSDocs.Azure/issues/32)
103+
- Added support for reading template metadata from `metadata.json`.
104+
[#32](https://github.com/Azure/PSDocs.Azure/issues/32)
81105
- This adds additional compatibility for the Azure Quickstart templates repository.
82106
- Additional metadata from `metadata.json` will be read when it exists.
83107
- Template metadata take priority over `metadata.json`.
84-
- Added support for the `summary` template metadata property. [#60](https://github.com/Azure/PSDocs.Azure/issues/60)
108+
- Added support for the `summary` template metadata property.
109+
[#60](https://github.com/Azure/PSDocs.Azure/issues/60)
85110
- The `summary` template metadata property is intended to provide a short description of the template.
86111
- Use the `description` template metadata property to provide a detailed description of the template.
87112

@@ -90,23 +115,31 @@ What's changed since v0.2.0:
90115
What's changed since v0.1.0:
91116

92117
- New Features:
93-
- Added the ability to enable manual command line snippet. [#40](https://github.com/Azure/PSDocs.Azure/issues/40)
118+
- Added the ability to enable manual command line snippet.
119+
[#40](https://github.com/Azure/PSDocs.Azure/issues/40)
94120
- To enable parameter file snippet set configuration `AZURE_USE_COMMAND_LINE_SNIPPET`.
95121
- See [about_PSDocs_Azure_Configuration] for details.
96-
- Added the ability to disable parameter file snippet. [#31](https://github.com/Azure/PSDocs.Azure/issues/31)
122+
- Added the ability to disable parameter file snippet.
123+
[#31](https://github.com/Azure/PSDocs.Azure/issues/31)
97124
- To disable parameter file snippet set configuration `AZURE_USE_PARAMETER_FILE_SNIPPET`.
98125
- See [about_PSDocs_Azure_Configuration] for details.
99-
- Added the ability to include badges in template document. [#30](https://github.com/Azure/PSDocs.Azure/issues/30)
126+
- Added the ability to include badges in template document.
127+
[#30](https://github.com/Azure/PSDocs.Azure/issues/30)
100128
- Set the `.ps-docs/azure-template-badges.md` file to include badge content.
101129
- See [about_PSDocs_Azure_Badges] for details.
102-
- Template outputs are added to generated document. [#28](https://github.com/Azure/PSDocs.Azure/issues/28)
130+
- Template outputs are added to generated document.
131+
[#28](https://github.com/Azure/PSDocs.Azure/issues/28)
103132
- General Improvements
104-
- Minor update to the documentation to include OutputPath to generate README.md [#50](https://github.com/Azure/PSDocs.Azure/issues/50)
133+
- Minor update to the documentation to include OutputPath to generate README.md.
134+
[#50](https://github.com/Azure/PSDocs.Azure/issues/50)
105135
- Engineering:
106-
- Bump PSDocs dependency to v0.8.0. [#42](https://github.com/Azure/PSDocs.Azure/issues/42)
136+
- Bump PSDocs to v0.8.0.
137+
[#42](https://github.com/Azure/PSDocs.Azure/issues/42)
107138
- Bug fixes:
108-
- Fixed snippet with short relative template causes exception. [#26](https://github.com/Azure/PSDocs.Azure/issues/26)
109-
- Fixed cannot bind argument when metadata name is not set. [#35](https://github.com/Azure/PSDocs.Azure/issues/35)
139+
- Fixed snippet with short relative template causes exception.
140+
[#26](https://github.com/Azure/PSDocs.Azure/issues/26)
141+
- Fixed cannot bind argument when metadata name is not set.
142+
[#35](https://github.com/Azure/PSDocs.Azure/issues/35)
110143

111144
What's changed since pre-release v0.2.0-B2102012:
112145

@@ -117,7 +150,8 @@ What's changed since pre-release v0.2.0-B2102012:
117150
What's changed since pre-release v0.2.0-B2102005:
118151

119152
- New features:
120-
- Added the ability to enable manual command line snippet. [#40](https://github.com/Azure/PSDocs.Azure/issues/40)
153+
- Added the ability to enable manual command line snippet.
154+
[#40](https://github.com/Azure/PSDocs.Azure/issues/40)
121155
- To enable parameter file snippet set configuration `AZURE_USE_COMMAND_LINE_SNIPPET`.
122156
- See [about_PSDocs_Azure_Configuration] for details.
123157

@@ -126,24 +160,30 @@ What's changed since pre-release v0.2.0-B2102005:
126160
What's changed since pre-release v0.2.0-B2101002:
127161

128162
- New features:
129-
- Added the ability to disable parameter file snippet. [#31](https://github.com/Azure/PSDocs.Azure/issues/31)
163+
- Added the ability to disable parameter file snippet.
164+
[#31](https://github.com/Azure/PSDocs.Azure/issues/31)
130165
- To disable parameter file snippet set configuration `AZURE_USE_PARAMETER_FILE_SNIPPET`.
131166
- See [about_PSDocs_Azure_Configuration] for details.
132-
- Added the ability to include badges in template document. [#30](https://github.com/Azure/PSDocs.Azure/issues/30)
167+
- Added the ability to include badges in template document.
168+
[#30](https://github.com/Azure/PSDocs.Azure/issues/30)
133169
- Set the `.ps-docs/azure-template-badges.md` file to include badge content.
134170
- See [about_PSDocs_Azure_Badges] for details.
135171
- Engineering:
136-
- Bump PSDocs dependency to v0.8.0. [#42](https://github.com/Azure/PSDocs.Azure/issues/42)
172+
- Bump PSDocs to v0.8.0.
173+
[#42](https://github.com/Azure/PSDocs.Azure/issues/42)
137174

138175
## v0.2.0-B2101002 (pre-release)
139176

140177
What's changed since v0.1.0:
141178

142179
- New features:
143-
- Template outputs are added to generated document. [#28](https://github.com/Azure/PSDocs.Azure/issues/28)
180+
- Template outputs are added to generated document.
181+
[#28](https://github.com/Azure/PSDocs.Azure/issues/28)
144182
- Bug fixes:
145-
- Fixed snippet with short relative template causes exception. [#26](https://github.com/Azure/PSDocs.Azure/issues/26)
146-
- Fixed cannot bind argument when metadata name is not set. [#35](https://github.com/Azure/PSDocs.Azure/issues/35)
183+
- Fixed snippet with short relative template causes exception.
184+
[#26](https://github.com/Azure/PSDocs.Azure/issues/26)
185+
- Fixed cannot bind argument when metadata name is not set.
186+
[#35](https://github.com/Azure/PSDocs.Azure/issues/35)
147187

148188
## v0.1.0
149189

@@ -152,11 +192,13 @@ What's changed since v0.1.0:
152192
What's changed since pre-release v0.1.0-B2012006:
153193

154194
- New features:
155-
- Added `Get-AzDocTemplateFile` cmdlet to scan for template files within a path. [#16](https://github.com/Azure/PSDocs.Azure/issues/16)
195+
- Added `Get-AzDocTemplateFile` cmdlet to scan for template files within a path.
196+
[#16](https://github.com/Azure/PSDocs.Azure/issues/16)
156197
- General improvements:
157-
- Added support for document localization and JSON snippet formatting. [#18](https://github.com/Azure/PSDocs.Azure/issues/18)
198+
- Added support for document localization and JSON snippet formatting.
199+
[#18](https://github.com/Azure/PSDocs.Azure/issues/18)
158200
- Engineering:
159-
- Bump PSDocs dependency to v0.7.0.
201+
- Bump PSDocs to v0.7.0.
160202

161203
## v0.1.0-B2012006 (pre-release)
162204

0 commit comments

Comments
 (0)