Merge branch 'reference-doc-sshdconfig' of https://github.com/Gijsreyn/operation-methods into reference-doc-sshdconfig

Author: Gijsreyn

.github/workflows/rust.yml

@@ -2,9 +2,9 @@ name: Rust
 
 on:
   push:
-    branches: [ "main", "release/v3.0.0", "release/v3.1" ]
+    branches: [ "main", "release/*" ]
   pull_request:
-    branches: [ "main", "release/v3.0.0", "release/v3.1" ]
+    branches: [ "main", "release/*" ]
     paths-ignore:
       - "docs/**"
       - "*.md"

.pipelines/DSC-Official.yml

@@ -133,9 +133,10 @@ extends:
         variables:
           ob_outputDirectory: '$(Build.ArtifactStagingDirectory)'
           ob_sdl_tsa_configFile: '$(Build.SourcesDirectory)\DSC\.config\tsaoptions.json'
-          ob_sdl_sbom_enabled: true
-          ob_signing_setup_enabled: true
-          ob_sdl_codeql_compiled_enabled: true
+          ob_sdl_sbom_enabled: false
+          ob_signing_setup_enabled: false
+          ob_sdl_codeql_compiled_enabled: false
+          ob_restore_phase: true
         pool:
           type: windows
         steps:
@@ -152,17 +153,39 @@ extends:
             Copy-Item "$(Pipeline.Workspace)/drop_BuildAndSign_BuildWin_x64/*.msix" ./bin/msix -Verbose
             Copy-Item "$(Pipeline.Workspace)/drop_BuildAndSign_BuildWin_arm64/*.msix" ./bin/msix -Verbose
             ./build.ps1 -PackageType msixbundle
-            Copy-Item ./bin/*.msixbundle "$(ob_outputDirectory)"
+            Copy-Item "$(Build.SourcesDirectory)/DSC/bin/*.msixbundle" "$(ob_outputDirectory)"
           displayName: 'Create msixbundle'
           condition: succeeded()
+
+      - job: SignMsixBundle
+        dependsOn: CreateMsixBundle
+        variables:
+          ob_outputDirectory: '$(Build.ArtifactStagingDirectory)'
+          ob_sdl_sbom_enabled: false
+          ob_signing_setup_enabled: true
+          ob_sdl_codeql_compiled_enabled: false
+        pool:
+          type: windows
+        steps:
+        - task: DownloadPipelineArtifact@2
+          inputs:
+            buildType: 'current'
+            artifact: drop_BuildAndSign_CreateMsixBundle
+            itemPattern: |
+              **/*.msixbundle
+            targetPath: '$(Build.ArtifactStagingDirectory)/downloads'
+          displayName: Download MsixBundle
         - task: onebranch.pipeline.signing@1
           displayName: Sign MsixBundle
           condition: succeeded()
           inputs:
             command: 'sign'
-            signing_profile: $(MSIXProfile)
+            signing_profile: 'Dynamic-WINMSAPP1ST'
             files_to_sign: '*.msixbundle'
-            search_root: '$(ob_outputDirectory)'
+            search_root: '$(Build.ArtifactStagingDirectory)/downloads'
+        - pwsh: |
+            Copy-Item "$(Build.ArtifactStagingDirectory)/downloads/*.msixbundle" "$(ob_outputDirectory)"
+          displayName: 'Copy MsixBundle to output directory'
 
       - job: BuildLinuxMusl
         dependsOn: SetPackageVersion

CHANGELOG.md

@@ -121,7 +121,7 @@ changes since the last release, see the [diff on GitHub][unreleased].
 - Added support for extensions to DSC. You can now use the `dsc extension list` command to
   enumerate available extensions. DSC now supports a single extension capability, `discover`, which
   returns JSON objects indicating where to find DSC resource manifests that aren't in the `PATH` or
-  `DSC_PATH`, as with resources installed as Appx packages.
+  `DSC_RESOURCE_PATH`, as with resources installed as Appx packages.
 
   Now when DSC performs discovery, it recursively discovers extensions and resources on the system.
 
@@ -135,7 +135,7 @@ changes since the last release, see the [diff on GitHub][unreleased].
     - [#760][#760]
     - [#762][#762]
 
-- Addes support for passing parameters to the `dsc config` commands from stdin. You can pass
+- Adds support for passing parameters to the `dsc config` commands from stdin. You can pass
   _either_ the configuration document or parameters file contents to the command from stdin, but
   not both. This enables securely passing sensitive parameters to DSC without writing them to a
   file or defining them as an environment variable.

CONTRIBUTING.md

@@ -29,7 +29,7 @@ Please read the rest of this document to ensure a smooth contribution process.
 You can contribute to documentation either in the `docs` folder of this repository
 or in the [PowerShell-Docs-DSC](https://github.com/MicrosoftDocs/PowerShell-Docs-DSC/) repository.
 
-> [!INFO]
+> [!NOTE]
 > Documentation contributed to the `docs` folder in this repository is periodically synced to the [PowerShell-Docs-DSC](https://github.com/MicrosoftDocs/PowerShell-Docs-DSC/) repository.
 
 ### Contributing to documentation related to maintaining or contributing to the DSC project

build.ps1

@@ -60,10 +60,13 @@ $filesForWindowsPackage = @(
     'RunCommandOnSet.dsc.resource.json',
     'RunCommandOnSet.exe',
     'sshdconfig.exe',
-    'sshdconfig.dsc.resource.json',
+    'sshd-windows.dsc.resource.json',
+    'sshd_config.dsc.resource.json',
     'windowspowershell.dsc.resource.json',
     'wmi.dsc.resource.json',
     'wmi.resource.ps1',
+    'wmiAdapter.psd1',
+    'wmiAdapter.psm1',
     'windows_baseline.dsc.yaml',
     'windows_inventory.dsc.yaml'
 )
@@ -87,7 +90,7 @@ $filesForLinuxPackage = @(
     'RunCommandOnSet.dsc.resource.json',
     'runcommandonset',
     'sshdconfig',
-    'sshdconfig.dsc.resource.json'
+    'sshd_config.dsc.resource.json'
 )
 
 $filesForMacPackage = @(
@@ -109,7 +112,7 @@ $filesForMacPackage = @(
     'RunCommandOnSet.dsc.resource.json',
     'runcommandonset',
     'sshdconfig',
-    'sshdconfig.dsc.resource.json'
+    'sshd_config.dsc.resource.json'
 )
 
 # the list of files other than the binaries which need to be executable
@@ -172,6 +175,27 @@ if ($null -ne $packageType) {
     $BuildToolsPath = "${env:ProgramFiles(x86)}\Microsoft Visual Studio\2022\BuildTools\VC\Tools\MSVC"
 
     & $rustup default stable
+
+    ## Test if Node is installed
+    ## Skipping upgrade as users may have a specific version they want to use
+    if (!(Get-Command 'node' -ErrorAction Ignore)) {
+        Write-Verbose -Verbose "Node.js not found, installing..."
+        if (!$IsWindows) {
+            if (Get-Command 'brew' -ErrorAction Ignore) {
+                brew install node@24
+            } else {
+                Write-Warning "Homebrew not found, please install Node.js manually"
+            }
+        }
+        else {
+            if (Get-Command 'winget' -ErrorAction Ignore) {
+                Write-Verbose -Verbose "Using winget to install Node.js"
+                winget install OpenJS.NodeJS --accept-source-agreements --accept-package-agreements --source winget --silent
+            } else {
+                Write-Warning "winget not found, please install Node.js manually"
+            }
+        }
+    }
 }
 
 if (!$SkipBuild -and !$SkipLinkCheck -and $IsWindows -and !(Get-Command 'link.exe' -ErrorAction Ignore)) {

docs/reference/cli/config/export.md

@@ -31,6 +31,18 @@ dsc config export [Options] --input <INPUT>
 cat <FILE> | dsc config export [Options] --file -
 ```
 
+### Configuration document from file with parameters from stdin
+
+```sh
+cat <PARAMETERS_FILE> | dsc config --parameters-file - export [Options] --file <FILE>
+```
+
+### Configuration document from option string with parameters from stdin
+
+```sh
+cat <PARAMETERS_FILE> | dsc config --parameters-file - export [Options] --input <INPUT>
+```
+
 ## Description
 
 The `export` subcommand generates a configuration document that includes every instance of a set of

docs/reference/cli/config/get.md

@@ -31,6 +31,18 @@ dsc config get [Options] --input <INPUT>
 cat <FILE> | dsc config get [Options] --file -
 ```
 
+### Configuration document from file with parameters from stdin
+
+```sh
+cat <PARAMETERS_FILE> | dsc config --parameters-file - get [Options] --file <FILE>
+```
+
+### Configuration document from option string with parameters from stdin
+
+```sh
+cat <PARAMETERS_FILE> | dsc config --parameters-file - get [Options] --input <INPUT>
+```
+
 ## Description
 
 The `get` subcommand returns the actual state of the resource instances in a configuration

docs/reference/cli/config/index.md

@@ -78,6 +78,11 @@ for that parameter.
 
 This option is mutually exclusive with the `--parameters` option.
 
+Starting with DSC version 3.1.0, you can pass the parameters data to a subcommand over stdin. When
+you do, you must pass the configuration document as an input string or the path to a file on the
+system. You can't pass both the parameters file and the configuration document to a command from
+stdin.
+
 For more information about defining parameters in a configuration document, see
 [DSC Configuration document parameter schema][06]. For more information about using parameters in
 configuration document, see the [parameters function reference][07].

docs/reference/cli/config/set.md

@@ -31,6 +31,19 @@ dsc config set [Options] --input <INPUT>
 cat <FILE> | dsc config set [Options] --file -
 ```
 
+### Configuration document from file with parameters from stdin
+
+```sh
+cat <PARAMETERS_FILE> | dsc config --parameters-file - set [Options] --file <FILE>
+```
+
+### Configuration document from option string with parameters from stdin
+
+```sh
+cat <PARAMETERS_FILE> | dsc config --parameters-file - set [Options] --input <INPUT>
+```
+
+
 ## Description
 
 The `set` subcommand enforces the desired state of the resource instances in a configuration

docs/reference/cli/config/test.md

@@ -31,6 +31,18 @@ dsc config test [Options] --input <INPUT>
 cat <FILE> | dsc config test [Options] --file -
 ```
 
+### Configuration document from file with parameters from stdin
+
+```sh
+cat <PARAMETERS_FILE> | dsc config --parameters-file - test [Options] --file <FILE>
+```
+
+### Configuration document from option string with parameters from stdin
+
+```sh
+cat <PARAMETERS_FILE> | dsc config --parameters-file - test [Options] --input <INPUT>
+```
+
 ## Description
 
 The `test` subcommand verifies whether the resource instances in a configuration document are in