Skip to content

Commit f7c0e8a

Browse files
(DOCS) Update reference/changelog for preview.8
This change updates the reference documentation and changelog for the rest of the PRs in the `preview.8` release. It includes some fixes for the docs discovered when publishing to the Learn platform.
1 parent b017179 commit f7c0e8a

File tree

11 files changed

+462
-190
lines changed

11 files changed

+462
-190
lines changed

CHANGELOG.md

+79-28
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22
title: "Desired State Configuration changelog"
33
description: >-
44
A log of the changes for releases of DSCv3.
5-
ms.date: 03/06/2024
5+
ms.topic: whats-new
6+
ms.date: 06/24/2024
67
---
78

89
# Changelog
@@ -45,7 +46,7 @@ This section includes a summary of user-facing changes since the last release. F
4546
changes since the last release, see the [diff on GitHub][unreleased].
4647

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

5051
<!--
5152
Unreleased change entry instructions:
@@ -70,25 +71,55 @@ changes since the last release, see the [diff on GitHub][unreleased].
7071
for the `v3.0.0.0-alpha.5` release. Leave the release links under the release section.
7172
-->
7273

74+
<!-- Unreleased change links -->
75+
76+
## [v3.0.0-preview.8][release-v3.0.0-preview.8] - 2024-06-19
77+
78+
This section includes a summary of changes for the `preview.8` release. For the full list of changes
79+
in this release, see the [diff on GitHub][compare-v3.0.0-preview.8].
80+
81+
<!-- Release links -->
82+
[release-v3.0.0-preview.8]: https://github.com/PowerShell/DSC/releases/tag/v3.0.0-preview.8 "Link to the DSC v3.0.0-preview.8 release on GitHub"
83+
[compare-v3.0.0-preview.8]: https://github.com/PowerShell/DSC/compare/v3.0.0-preview.7...v3.0.0-preview.8
84+
85+
### Changed
86+
87+
- Changed the `Microsoft.DSC/PowerShell` adapter to only handle PowerShell DSC Resources
88+
implemented as classes and remove the dependency on the **PSDesiredStateConfiguration** module.
89+
The `Microsoft.Windows/WindowsPowerShell` adapter continues to work with classic PSDSC resources.
90+
Neither adapter supports composite PSDSC resources. This change simplified the code and coincided
91+
with ensuring that the `Microsoft.DSC/PowerShell` adapter works correctly on Linux and macOS as
92+
well as Windows. This change also brought performance improvements to the adapter, speeding up
93+
resource invocation and discovery.
94+
95+
<details><summary>Related work items</summary>
96+
97+
- Issues: _None_.
98+
- PRs:
99+
- [#435][#435]
100+
- [#439][#439]
101+
102+
</details>
103+
73104
### Added
74105

75-
- Added the [`--what-if` (`-w`)][ur-aa] option to the [dsc config set][cmd-cset] command. When you
106+
- Added the [`--what-if` (`-w`)][p8-01] option to the [dsc config set][cmd-cset] command. When you
76107
call `dsc config set` with the `--what-if` option, DSC doesn't actually invoke the resources to
77108
enforce the desired state. Instead, it returns the expected output for the command, showing the
78109
before and after state for each resource instance.
79110

80111
The output for the `dsc config set` operation with the `--what-if` operation is the same as an
81-
[actual configuration set operation][ur-ab], except that the metadata field
82-
[executionType][ur-ac] is set to `WhatIf` instead of `Actual`.
112+
[actual configuration set operation][p8-02], except that the metadata field
113+
[executionType][p8-03] is set to `WhatIf` instead of `Actual`.
83114

84115
By default, the generated output is synthetic, based on the results of the resources' `test`
85-
operation. Resources can define the [whatIf][ur-ad] property in their resource manifest to
116+
operation. Resources can define the [whatIf][p8-04] property in their resource manifest to
86117
participate in what-if operations, reporting more specifically how they will change the system.
87118
For example, participating resources could indicate whether an actual set operation will require
88119
a reboot or whether the current user has the correct permissions to manage that resource
89120
instance.
90121

91-
Participating resources have the [WhatIf capability][ur-ae].
122+
Participating resources have the [WhatIf capability][p8-05].
92123

93124
<details><summary>Related work items</summary>
94125

@@ -99,21 +130,23 @@ changes since the last release, see the [diff on GitHub][unreleased].
99130

100131
</details>
101132

102-
- Added support for [importer resources][ur-af]. These resources resolve external sources to a
133+
- Added support for [importer resources][p8-06]. These resources resolve external sources to a
103134
nested DSC Configuration document. The resolved instances are processed as nested resource
104135
instances.
105136

106137
This required some updates to the schemas, all backwards-compatible:
107138

108-
- Added a new [resourceKind][ur-ag] named `Import`.
109-
- Added the [resolve][ur-ah] command to resource manifests.
110-
- Added the new [`Resolve`][ur-ai] capability, returned in the output for the
139+
- Added a new [resourceKind][p8-07] named `Import`.
140+
- Added the [resolve][p8-08] command to resource manifests.
141+
- Added the new [`Resolve`][p8-09] capability, returned in the output for the
111142
[dsc resource list][cmd-rlist] command when DSC discovers an importer resource.
112143

113144
<details><summary>Related work items</summary>
114145

115146
- Issues: [#429][#429]
116-
- PRs: [#412][#412]
147+
- PRs:
148+
- [#412][#412]
149+
- [#464][#464]
117150

118151
</details>
119152

@@ -207,9 +240,20 @@ changes since the last release, see the [diff on GitHub][unreleased].
207240

208241
</details>
209242

243+
- Added the `Microsoft.DSC.Experimental/SystemctlService` class-based PSDSC resource. It has the
244+
`Get` and `Export` [capabilities][p8-10]. You can use it on Linux systems that manage services
245+
with SystemD and `systemctl`. In this release, it doesn't support setting services.
246+
247+
<details><summary>Related work items</summary>
248+
249+
- Issues: _None_.
250+
- PRs: [#454][#454]
251+
252+
</details>
253+
210254
### Fixed
211255

212-
- Fixed the JSON Schema for [exit codes][ur-fa] in the resource manifest to support negative
256+
- Fixed the JSON Schema for [exit codes][p8-11] in the resource manifest to support negative
213257
integers. Prior to this release, the DSC engine supported negative exit codes but the JSON Schema
214258
forbid them.
215259

@@ -243,17 +287,18 @@ changes since the last release, see the [diff on GitHub][unreleased].
243287

244288
</details>
245289

246-
<!-- Unreleased change links -->
247-
[ur-aa]: ./docs/reference/cli/config/set.md#-w---what-if
248-
[ur-ab]: ./docs/reference/schemas/outputs/config/set.md
249-
[ur-ac]: ./docs/reference/schemas/metadata/Microsoft.DSC/properties.md#executiontype
250-
[ur-ad]: ./docs/reference/schemas/resource/manifest/whatif.md
251-
[ur-ae]: ./docs/reference/schemas/outputs/resource/list.md#capability-whatif
252-
[ur-af]: ./docs/reference/schemas/definitions/resourceKind.md#importer-resources
253-
[ur-ag]: ./docs/reference/schemas/definitions/resourceKind.md
254-
[ur-ah]: ./docs/reference/schemas/resource/manifest/resolve.md
255-
[ur-ai]: ./docs/reference/schemas/outputs/resource/list.md#capability-resolve
256-
[ur-fa]: ./docs/reference/schemas/resource/manifest/root.md#exitcodes
290+
<!-- Preview.8 links -->
291+
[p8-01]: ./docs/reference/cli/config/set.md#-w---what-if
292+
[p8-02]: ./docs/reference/schemas/outputs/config/set.md
293+
[p8-03]: ./docs/reference/schemas/metadata/Microsoft.DSC/properties.md#executiontype
294+
[p8-04]: ./docs/reference/schemas/resource/manifest/whatif.md
295+
[p8-05]: ./docs/reference/schemas/outputs/resource/list.md#capability-whatif
296+
[p8-06]: ./docs/reference/schemas/definitions/resourceKind.md#importer-resources
297+
[p8-07]: ./docs/reference/schemas/definitions/resourceKind.md
298+
[p8-08]: ./docs/reference/schemas/resource/manifest/resolve.md
299+
[p8-09]: ./docs/reference/schemas/outputs/resource/list.md#capability-resolve
300+
[p8-10]: ./docs/reference/schemas/outputs/resource/list.md#capabilities
301+
[p8-11]: ./docs/reference/schemas/resource/manifest/root.md#exitcodes
257302

258303
## [v3.0.0-preview.7][release-v3.0.0-preview.7] - 2024-04-22
259304

@@ -309,10 +354,12 @@ in this release, see the [diff on GitHub][compare-v3.0.0-preview.7].
309354

310355
</details>
311356

312-
- <a id="rename-provider-to-adapter" /> In this release, the term `DSC Resource Provider` is
313-
replaced with the more semantically accurate `DSC Resource Adapter`. These resources enable users
314-
to leverage resources that don't define a DSC Resource Manifest with DSC, like PSDSC resources -
315-
they're _adapters_ between DSCv3 and resources defined in a different way.
357+
- <a id="rename-provider-to-adapter"></a>
358+
359+
In this release, the term `DSC Resource Provider` is replaced with the more semantically accurate
360+
`DSC Resource Adapter`. These resources enable users to leverage resources that don't define a
361+
DSC Resource Manifest with DSC, like PSDSC resources - they're _adapters_ between DSCv3 and
362+
resources defined in a different way.
316363

317364
Beyond using different terminology in the documentation, this change also renamed the resource
318365
manifest property `provider` to [adapter][p7-01], and the `requires` property in the output for
@@ -1522,9 +1569,13 @@ For the full list of changes in this release, see the [diff on GitHub][compare-v
15221569
[#431]: https://github.com/PowerShell/DSC/issues/431
15231570
[#432]: https://github.com/PowerShell/DSC/issues/432
15241571
[#434]: https://github.com/PowerShell/DSC/issues/434
1572+
[#435]: https://github.com/PowerShell/DSC/issues/435
15251573
[#438]: https://github.com/PowerShell/DSC/issues/438
1574+
[#439]: https://github.com/PowerShell/DSC/issues/439
15261575
[#441]: https://github.com/PowerShell/DSC/issues/441
15271576
[#444]: https://github.com/PowerShell/DSC/issues/444
1577+
[#454]: https://github.com/PowerShell/DSC/issues/454
1578+
[#464]: https://github.com/PowerShell/DSC/issues/464
15281579
[#45]: https://github.com/PowerShell/DSC/issues/45
15291580
[#49]: https://github.com/PowerShell/DSC/issues/49
15301581
[#57]: https://github.com/PowerShell/DSC/issues/57

docs/reference/cli/config/get.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
description: Command line reference for the 'dsc config get' command
3-
ms.date: 01/17/2024
3+
ms.date: 06/24/2024
44
ms.topic: reference
55
title: dsc config get
66
---
@@ -52,7 +52,7 @@ document saved as `example.dsc.config.yaml`.
5252
$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
5353
resources:
5454
- name: Windows only
55-
type: DSC/AssertionGroup
55+
type: Microsoft.DSC/Assertion
5656
properties:
5757
$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
5858
resources:
@@ -64,9 +64,9 @@ resources:
6464
type: Microsoft.Windows/Registry
6565
properties:
6666
keyPath: HKCU\example
67-
_ensure: Present
67+
_exist: true
6868
dependsOn:
69-
- '[DSC/Assertion]Windows only'
69+
- "[resourceId('Microsoft.DSC/Assertion', 'Windows only')"
7070
```
7171
7272
```sh

docs/reference/cli/config/set.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
description: Command line reference for the 'dsc config set' command
3-
ms.date: 01/17/2024
3+
ms.date: 06/24/2024
44
ms.topic: reference
55
title: dsc config set
66
---
@@ -53,7 +53,7 @@ The command inspects the resource instances defined in the configuration documen
5353
$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
5454
resources:
5555
- name: Windows only
56-
type: DSC/AssertionGroup
56+
type: Microsoft.DSC/Assertion
5757
properties:
5858
$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
5959
resources:
@@ -65,9 +65,9 @@ resources:
6565
type: Microsoft.Windows/Registry
6666
properties:
6767
keyPath: HKCU\example
68-
_ensure: Present
68+
_exist: true
6969
dependsOn:
70-
- '[DSC/Assertion]Windows only'
70+
- "[resourceId('Microsoft.DSC/Assertion', 'Windows only')"
7171
```
7272
7373
```sh

docs/reference/cli/config/test.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
description: Command line reference for the 'dsc config test' command
3-
ms.date: 01/17/2024
3+
ms.date: 06/24/2024
44
ms.topic: reference
55
title: dsc config test
66
---
@@ -52,7 +52,7 @@ resource instances defined in the configuration document saved as `example.dsc.c
5252
$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
5353
resources:
5454
- name: Windows only
55-
type: DSC/AssertionGroup
55+
type: Microsoft.DSC/Assertion
5656
properties:
5757
$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
5858
resources:
@@ -64,9 +64,9 @@ resources:
6464
type: Microsoft.Windows/Registry
6565
properties:
6666
keyPath: HKCU\example
67-
_ensure: Present
67+
_exist: true
6868
dependsOn:
69-
- '[DSC/Assertion]Windows only'
69+
- "[resourceId('Microsoft.DSC/Assertion', 'Windows only')"
7070
```
7171
7272
```sh

0 commit comments

Comments
 (0)