Skip to content

Commit 15343a4

Browse files
(DOCS) Update changelog for preview.7
1 parent b0dc847 commit 15343a4

File tree

1 file changed

+82
-71
lines changed

1 file changed

+82
-71
lines changed

CHANGELOG.md

Lines changed: 82 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ This section includes a summary of user-facing changes since the last release. F
4545
changes since the last release, see the [diff on GitHub][unreleased].
4646

4747
<!-- Unreleased comparison link - always update version to match last release tag-->
48-
[unreleased]: https://github.com/PowerShell/DSC/compare/v3.0.0-alpha.5...main
48+
[unreleased]: https://github.com/PowerShell/DSC/compare/v3.0.0-preview.7...main
4949

5050
<!--
5151
Unreleased change entry instructions:
@@ -65,11 +65,22 @@ changes since the last release, see the [diff on GitHub][unreleased].
6565
docs-changelog-release-heading snippet to create the new release heading after this comment and
6666
before the first H3 for the changes.
6767
68-
After doing so, rename the unreleased reference links from `ur.##` to `<prefix>.##`, where
68+
After doing so, rename the unreleased reference links from `ur-##` to `<prefix>-##`, where
6969
<prefix> is a two-character prefix for the release. For alpha releases, we use `a#`, like `a5`
7070
for the `v3.0.0.0-alpha.5` release. Leave the release links under the release section.
7171
-->
7272

73+
<!-- Unreleased change links -->
74+
75+
## [v3.0.0-preview.7][release-v3.0.0-preview.7] - 2024-04-22
76+
77+
This section includes a summary of changes for the `preview.7` release. For the full list of changes
78+
in this release, see the [diff on GitHub][compare-v3.0.0-preview.7].
79+
80+
<!-- Release links -->
81+
[release-v3.0.0-preview.7]: https://github.com/PowerShell/DSC/releases/tag/v3.0.0-preview.7 "Link to the DSC v3.0.0-preview.7 release on GitHub"
82+
[compare-v3.0.0-preview.7]: https://github.com/PowerShell/DSC/compare/v3.0.0-alpha.4...v3.0.0-preview.7
83+
7384
### Changed
7485

7586
- The version segment of the schema URIs for DSC have been updated from `2023/10` to `2024/04` to
@@ -121,8 +132,8 @@ changes since the last release, see the [diff on GitHub][unreleased].
121132
they're _adapters_ between DSCv3 and resources defined in a different way.
122133

123134
Beyond using different terminology in the documentation, this change also renamed the resource
124-
manifest property `provider` to [adapter][ur-01], and the `requires` property in the output for
125-
`dsc resource list` has been renamed to [requireAdapter][ur-02].
135+
manifest property `provider` to [adapter][p7-01], and the `requires` property in the output for
136+
`dsc resource list` has been renamed to [requireAdapter][p7-02].
126137

127138
<details><summary>Related work items</summary>
128139

@@ -133,7 +144,7 @@ changes since the last release, see the [diff on GitHub][unreleased].
133144

134145
</details>
135146

136-
- <a id="camel-casing-secure-types"></a> Changed the casing for the [parameter type enums][ur-03]
147+
- <a id="camel-casing-secure-types"></a> Changed the casing for the [parameter type enums][p7-03]
137148
from `SecureString` to `secureString` and `SecureObject` to `secureObject`, to better match the
138149
type enumerations in ARM.
139150

@@ -170,7 +181,7 @@ changes since the last release, see the [diff on GitHub][unreleased].
170181
</details>
171182

172183
- Updated the default behavior of the [dsc resource list][cmd-rlist] command and added the new
173-
[--adapter][ur-04] option to the command.
184+
[--adapter][p7-04] option to the command.
174185

175186
Prior to this release, the command always called the `list` command for any discovered adapters,
176187
even when searching for a non-adapted resource by name. Enumerating the adapted resources can be
@@ -209,9 +220,9 @@ changes since the last release, see the [diff on GitHub][unreleased].
209220
### Added
210221

211222
- <a id="add-delete-operation" /></a> Added the [dsc resource delete][cmd-rdelete] command and the
212-
[delete][ur-05] operation property to the resource manifest. Prior to this release, resources had
223+
[delete][p7-05] operation property to the resource manifest. Prior to this release, resources had
213224
to handle deleting resources as part of their `set` operation, and the development guidance was
214-
to use the [_exist][ur-06] standard property to indicate whether a resource should exist.
225+
to use the [_exist][p7-06] standard property to indicate whether a resource should exist.
215226

216227
Now, resource authors can indicate through the resource manifest whether the resource supports
217228
the `delete` operation with a separate command or as part of the `set` operation. It can be
@@ -223,18 +234,18 @@ changes since the last release, see the [diff on GitHub][unreleased].
223234
command, the JSON input defines the filter to pass to the resource for deleting the instance. For
224235
more information, see [dsc resource delete command reference][cmd-rdelete].
225236

226-
If your resource handles deleting instances as part of `set`, use the [handlesExist][ur-07]
237+
If your resource handles deleting instances as part of `set`, use the [handlesExist][p7-07]
227238
property to tell DSC so. When this property is `true`, the resource has the
228-
[SetHandlesExist capability][ur-08].
239+
[SetHandlesExist capability][p7-08].
229240

230-
If your resource has a separate command for deleting instances, use the [delete][ur-05] property
241+
If your resource has a separate command for deleting instances, use the [delete][p7-05] property
231242
in your resource manifest to tell DSC and other tools how to invoke the operation. When this
232-
property is defined, the resource has the [Delete capability][ur-09].
243+
property is defined, the resource has the [Delete capability][p7-09].
233244

234245
If your resource handles deleting instances, you should add the `_exist` standard property to the
235-
resource's [instance schema][ur-10]. While you can use any property name for this, DSC is only aware of
246+
resource's [instance schema][p7-10]. While you can use any property name for this, DSC is only aware of
236247
deletion operations when you use the `_exist` property. DSC won't know to call the `delete`
237-
operation for resources that don't have the [SetHandlesExist][ur-08] capability.
248+
operation for resources that don't have the [SetHandlesExist][p7-08] capability.
238249

239250
For resources that implement `delete` but don't handle `_exist` in the `set` operation, DSC can
240251
now invoke the delete operation as-needed in a configuration whenever it enforces the desired
@@ -267,7 +278,7 @@ changes since the last release, see the [diff on GitHub][unreleased].
267278
securityContext: restricted
268279
```
269280

270-
For more information, see [DSC Configuration document metadata schema][ur-11].
281+
For more information, see [DSC Configuration document metadata schema][p7-11].
271282

272283
<details><summary>Related work items</summary>
273284

@@ -280,12 +291,12 @@ changes since the last release, see the [diff on GitHub][unreleased].
280291
commands. When you define the `args` list for the following commands, you can now define a
281292
special argument that the command expects to receive the compressed JSON data for:
282293

283-
- [delete][ur-12]
284-
- [export][ur-13]
285-
- [get][ur-14]
286-
- [set][ur-15]
287-
- [test][ur-16]
288-
- [validate][ur-17]
294+
- [delete][p7-12]
295+
- [export][p7-13]
296+
- [get][p7-14]
297+
- [set][p7-15]
298+
- [test][p7-16]
299+
- [validate][p7-17]
289300

290301
DSC sends data to these commands in three ways:
291302

@@ -319,7 +330,7 @@ changes since the last release, see the [diff on GitHub][unreleased].
319330
resources, so you can use properties of one resource instance as values for another. The
320331
`reference()` function only works for resources that DSC has already managed in a
321332
configuration. You should always add the resource you're referencing with the `reference()`
322-
function to the [dependsOn][ur-18] list for the instance using the reference.
333+
function to the [dependsOn][p7-18] list for the instance using the reference.
323334

324335
- The [createArray()][createArray()] function enables you to create arrays of a given type from
325336
values.
@@ -344,11 +355,11 @@ changes since the last release, see the [diff on GitHub][unreleased].
344355

345356
</details>
346357

347-
- <a id="add-kind-property" /></a> Added the [kind][ur-19] property to the resource manifest schema
348-
and the [output][ur-20] for the [dsc resource list][cmd-rlist] command. This property indicates
349-
whether the resource is a [group resource][ur-21] (`Group`), an [adapter resource][ur-22]
358+
- <a id="add-kind-property" /></a> Added the [kind][p7-19] property to the resource manifest schema
359+
and the [output][p7-20] for the [dsc resource list][cmd-rlist] command. This property indicates
360+
whether the resource is a [group resource][p7-21] (`Group`), an [adapter resource][p7-22]
350361
(`Adapter`), or neither (`Resource`). For more information, see
351-
[DSC Resource kind schema reference][ur-23].
362+
[DSC Resource kind schema reference][p7-23].
352363

353364
This property is mandatory in the resource manifest for group resources. If your resource
354365
manifest doesn't define the `kind` property, DSC can infer whether the resource is an adapter
@@ -363,7 +374,7 @@ changes since the last release, see the [diff on GitHub][unreleased].
363374

364375
</details>
365376

366-
- <a id="add-capabilities" /></a> Added the [capabilities][ur-24] property to the output for the
377+
- <a id="add-capabilities" /></a> Added the [capabilities][p7-24] property to the output for the
367378
[dsc resource list][cmd-rlist] command. The `capabilities` property indicates how you can use the
368379
DSC Resource and how DSC and other higher order tools should handle it.
369380

@@ -379,12 +390,12 @@ changes since the last release, see the [diff on GitHub][unreleased].
379390
and information about the operation. See the output reference for each command for more
380391
information:
381392

382-
- [dsc config get][ur-25]
383-
- [dsc config test][ur-26]
384-
- [dsc config set][ur-27]
385-
- [dsc resource get][ur-28]
386-
- [dsc resource test][ur-29]
387-
- [dsc resource set][ur-30]
393+
- [dsc config get][p7-25]
394+
- [dsc config test][p7-26]
395+
- [dsc config set][p7-27]
396+
- [dsc resource get][p7-28]
397+
- [dsc resource test][p7-29]
398+
- [dsc resource set][p7-30]
388399

389400
<details><summary>Related work items</summary>
390401

@@ -393,7 +404,7 @@ changes since the last release, see the [diff on GitHub][unreleased].
393404

394405
</details>
395406

396-
- Added parsing for [configuration functions][cfuncs] in the [default values][ur-31] of parameters.
407+
- Added parsing for [configuration functions][cfuncs] in the [default values][p7-31] of parameters.
397408
Prior to this release, DSC interpreted configuration functions in parameter default values as
398409
literal strings.
399410

@@ -404,8 +415,8 @@ changes since the last release, see the [diff on GitHub][unreleased].
404415

405416
</details>
406417

407-
- Added type validation for parameter [default values][ur-31]. Prior to this release, DSC didn't
408-
validate that the default value for a parameter was valid for the parameter's [type][ur-32].
418+
- Added type validation for parameter [default values][p7-31]. Prior to this release, DSC didn't
419+
validate that the default value for a parameter was valid for the parameter's [type][p7-32].
409420

410421
<details><summary>Related work items</summary>
411422

@@ -428,7 +439,7 @@ changes since the last release, see the [diff on GitHub][unreleased].
428439
DSC emits these messages along with its own messages when the specified trace level for the
429440
command is equal to or lower than the message's level.
430441

431-
For more information about trace levels, see the [--trace-level][ur-33] option for the
442+
For more information about trace levels, see the [--trace-level][p7-33] option for the
432443
[dsc][cmd] root command.
433444

434445
<details><summary>Related work items</summary>
@@ -506,40 +517,40 @@ changes since the last release, see the [diff on GitHub][unreleased].
506517

507518
</details>
508519

509-
<!-- Unreleased change links -->
510-
[ur-01]: ./docs/reference/schemas/resource/manifest/adapter.md
511-
[ur-02]: ./docs/reference/schemas/outputs/resource/list.md#requireadapter
512-
[ur-03]: ./docs/reference/schemas/definitions/parameters/dataTypes.md
513-
[ur-04]: ./docs/reference/cli/resource/list.md#-a---adapter
514-
[ur-05]: ./docs/reference/schemas/resource/manifest/delete.md
515-
[ur-06]: ./docs/reference/schemas/resource/properties/exist.md
516-
[ur-07]: ./docs/reference/schemas/resource/manifest/set.md#handlesexist
517-
[ur-08]: ./docs/reference/schemas/outputs/resource/list.md#capability-sethandlesexist
518-
[ur-09]: ./docs/reference/schemas/outputs/resource/list.md#capability-delete
519-
[ur-10]: ./docs/reference/schemas/resource/manifest/root.md#schema-1
520-
[ur-11]: ./docs/reference/schemas/config/metadata.md
521-
[ur-12]: ./docs/reference/schemas/resource/manifest/delete.md#json-input-argument
522-
[ur-13]: ./docs/reference/schemas/resource/manifest/export.md#json-input-argument
523-
[ur-14]: ./docs/reference/schemas/resource/manifest/get.md#json-input-argument
524-
[ur-15]: ./docs/reference/schemas/resource/manifest/set.md#json-input-argument
525-
[ur-16]: ./docs/reference/schemas/resource/manifest/test.md#json-input-argument
526-
[ur-17]: ./docs/reference/schemas/resource/manifest/validate.md#json-input-argument
527-
[ur-18]: ./docs/reference/schemas/config/resource.md#dependsOn
528-
[ur-19]: ./docs/reference/schemas/resource/manifest/root.md#kind
529-
[ur-20]: ./docs/reference/schemas/outputs/resource/list.md
530-
[ur-21]: ./docs/reference/schemas/definitions/resourceKind.md#group-resources
531-
[ur-22]: ./docs/reference/schemas/definitions/resourceKind.md#adapter-resources
532-
[ur-23]: ./docs/reference/schemas/definitions/resourceKind.md
533-
[ur-24]: ./docs/reference/schemas/outputs/resource/list.md#capabilities
534-
[ur-25]: ./docs/reference/schemas/outputs/config/get.md#metadata-1
535-
[ur-26]: ./docs/reference/schemas/outputs/config/test.md#metadata-1
536-
[ur-27]: ./docs/reference/schemas/outputs/config/set.md#metadata-1
537-
[ur-28]: ./docs/reference/schemas/outputs/resource/get.md#metadata-1
538-
[ur-29]: ./docs/reference/schemas/outputs/resource/test.md#metadata-1
539-
[ur-30]: ./docs/reference/schemas/outputs/resource/set.md#metadata-1
540-
[ur-31]: ./docs/reference/schemas/config/parameter.md#defaultvalue
541-
[ur-32]: ./docs/reference/schemas/config/parameter.md#type
542-
[ur-33]: ./docs/reference/cli/dsc.md#-l---trace-level
520+
<!-- preview.7 change links -->
521+
[p7-01]: ./docs/reference/schemas/resource/manifest/adapter.md
522+
[p7-02]: ./docs/reference/schemas/outputs/resource/list.md#requireadapter
523+
[p7-03]: ./docs/reference/schemas/definitions/parameters/dataTypes.md
524+
[p7-04]: ./docs/reference/cli/resource/list.md#-a---adapter
525+
[p7-05]: ./docs/reference/schemas/resource/manifest/delete.md
526+
[p7-06]: ./docs/reference/schemas/resource/properties/exist.md
527+
[p7-07]: ./docs/reference/schemas/resource/manifest/set.md#handlesexist
528+
[p7-08]: ./docs/reference/schemas/outputs/resource/list.md#capability-sethandlesexist
529+
[p7-09]: ./docs/reference/schemas/outputs/resource/list.md#capability-delete
530+
[p7-10]: ./docs/reference/schemas/resource/manifest/root.md#schema-1
531+
[p7-11]: ./docs/reference/schemas/config/metadata.md
532+
[p7-12]: ./docs/reference/schemas/resource/manifest/delete.md#json-input-argument
533+
[p7-13]: ./docs/reference/schemas/resource/manifest/export.md#json-input-argument
534+
[p7-14]: ./docs/reference/schemas/resource/manifest/get.md#json-input-argument
535+
[p7-15]: ./docs/reference/schemas/resource/manifest/set.md#json-input-argument
536+
[p7-16]: ./docs/reference/schemas/resource/manifest/test.md#json-input-argument
537+
[p7-17]: ./docs/reference/schemas/resource/manifest/validate.md#json-input-argument
538+
[p7-18]: ./docs/reference/schemas/config/resource.md#dependsOn
539+
[p7-19]: ./docs/reference/schemas/resource/manifest/root.md#kind
540+
[p7-20]: ./docs/reference/schemas/outputs/resource/list.md
541+
[p7-21]: ./docs/reference/schemas/definitions/resourceKind.md#group-resources
542+
[p7-22]: ./docs/reference/schemas/definitions/resourceKind.md#adapter-resources
543+
[p7-23]: ./docs/reference/schemas/definitions/resourceKind.md
544+
[p7-24]: ./docs/reference/schemas/outputs/resource/list.md#capabilities
545+
[p7-25]: ./docs/reference/schemas/outputs/config/get.md#metadata-1
546+
[p7-26]: ./docs/reference/schemas/outputs/config/test.md#metadata-1
547+
[p7-27]: ./docs/reference/schemas/outputs/config/set.md#metadata-1
548+
[p7-28]: ./docs/reference/schemas/outputs/resource/get.md#metadata-1
549+
[p7-29]: ./docs/reference/schemas/outputs/resource/test.md#metadata-1
550+
[p7-30]: ./docs/reference/schemas/outputs/resource/set.md#metadata-1
551+
[p7-31]: ./docs/reference/schemas/config/parameter.md#defaultvalue
552+
[p7-32]: ./docs/reference/schemas/config/parameter.md#type
553+
[p7-33]: ./docs/reference/cli/dsc.md#-l---trace-level
543554

544555
## [v3.0.0-alpha.5][release-v3.0.0-alpha.5] - 2024-02-27
545556

0 commit comments

Comments
 (0)