Update to latest CI pipeline pattern - Fixes dsccommunity#528 (dsccom…

…munity#529)
brajjan · Jun 7, 2024 · e8b5edc · e8b5edc
1 parent 5f6ac3e
commit e8b5edc
Show file tree

Hide file tree

Showing 11 changed files with 1,555 additions and 421 deletions.
diff --git a/.vscode/analyzersettings.psd1 b/.vscode/analyzersettings.psd1
@@ -1,44 +1,115 @@
 @{
-    CustomRulePath      = '.\output\RequiredModules\DscResource.AnalyzerRules'
-    includeDefaultRules = $true
-    IncludeRules   = @(
-        # DSC Resource Kit style guideline rules.
-        'PSAvoidDefaultValueForMandatoryParameter',
-        'PSAvoidDefaultValueSwitchParameter',
-        'PSAvoidInvokingEmptyMembers',
-        'PSAvoidNullOrEmptyHelpMessageAttribute',
-        'PSAvoidUsingCmdletAliases',
-        'PSAvoidUsingComputerNameHardcoded',
-        'PSAvoidUsingDeprecatedManifestFields',
-        'PSAvoidUsingEmptyCatchBlock',
-        'PSAvoidUsingInvokeExpression',
-        'PSAvoidUsingPositionalParameters',
-        'PSAvoidShouldContinueWithoutForce',
-        'PSAvoidUsingWMICmdlet',
-        'PSAvoidUsingWriteHost',
-        'PSDSCReturnCorrectTypesForDSCFunctions',
-        'PSDSCStandardDSCFunctionsInResource',
-        'PSDSCUseIdenticalMandatoryParametersForDSC',
-        'PSDSCUseIdenticalParametersForDSC',
-        'PSMisleadingBacktick',
-        'PSMissingModuleManifestField',
-        'PSPossibleIncorrectComparisonWithNull',
-        'PSProvideCommentHelp',
-        'PSReservedCmdletChar',
-        'PSReservedParams',
-        'PSUseApprovedVerbs',
-        'PSUseCmdletCorrectly',
-        'PSUseOutputTypeCorrectly',
-        'PSAvoidGlobalVars',
-        'PSAvoidUsingConvertToSecureStringWithPlainText',
-        'PSAvoidUsingPlainTextForPassword',
-        'PSAvoidUsingUsernameAndPasswordParams',
-        'PSDSCUseVerboseMessageInDSCResource',
-        'PSShouldProcess',
-        'PSUseDeclaredVarsMoreThanAssignments',
-        'PSUsePSCredentialType',
+    CustomRulePath      = @(
+        './output/RequiredModules/DscResource.AnalyzerRules'
+        './output/RequiredModules/Indented.ScriptAnalyzerRules'
+    )
+    IncludeDefaultRules = $true
+    IncludeRules        = @(
+        # DSC Community style guideline rules from the module ScriptAnalyzer.
+        'PSAvoidDefaultValueForMandatoryParameter'
+        'PSAvoidDefaultValueSwitchParameter'
+        'PSAvoidInvokingEmptyMembers'
+        'PSAvoidNullOrEmptyHelpMessageAttribute'
+        'PSAvoidUsingCmdletAliases'
+        'PSAvoidUsingComputerNameHardcoded'
+        'PSAvoidUsingDeprecatedManifestFields'
+        'PSAvoidUsingEmptyCatchBlock'
+        'PSAvoidUsingInvokeExpression'
+        'PSAvoidUsingPositionalParameters'
+        'PSAvoidShouldContinueWithoutForce'
+        'PSAvoidUsingWMICmdlet'
+        'PSAvoidUsingWriteHost'
+        'PSDSCReturnCorrectTypesForDSCFunctions'
+        'PSDSCStandardDSCFunctionsInResource'
+        'PSDSCUseIdenticalMandatoryParametersForDSC'
+        'PSDSCUseIdenticalParametersForDSC'
+        'PSMisleadingBacktick'
+        'PSMissingModuleManifestField'
+        'PSPossibleIncorrectComparisonWithNull'
+        'PSProvideCommentHelp'
+        'PSReservedCmdletChar'
+        'PSReservedParams'
+        'PSUseApprovedVerbs'
+        'PSUseCmdletCorrectly'
+        'PSUseOutputTypeCorrectly'
+        'PSAvoidGlobalVars'
+        'PSAvoidUsingConvertToSecureStringWithPlainText'
+        'PSAvoidUsingPlainTextForPassword'
+        'PSAvoidUsingUsernameAndPasswordParams'
+        'PSDSCUseVerboseMessageInDSCResource'
+        'PSShouldProcess'
+        'PSUseDeclaredVarsMoreThanAssignments'
+        'PSUsePSCredentialType'
+
+        # Additional rules from the module ScriptAnalyzer
+        'PSUseConsistentWhitespace'
+        'UseCorrectCasing'
+        'PSPlaceOpenBrace'
+        'PSPlaceCloseBrace'
+        'AlignAssignmentStatement'
+        'AvoidUsingDoubleQuotesForConstantString'
+        'UseShouldProcessForStateChangingFunctions'
 
+        # Rules from the modules DscResource.AnalyzerRules
         'Measure-*'
+
+        # Rules from the module Indented.ScriptAnalyzerRules
+        'AvoidCreatingObjectsFromAnEmptyString'
+        'AvoidDashCharacters'
+        'AvoidEmptyNamedBlocks'
+        'AvoidFilter'
+        'AvoidHelpMessage'
+        'AvoidNestedFunctions'
+        'AvoidNewObjectToCreatePSObject'
+        'AvoidParameterAttributeDefaultValues'
+        'AvoidProcessWithoutPipeline'
+        'AvoidSmartQuotes'
+        'AvoidThrowOutsideOfTry'
+        'AvoidWriteErrorStop'
+        'AvoidWriteOutput'
+        'UseSyntacticallyCorrectExamples'
     )
 
+    <#
+        The following types are not rules but parse errors reported by PSScriptAnalyzer
+        so they cannot be ecluded. They need to be filtered out from the result of
+        Invoke-ScriptAnalyzer.
+
+        TypeNotFound - Because classes in the project cannot be found unless built.
+        RequiresModuleInvalid - Because 'using module' in prefix.ps1 cannot be resolved as source file.
+    #>
+    ExcludeRules        = @()
+
+    Rules               = @{
+        PSUseConsistentWhitespace  = @{
+            Enable                          = $true
+            CheckOpenBrace                  = $true
+            CheckInnerBrace                 = $true
+            CheckOpenParen                  = $true
+            CheckOperator                   = $false
+            CheckSeparator                  = $true
+            CheckPipe                       = $true
+            CheckPipeForRedundantWhitespace = $true
+            CheckParameter                  = $false
+        }
+
+        PSPlaceOpenBrace           = @{
+            Enable             = $true
+            OnSameLine         = $false
+            NewLineAfter       = $true
+            IgnoreOneLineBlock = $false
+        }
+
+        PSPlaceCloseBrace          = @{
+            Enable             = $true
+            NoEmptyLineBefore  = $true
+            IgnoreOneLineBlock = $false
+            NewLineAfter       = $true
+        }
+
+        PSAlignAssignmentStatement = @{
+            Enable         = $true
+            CheckHashtable = $true
+        }
+    }
 }
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -7,16 +7,22 @@
     "powershell.codeFormatting.whitespaceAroundOperator": true,
     "powershell.codeFormatting.whitespaceAfterSeparator": true,
     "powershell.codeFormatting.ignoreOneLineBlock": false,
-    "powershell.codeFormatting.pipelineIndentationStyle": "IncreaseIndentationAfterEveryPipeline",
+    "powershell.codeFormatting.pipelineIndentationStyle": "IncreaseIndentationForFirstPipeline",
     "powershell.codeFormatting.preset": "Custom",
     "powershell.codeFormatting.alignPropertyValuePairs": true,
+    "powershell.codeFormatting.useConstantStrings": true,
+    "powershell.developer.bundledModulesPath": "${cwd}/output/RequiredModules",
+    "powershell.scriptAnalysis.settingsPath": "/.vscode/analyzersettings.psd1",
+    "powershell.scriptAnalysis.enable": true,
     "files.trimTrailingWhitespace": true,
+    "files.trimFinalNewlines": true,
     "files.insertFinalNewline": true,
-    "powershell.scriptAnalysis.settingsPath": ".vscode\\analyzersettings.psd1",
-    "powershell.scriptAnalysis.enable": true,
     "files.associations": {
         "*.ps1xml": "xml"
     },
+    "cSpell.dictionaries": [
+        "powershell"
+    ],
     "cSpell.words": [
         "COMPANYNAME",
         "ICONURI",
@@ -32,7 +38,21 @@
         "pscmdlet",
         "steppable"
     ],
+    "cSpell.ignorePaths": [
+        ".git"
+    ],
     "[markdown]": {
+        "files.trimTrailingWhitespace": true,
         "files.encoding": "utf8"
-    }
+    },
+    "powershell.pester.useLegacyCodeLens": false,
+    "pester.testFilePath": [
+        "[tT]ests/[qQ][aA]/*.[tT]ests.[pP][sS]1",
+        "[tT]ests/[uU]nit/**/*.[tT]ests.[pP][sS]1",
+        "[tT]ests/[uU]nit/*.[tT]ests.[pP][sS]1"
+    ],
+    "pester.runTestsInNewProcess": true,
+    "pester.pesterModulePath": "./output/RequiredModules/Pester",
+    "powershell.pester.codeLens": true,
+    "pester.suppressCodeLensNotice": true,
 }
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,6 +9,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Updated CHANGELOG.md
   - Renamed NetworkingDSc to NetworkingDsc in CHANGELOG.md - fixes [Issue #513](https://github.com/dsccommunity/NetworkingDsc/issues/513).
+- CI Pipeline
+  - Updated pipeline files to match current DSC Community patterns - fixes [Issue #528](https://github.com/dsccommunity/NetworkingDsc/issues/528).
+  - Updated HQRM and build steps to use windows-latest image.
 
 ## [9.0.0] - 2022-05-30
 

diff --git a/GitVersion.yml b/GitVersion.yml
@@ -1,7 +1,7 @@
 mode: ContinuousDelivery
-next-version: 7.4.0
-major-version-bump-message: '\s?(breaking|major|breaking\schange)'
-minor-version-bump-message: '\s?(add|feature|minor)'
+next-version: 4.1.0
+major-version-bump-message: '(breaking\schange|breaking)\b'
+minor-version-bump-message: '(adds?|minor)\b'
 patch-version-bump-message: '\s?(fix|patch)'
 no-bump-message: '\+semver:\s?(none|skip)'
 assembly-informational-format: '{NuGetVersionV2}+Sha.{Sha}.Date.{CommitDate}'

diff --git a/RequiredModules.psd1 b/RequiredModules.psd1
@@ -17,9 +17,17 @@
     'Sampler.GitHubTasks'       = 'latest'
     MarkdownLinkCheck           = 'latest'
     'DscResource.Test'          = 'latest'
-    'DscResource.AnalyzerRules' = 'latest'
-    'DscResource.DocGenerator'  = 'latest'
-    'DscResource.Common'        = 'latest'
     xDscResourceDesigner        = 'latest'
     LoopbackAdapter             = 'latest'
+
+    # Build dependencies needed for using the module
+    'DscResource.Common'           = 'latest'
+
+    # Analyzer rules
+    'DscResource.AnalyzerRules'    = 'latest'
+    'Indented.ScriptAnalyzerRules' = 'latest'
+
+    # Prerequisite modules for documentation.
+    'DscResource.DocGenerator'     = 'latest'
+    PlatyPS                        = 'latest'
 }