Merge branch 'master' into fix/SchannelSettings

Author: ykuijs

CHANGELOG.md

@@ -1,10 +1,17 @@
-# Change log for SChannelDsc
+# Changelog for SChannelDsc
 
 The format is based on and uses the types of changes according to [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
 
+### Changed
+
+- SChannelDsc
+  - Moved some documentation from the README.md to the GitHub repository
+    wiki page.
+  - Updated the pipeline files to use the latest from Sampler.
+
 ### Fixed
 
 - SChannelDsc

GitVersion.yml

@@ -1,5 +1,5 @@
 mode: ContinuousDelivery
-next-version: 1.2.0
+next-version: 0.0.1
 major-version-bump-message: '(breaking\schange|breaking|major)\b'
 minor-version-bump-message: '(adds?|features?|minor)\b'
 patch-version-bump-message: '\s?(fix|patch)'
@@ -25,16 +25,3 @@ branches:
 ignore:
   sha: []
 merge-message-formats: {}
-
-
-# feature:
-#   tag: useBranchName
-#   increment: Minor
-#   regex: f(eature(s)?)?[/-]
-#   source-branches: ['master']
-# hotfix:
-#   tag: fix
-#   increment: Patch
-#   regex: (hot)?fix(es)?[/-]
-#   source-branches: ['master']
-

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 DSC Community
+Copyright (c) DSC Community contributors.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,17 +1,17 @@
 # SChannelDsc
 
+This module contains DSC resources for the management and
+configuration of SChannel settings.
+
+> It is based of the [cSchannel](https://github.com/bdanse/cSchannel) resource created by Bart Danse.
+
 [![Build Status](https://dev.azure.com/dsccommunity/SChannelDsc/_apis/build/status/dsccommunity.SChannelDsc?branchName=master)](https://dev.azure.com/dsccommunity/SChannelDsc/_build/latest?definitionId=32&branchName=master)
 ![Azure DevOps coverage (branch)](https://img.shields.io/azure-devops/coverage/dsccommunity/SChannelDsc/32/master)
+[![codecov](https://codecov.io/gh/dsccommunity/SChannelDsc/branch/master/graph/badge.svg)](https://codecov.io/gh/dsccommunity/SChannelDsc)
 [![Azure DevOps tests](https://img.shields.io/azure-devops/tests/dsccommunity/SChannelDsc/32/master)](https://dsccommunity.visualstudio.com/SChannelDsc/_test/analytics?definitionId=32&contextType=build)
 [![PowerShell Gallery (with prereleases)](https://img.shields.io/powershellgallery/vpre/SChannelDsc?label=SChannelDsc%20Preview)](https://www.powershellgallery.com/packages/SChannelDsc/)
 [![PowerShell Gallery](https://img.shields.io/powershellgallery/v/SChannelDsc?label=SChannelDsc)](https://www.powershellgallery.com/packages/SChannelDsc/)
 
-The SChannelDsc PowerShell module provides DSC resources that can be used to
-manage SChannel settings. It is based of the [cSchannel](https://github.com/bdanse/cSchannel)
-resource created by Bart Danse.
-
-Please leave comments, feature requests, and bug reports in the issues tab for
-this module.
 ## Code of Conduct
 
 This project has adopted this [Code of Conduct](CODE_OF_CONDUCT.md).
@@ -37,45 +37,9 @@ The documentation can be found in the [SChannelDsc Wiki](https://github.com/dscc
 The DSC resources schema files is used to automatically update the
 documentation on each PR merge.
 
-## Installation
-
-To manually install the module, download the source code and unzip the contents
-of the \Modules\SChannelDsc directory to the
-$env:ProgramFiles\WindowsPowerShell\Modules folder
-
-To install from the [PowerShell Gallery](https://www.powershellgallery.com/packages/SChannelDsc)
-using PowerShellGet (in PowerShell 5.0) run the following command:
-
-```PowerShell
-Find-Module -Name SChannelDsc -Repository PSGallery | Install-Module
-```
-
-To confirm installation, run the below command and ensure you see the
-SChannel DSC resoures available:
-
-```PowerShell
-Get-DscResource -Module SChannelDsc
-```
-
-## Requirements
-
-The minimum PowerShell version required is 4.0, which ships in Windows 8.1
-or Windows Server 2012R2 (or higher versions). The preferred version is
-PowerShell 5.0 or higher, which ships with Windows 10 or Windows Server 2016.
-This is discussed [on the SChannelDsc wiki](https://github.com/dsccommunity/SChannelDsc/wiki/Remote%20sessions%20and%20the%20InstallAccount%20variable),
-but generally PowerShell 5 will run the SChannel DSC resources faster and
-with improved verbose level logging.
-
-## Documentation and examples
-
-For a full list of resources in SChannelDsc and examples on their use, check
-out the [SChannelDsc wiki](https://github.com/dsccommunity/SChannelDsc/wiki).
-You can also review the "examples" directory in the SChannelDsc module for
-some general use scenarios for all of the resources that are in the module.
-
 ### Examples
 
-You can review the [Examples](/source/Examples) directory in the Temp module
+You can review the [Examples](/source/Examples) directory in the SChannelDsc module
 for some general use scenarios for all of the resources that are in the module.
 
 The resource examples are also available in the [SChannelDsc Wiki](https://github.com/dsccommunity/SChannelDsc/wiki).

azure-pipelines.yml

@@ -25,15 +25,17 @@ stages:
       - job: Package_Module
         displayName: 'Package Module'
         pool:
-          vmImage: 'ubuntu-18.04'
+          vmImage: 'ubuntu-latest'
         steps:
-          - task: GitVersion@5
-            name: gitVersion
-            displayName: 'Evaluate Next Version'
-            inputs:
-              runtime: 'core'
-              configFilePath: 'GitVersion.yml'
-
+          - pwsh: |
+              dotnet tool install --global GitVersion.Tool
+              $gitVersionObject = dotnet-gitversion | ConvertFrom-Json
+              $gitVersionObject.PSObject.Properties.ForEach{
+                  Write-Host -Object "Setting Task Variable '$($_.Name)' with value '$($_.Value)'."
+                  Write-Host -Object "##vso[task.setvariable variable=$($_.Name);]$($_.Value)"
+              }
+              Write-Host -Object "##vso[build.updatebuildnumber]$($gitVersionObject.FullSemVer)"
+            displayName: Calculate ModuleVersion (GitVersion)
           - task: PowerShell@2
             name: package
             displayName: 'Build & Package Module'
@@ -42,8 +44,7 @@ stages:
               arguments: '-ResolveDependency -tasks pack'
               pwsh: true
             env:
-              ModuleVersion: $(gitVersion.NuGetVersionV2)
-
+              ModuleVersion: $(NuGetVersionV2)
           - task: PublishPipelineArtifact@1
             displayName: 'Publish Build Artifact'
             inputs:
@@ -52,21 +53,13 @@ stages:
               publishLocation: 'pipeline'
               parallel: true
 
-          - task: PublishPipelineArtifact@1
-            displayName: 'Publish Wiki Content Artifact'
-            inputs:
-              targetPath: '$(buildFolderName)/WikiContent/'
-              artifact: 'WikiContent'
-              publishLocation: 'pipeline'
-              parallel: true
-
   - stage: Test
     dependsOn: Build
     jobs:
       - job: Test_HQRM
         displayName: 'HQRM'
         pool:
-          vmImage: 'windows-2022'
+          vmImage: 'windows-latest'
         timeoutInMinutes: 0
         steps:
           - task: DownloadPipelineArtifact@2
@@ -75,15 +68,13 @@ stages:
               buildType: 'current'
               artifactName: $(buildArtifactName)
               targetPath: '$(Build.SourcesDirectory)/$(buildFolderName)'
-
           - task: PowerShell@2
             name: test
             displayName: 'Run HQRM Test'
             inputs:
               filePath: './build.ps1'
               arguments: '-Tasks hqrmtest'
               pwsh: false
-
           - task: PublishTestResults@2
             displayName: 'Publish Test Results'
             condition: succeededOrFailed()
@@ -96,7 +87,7 @@ stages:
       - job: Test_Unit
         displayName: 'Unit'
         pool:
-          vmImage: 'windows-2022'
+          vmImage: 'windows-latest'
         timeoutInMinutes: 0
         steps:
           - task: DownloadPipelineArtifact@2
@@ -105,15 +96,13 @@ stages:
               buildType: 'current'
               artifactName: $(buildArtifactName)
               targetPath: '$(Build.SourcesDirectory)/$(buildFolderName)'
-
           - task: PowerShell@2
             name: test
             displayName: 'Run Unit Test'
             inputs:
               filePath: './build.ps1'
               arguments: "-Tasks test -PesterScript 'tests/Unit'"
-              pwsh: false
-
+              pwsh: true
           - task: PublishTestResults@2
             displayName: 'Publish Test Results'
             condition: succeededOrFailed()
@@ -122,7 +111,6 @@ stages:
               testResultsFiles: '$(buildFolderName)/$(testResultFolderName)/NUnit*.xml'
               # If several pipeline jobs are generating test result, consider renaming this title:
               testRunTitle: 'Unit'
-
           - task: PublishPipelineArtifact@1
             displayName: 'Publish Test Artifact'
             inputs:
@@ -136,7 +124,7 @@ stages:
         displayName: 'Publish Code Coverage'
         dependsOn: Test_Unit
         pool:
-          vmImage: 'ubuntu-18.04'
+          vmImage: 'ubuntu-latest'
         timeoutInMinutes: 0
         steps:
           - pwsh: |
@@ -157,7 +145,6 @@ stages:
               buildType: 'current'
               artifactName: $(testArtifactName)
               targetPath: '$(Build.SourcesDirectory)/$(buildFolderName)/$(testResultFolderName)'
-
           - task: PublishCodeCoverageResults@1
             displayName: 'Publish Code Coverage to Azure DevOps'
             inputs:
@@ -183,7 +170,7 @@ stages:
       - job: Deploy_Module
         displayName: 'Deploy Module'
         pool:
-          vmImage: 'ubuntu-18.04'
+          vmImage: 'ubuntu-latest'
         steps:
           - task: DownloadPipelineArtifact@2
             displayName: 'Download Pipeline Artifact'

build.ps1

@@ -466,7 +466,7 @@ Begin
             # The parameter has been explicitly used for calling the .build.ps1
             if ($MyInvocation.BoundParameters.ContainsKey($cmdParameter))
             {
-                $paramValue = $MyInvocation.BoundParameters.ContainsKey($cmdParameter)
+                $paramValue = $MyInvocation.BoundParameters.Item($cmdParameter)
 
                 Write-Debug " adding  $cmdParameter :: $paramValue [from user-provided parameters to Build.ps1]"
 

build.yaml

@@ -34,7 +34,7 @@ BuildWorkflow:
     - Build_Module_ModuleBuilder
     - Build_NestedModules_ModuleBuilder
     - Create_changelog_release_output
-    # - Generate_Conceptual_Help
+    - Generate_Conceptual_Help
     - Generate_Wiki_Content
 
   pack:
@@ -81,7 +81,7 @@ DscTest:
   ExcludeSourceFile:
     - output
   ExcludeModuleFile:
-   - Modules/DscResource.Common
+    - Modules/DscResource.Common
 
 # Import ModuleBuilder tasks from a specific PowerShell module using the build
 # task's alias. Wildcard * can be used to specify all tasks that has a similar

source/SChannelDsc.psm1

@@ -0,0 +1,4 @@
+<#
+    This file is intentionally left empty. It is must be left here for the module
+    manifest to refer to. It is recreated during the build process.
+#>

source/WikiSource/Home.md

@@ -17,7 +17,13 @@ To confirm installation, run the below command and ensure you see the SChannel D
 
     Get-DscResource -Module SChannelDsc
 
-#### DSC requirements
+## Requirements
+
+The minimum PowerShell version required is 4.0, which ships in Windows 8.1
+or Windows Server 2012R2 (or higher versions). The preferred version is
+PowerShell 5.0 or higher, which ships with Windows 10 or Windows Server 2016.
+
+### DSC requirements
 
 To run PowerShell DSC, you need to have PowerShell 4.0 or higher (which is included in Windows Management Framework 4.0 or higher).
 This version of PowerShell is shipped with Windows Server 2012 R2, and Windows 8.1 or higher.