Fix doc generation (#91)

dan-hughes · web-flow · commit f02ef179fbb9 · 2025-10-13T21:42:25.000+02:00
diff --git a/.codecov.yml b/.codecov.yml
@@ -1,9 +1,10 @@
 codecov:
-  notify:
-    require_ci_to_pass: no
+  require_ci_to_pass: no
+  # main should be the baseline for reporting
+  branch: main
 
 comment:
-  layout: "reach, diff"
+  layout: "reach, diff, flags, files"
   behavior: default
 
 coverage:
@@ -22,3 +23,6 @@ coverage:
         # and let codecov.io set the goal for the code changed in the patch.
         target: auto
         threshold: 5
+
+fixes:
+  - '^\d+\.\d+\.\d+::source'  # move path "X.Y.Z" => "source"
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -30,6 +30,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Rename `Tests` directory to `tests`.
 - Updated Unit tests to Pester 5 DscCommunity format.
 - Update references of `master` branch to `main`.
+- Fix Doc Generation.
+- Update `azure-pipelines` to use latest pattern.
 
 ### Added
 
diff --git a/README.md b/README.md
@@ -5,6 +5,7 @@
 [![Azure DevOps tests](https://img.shields.io/azure-devops/tests/dsccommunity/UpdateServicesDsc/21/main)](https://dsccommunity.visualstudio.com/UpdateServicesDsc/_test/analytics?definitionId=21&contextType=build)
 [![PowerShell Gallery (with prereleases)](https://img.shields.io/powershellgallery/vpre/UpdateServicesDsc?label=UpdateServicesDsc%20Preview)](https://www.powershellgallery.com/packages/UpdateServicesDsc/)
 [![PowerShell Gallery](https://img.shields.io/powershellgallery/v/UpdateServicesDsc?label=UpdateServicesDsc)](https://www.powershellgallery.com/packages/UpdateServicesDsc/)
+[![codecov](https://codecov.io/gh/dsccommunity/UpdateServicesDsc/branch/main/graph/badge.svg)](https://codecov.io/gh/dsccommunity/UpdateServicesDsc)
 
 The **UpdateServicesDsc** module contains DSC resources
 for deployment and configuration of Windows Server Update Services.
@@ -29,87 +30,15 @@ full release to [PowerShell Gallery](https://www.powershellgallery.com/).
 
 Please check out common DSC Community [contributing guidelines](https://dsccommunity.org/guidelines/contributing).
 
-## Installation
-
-### From GitHub source code
-
-To manually install the module, download the source code from GitHub and unzip
-the contents to the '$env:ProgramFiles\WindowsPowerShell\Modules' folder.
-
-### From PowerShell Gallery
-
-To install from the PowerShell gallery using PowerShellGet (in PowerShell 5.0)
-run the following command:
-
-```powershell
-Find-Module -Name UpdateServicesDsc | Install-Module
-```
-
-To confirm installation, run the below command and ensure you see the SQL Server
-DSC resources available:
-
-```powershell
-Get-DscResource -Module UpdateServicesDsc
-```
-
-## Requirements
-
-The minimum Windows Management Framework (PowerShell) version required is 5.0
-or higher, which ships with Windows 10 or Windows Server 2016,
-but can also be installed on Windows 7 SP1, Windows 8.1,
-Windows Server 2008 R2 SP1, Windows Server 2012 and Windows Server 2012 R2.
-
-## Details
-
-**UpdateServicesApprovalRule** resource has following properties
-
-* **Ensure**: An enumerated value that describes if the ApprovalRule is available
-* **Name**: Name of the approval rule.
-* **Classifications**: Classifications in the approval rule.
-* **Products**: Products in the approval rule.
-* **ComputerGroups**: Computer groups the approval rule applies to.
-* **Enabled**: Whether the approval rule is enabled.
-* **Synchronize**: Synchronize after creating or updating the approval rule.
-
-**UpdateServicesCleanup** resource has following properties:
-
-* **Ensure**: An enumerated value that describes if the WSUS cleanup task exists.
-* **DeclineSupersededUpdates**: Decline updates that have not been approved for
- 30 days or more, are not currently needed by any clients, and are superseded by an approved update.
-* **DeclineExpiredUpdates**: Decline updates that aren't approved and have been expired by Microsoft.
-* **CleanupObsoleteUpdates**: Delete updates that are expired and have not been
- approved for 30 days or more, and delete older update revisions that have not
- been approved for 30 days or more.
-* **CompressUpdates**: Compress updates.
-* **CleanupObsoleteComputers**: Delete computers that have not contacted the server in 30 days or more.
-* **CleanupUnneededContentFiles**: Delete update files that aren't needed by updates or downstream servers.
-* **CleanupLocalPublishedContentFiles**: Cleanup local published content files.
-* **TimeOfDay** Time of day to start cleanup.
-
-**UpdateServicesServer** resource has following properties:
-
-* **Ensure**: An enumerated value that describes if WSUS is configured.
-* **SetupCredential**: Credential to be used to perform the initial configuration.
-* **SQLServer**: SQL Server for the WSUS database, omit for Windows Internal Database.
-* **ContentDir**: Folder for WSUS update files.
-* **UpdateImprovementProgram**: Join the Microsoft Update Improvement Program.
-* **UpstreamServerName**: Upstream WSUS server, omit for Microsoft Update.
-* **UpstreamServerPort**: Port of upstream WSUS server.
-* **UpstreamServerSSL**: Use SSL with upstream WSUS server.
-* **UpstreamServerReplica**: Replica of upstream WSUS server.
-* **ProxyServerName**: Proxy server to use when synchronizing, omit for no proxy.
-* **ProxyServerPort**: Proxy server port.
-* **ProxyServerCredential**: Proxy server credential, omit for anonymous.
-* **ProxyServerCredentialUsername**: Proxy server credential username.
-* **ProxyServerBasicAuthentication**: Allow proxy server basic authentication.
-* **Languages**: Update languages, * for all.
-* **Products**: Update products, * for all.
-* **Classifications**: Update classifications, * for all.
-* **SynchronizeAutomatically**: Synchronize automatically.
-* **SynchronizeAutomaticallyTimeOfDay**: First synchronization.
-* **SynchronizationsPerDay**: Synchronizations per day.
-* **Synchronize**: Begin initial synchronization.
-* **ClientTargetingMode**: An enumerated value that describes if how the Target Groups are populated.
+## Change log
+
+A full list of changes in each version can be found in the [change log](CHANGELOG.md).
+
+## Documentation
+
+The documentation can be found in the [UpdateServicesDsc Wiki](https://github.com/dsccommunity/UpdateServicesDsc/wiki).
+The DSC resources schema files are used to automatically update the
+documentation on each PR merge.
 
 ## Versions
 
diff --git a/azure-pipelines.yml b/azure-pipelines.yml
@@ -1,20 +1,22 @@
 trigger:
   branches:
     include:
-    - main
+      - main
   paths:
-    exclude:
-    - CHANGELOG.md
+    include:
+      - source/*
   tags:
     include:
-    - "v*"
+      - 'v*'
     exclude:
-    - "*-*"
+      - '*-*'
 
 variables:
   buildFolderName: output
   buildArtifactName: output
   testResultFolderName: testResults
+  testArtifactName: testResults
+  sourceFolderName: source
   defaultBranch: main
 
 stages:
@@ -53,79 +55,121 @@ stages:
               publishLocation: 'pipeline'
               parallel: true
 
-  - stage: Test
+  - stage: Quality_Test_and_Unit_Test
+    displayName: 'Quality Test and Unit Test'
     dependsOn: Build
     jobs:
       - job: Test_HQRM
         displayName: 'HQRM'
         pool:
           vmImage: 'windows-latest'
-        timeoutInMinutes: 0
+        timeoutInMinutes: '0'
         steps:
           - task: DownloadPipelineArtifact@2
-            displayName: 'Download Build Artifact'
+            displayName: 'Download Pipeline Artifact'
             inputs:
               buildType: 'current'
               artifactName: $(buildArtifactName)
               targetPath: '$(Build.SourcesDirectory)/$(buildArtifactName)'
+
           - 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()
             inputs:
               testResultsFormat: 'NUnit'
               testResultsFiles: '$(buildFolderName)/$(testResultFolderName)/NUnit*.xml'
               testRunTitle: 'HQRM'
+            condition: succeededOrFailed()
 
       - job: Test_Unit
         displayName: 'Unit'
+        strategy:
+          matrix:
+            Windows Server 2022:
+              vmImage: 'windows-2022'
+            Windows Server 2025:
+              vmImage: 'windows-2025'
         pool:
-          vmImage: 'windows-latest'
-        timeoutInMinutes: 0
+          vmImage: $(vmImage)
+        timeoutInMinutes: '0'
         steps:
-          - powershell: |
-              $repositoryOwner,$repositoryName = $env:BUILD_REPOSITORY_NAME -split '/'
-
-              echo "##vso[task.setvariable variable=RepositoryOwner;isOutput=true]$repositoryOwner"
-              echo "##vso[task.setvariable variable=RepositoryName;isOutput=true]$repositoryName"
-            name: dscBuildVariable
-            displayName: 'Set Environment Variables'
           - task: DownloadPipelineArtifact@2
-            displayName: 'Download Build Artifact'
+            displayName: 'Download Pipeline Artifact'
             inputs:
               buildType: 'current'
               artifactName: $(buildArtifactName)
-              targetPath: '$(Build.SourcesDirectory)/$(buildFolderName)'
+              targetPath: '$(Build.SourcesDirectory)/$(buildArtifactName)'
+
           - 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()
             inputs:
               testResultsFormat: 'NUnit'
               testResultsFiles: '$(buildFolderName)/$(testResultFolderName)/NUnit*.xml'
-              testRunTitle: 'Unit (Windows Server Core)'
-          - task: PublishCodeCoverageResults@1
-            displayName: 'Publish Code Coverage'
+              testRunTitle: 'Unit $(vmImage)'
             condition: succeededOrFailed()
+
+          - task: PublishPipelineArtifact@1
+            displayName: 'Publish Test Artifact'
+            inputs:
+              targetPath: '$(buildFolderName)/$(testResultFolderName)/'
+              artifactName: '$(testArtifactName)_$(vmImage)'
+
+      - job: Code_Coverage
+        displayName: 'Publish Code Coverage'
+        dependsOn: Test_Unit
+        pool:
+          vmImage: 'ubuntu-latest'
+        timeoutInMinutes: '0'
+        steps:
+          - task: DownloadPipelineArtifact@2
+            displayName: 'Download Pipeline Artifact'
+            inputs:
+              buildType: 'current'
+              artifactName: $(buildArtifactName)
+              targetPath: '$(Build.SourcesDirectory)/$(buildArtifactName)'
+
+          - task: DownloadPipelineArtifact@2
+            displayName: 'Download Test Artifact'
+            inputs:
+              buildType: 'current'
+              targetPath: '$(Build.SourcesDirectory)/$(buildFolderName)/$(testResultFolderName)'
+
+          - task: PowerShell@2
+            name: merge
+            displayName: 'Merge Code Coverage files'
+            inputs:
+              filePath: './build.ps1'
+              arguments: '-tasks merge'
+              pwsh: true
+
+          - task: PublishCodeCoverageResults@1
+            displayName: 'Publish Code Coverage to Azure DevOps'
             inputs:
               codeCoverageTool: 'JaCoCo'
-              summaryFileLocation: 'output/testResults/CodeCov*.xml'
-              pathToSources: '$(Build.SourcesDirectory)/output/$(dscBuildVariable.RepositoryName)'
+              summaryFileLocation: '$(Build.SourcesDirectory)/$(buildFolderName)/$(testResultFolderName)/JaCoCo_coverage.xml'
+              pathToSources: '$(Build.SourcesDirectory)/$(sourceFolderName)/'
+
+          - script: |
+              bash <(curl -s https://codecov.io/bash) -f "./$(buildFolderName)/$(testResultFolderName)/JaCoCo_coverage.xml"
+            displayName: 'Publish Code Coverage to Codecov.io'
 
   - stage: Deploy
-    dependsOn: Test
+    dependsOn: Quality_Test_and_Unit_Test
     # Only execute deploy stage if we're on main and previous stage succeeded
     condition: |
       and(
@@ -143,11 +187,12 @@ stages:
           vmImage: 'ubuntu-latest'
         steps:
           - task: DownloadPipelineArtifact@2
-            displayName: 'Download Build Artifact'
+            displayName: 'Download Pipeline Artifact'
             inputs:
               buildType: 'current'
               artifactName: $(buildArtifactName)
-              targetPath: '$(Build.SourcesDirectory)/$(buildFolderName)'
+              targetPath: '$(Build.SourcesDirectory)/$(buildArtifactName)'
+
           - task: PowerShell@2
             name: publishRelease
             displayName: 'Publish Release'
@@ -158,8 +203,9 @@ stages:
             env:
               GitHubToken: $(GitHubToken)
               GalleryApiToken: $(GalleryApiToken)
-              ReleaseBranch: $(defaultBranch)
-              MainGitBranch: $(defaultBranch)
+              ReleaseBranch: main
+              MainGitBranch: main
+
           - task: PowerShell@2
             name: sendChangelogPR
             displayName: 'Send Changelog PR'
@@ -169,5 +215,5 @@ stages:
               pwsh: true
             env:
               GitHubToken: $(GitHubToken)
-              ReleaseBranch: $(defaultBranch)
-              MainGitBranch: $(defaultBranch)
+              ReleaseBranch: main
+              MainGitBranch: main
diff --git a/build.yaml b/build.yaml
@@ -76,7 +76,6 @@ Pester:
       CIFormat: Auto
     CodeCoverage:
       CoveragePercentTarget: 50
-      OutputPath: JaCoCo_coverage.xml
       OutputEncoding: ascii
       # There is a bug in Pester when running unit tests for classes when 'UseBreakpoints' is turned off.
       # See error in gist: https://gist.github.com/johlju/c16dfd9587c7e066e8825fc54b33a703
@@ -87,6 +86,16 @@ Pester:
   ExcludeFromCodeCoverage:
     - Modules/DscResource.Common
 
+####################################################
+#           Code Coverage Configuration            #
+####################################################
+CodeCoverage:
+  # Filename of the file that will be outputted by the task Merge_CodeCoverage_Files.
+  CodeCoverageMergedOutputFile: JaCoCo_coverage.xml
+  # File pattern used to search for files under the ./output/testResults folder
+  # by task Merge_CodeCoverage_Files.
+  CodeCoverageFilePattern: Codecov*.xml
+
 ####################################################
 #      Pester Configuration (DscResource.Test)     #
 ####################################################
diff --git a/source/DSCResources/MSFT_UpdateServicesApprovalRule/MSFT_UpdateServicesApprovalRule.schema.mof b/source/DSCResources/MSFT_UpdateServicesApprovalRule/MSFT_UpdateServicesApprovalRule.schema.mof
@@ -1,7 +1,7 @@
 [ClassVersion("1.0.0.0"), FriendlyName("UpdateServicesApprovalRule")]
 class MSFT_UpdateServicesApprovalRule : OMI_BaseResource
 {
-    [Write, Description("An enumerated value that describes if WSUS is configured.\nPresent {default}  \nAbsent   \n"), ValueMap{"Present","Absent"}, Values{"Present","Absent"}] String Ensure;
+    [Write, Description("An enumerated value that describes if WSUS is configured. Default value is 'Present'."), ValueMap{"Present","Absent"}, Values{"Present","Absent"}] String Ensure;
     [Key, Description("Name of the approval rule.")] String Name;
     [Write, Description("Classifications in the approval rule.")] String Classifications[];
     [Write, Description("Products in the approval rule.")] String Products[];
diff --git a/source/DSCResources/MSFT_UpdateServicesApprovalRule/README.md b/source/DSCResources/MSFT_UpdateServicesApprovalRule/README.md
@@ -0,0 +1,3 @@
+# Description
+
+This resource is used to configure the Update Services Approval Rule.
diff --git a/source/DSCResources/MSFT_UpdateServicesCleanup/MSFT_UpdateServicesCleanup.schema.mof b/source/DSCResources/MSFT_UpdateServicesCleanup/MSFT_UpdateServicesCleanup.schema.mof
@@ -1,7 +1,7 @@
 [ClassVersion("1.0.0.0"), FriendlyName("UpdateServicesCleanup")]
 class MSFT_UpdateServicesCleanup : OMI_BaseResource
 {
-    [Key, Description("An enumerated value that describes if the WSUS cleanup task exists.\nPresent {default}  \nAbsent   \n"), ValueMap{"Present","Absent"}, Values{"Present","Absent"}] String Ensure;
+    [Key, Description("An enumerated value that describes if the WSUS cleanup task exists. Default value is 'Present'."), ValueMap{"Present","Absent"}, Values{"Present","Absent"}] String Ensure;
     [Write, Description("Decline updates that have not been approved for 30 days or more, are not currently needed by any clients, and are superseded by an approved update.")] Boolean DeclineSupersededUpdates;
     [Write, Description("Decline updates that aren't approved and have been expired by Microsoft.")] Boolean DeclineExpiredUpdates;
     [Write, Description("Delete updates that are expired and have not been approved for 30 days or more, and delete older update revisions that have not been approved for 30 days or more.")] Boolean CleanupObsoleteUpdates;
diff --git a/source/DSCResources/MSFT_UpdateServicesCleanup/README.md b/source/DSCResources/MSFT_UpdateServicesCleanup/README.md
@@ -0,0 +1,3 @@
+# Description
+
+This resource is used to configure the Update Services Cleanup Task.
diff --git a/source/DSCResources/MSFT_UpdateServicesServer/MSFT_UpdateServicesServer.schema.mof b/source/DSCResources/MSFT_UpdateServicesServer/MSFT_UpdateServicesServer.schema.mof
diff --git a/source/DSCResources/MSFT_UpdateServicesServer/README.md b/source/DSCResources/MSFT_UpdateServicesServer/README.md
diff --git a/source/WikiSource/Home.md b/source/WikiSource/Home.md

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`[ClassVersion("1.0.0.0"), FriendlyName("UpdateServicesApprovalRule")]`
`2`	`2`	`class MSFT_UpdateServicesApprovalRule : OMI_BaseResource`
`3`	`3`	`{`
`4`		`- [Write, Description("An enumerated value that describes if WSUS is configured.\nPresent {default} \nAbsent \n"), ValueMap{"Present","Absent"}, Values{"Present","Absent"}] String Ensure;`
	`4`	`+ [Write, Description("An enumerated value that describes if WSUS is configured. Default value is 'Present'."), ValueMap{"Present","Absent"}, Values{"Present","Absent"}] String Ensure;`
`5`	`5`	`[Key, Description("Name of the approval rule.")] String Name;`
`6`	`6`	`[Write, Description("Classifications in the approval rule.")] String Classifications[];`
`7`	`7`	`[Write, Description("Products in the approval rule.")] String Products[];`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# Description`
	`2`	`+`
	`3`	`+This resource is used to configure the Update Services Approval Rule.`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`[ClassVersion("1.0.0.0"), FriendlyName("UpdateServicesCleanup")]`
`2`	`2`	`class MSFT_UpdateServicesCleanup : OMI_BaseResource`
`3`	`3`	`{`
`4`		`- [Key, Description("An enumerated value that describes if the WSUS cleanup task exists.\nPresent {default} \nAbsent \n"), ValueMap{"Present","Absent"}, Values{"Present","Absent"}] String Ensure;`
	`4`	`+ [Key, Description("An enumerated value that describes if the WSUS cleanup task exists. Default value is 'Present'."), ValueMap{"Present","Absent"}, Values{"Present","Absent"}] String Ensure;`
`5`	`5`	`[Write, Description("Decline updates that have not been approved for 30 days or more, are not currently needed by any clients, and are superseded by an approved update.")] Boolean DeclineSupersededUpdates;`
`6`	`6`	`[Write, Description("Decline updates that aren't approved and have been expired by Microsoft.")] Boolean DeclineExpiredUpdates;`
`7`	`7`	`[Write, Description("Delete updates that are expired and have not been approved for 30 days or more, and delete older update revisions that have not been approved for 30 days or more.")] Boolean CleanupObsoleteUpdates;`