Skip to content

Latest commit

 

History

History
158 lines (118 loc) · 5.87 KB

README.md

File metadata and controls

158 lines (118 loc) · 5.87 KB
Raw

SCCMCheckCmdletChanges

French version

Checks source files for the presence of a command name using a regex. The occurrences of a command in comments are considered, because if we do use the Powershell AST you can no longer search in the source files in C# for example.

Each SCCM release note specifies various changes to its cmdlets. An command can be deleted, deprecated, its contract changed with or without breaking change or even delivered with an unresolved bug.

To reference the modifications of a SCCM release this module uses a hashtable hosted in a .psd1 file. Each key name in this hashtable specifies a type of modification and is associated with an array of command name or an empty array.

Example for the breaking changes of the release note 2103 :

   BreakingChangesCommandNames=@(
      'New-CMSoftwareUpdateAutoDeploymentRule'
      'Set-CMSoftwareUpdateAutoDeploymentRule'
   )

Hashtable key details

LibraryChangesForVersion

Specifies the version of the release note concerned.

Url

Specifies the url of the release note on the publisher's documentation site (Microsoft)

RemovedCmdletNames

List of deleted Cmdlets The code using them needs to be corrected. These deletions are considered in the analytical result as breaking changes.

RemovedAliasNames

List of deleted aliases. The code using them needs to be corrected. These deletions are considered in the analytical result as breaking changes.

UnsupportedPSCoreCommandNames

Since release 2103 SCCM cmdlets can be used with Powershell 7, except for a few.

Searching for these cmdlets is enabled through the -VerifyCoreCLR parameter of the Find-CommandName function.

DeprecatedCommandNames

List of obsolete (deprecated) cmdlets The code using them is not impacted, it is recommended to stop using them and to adapt the code.

UnresolvedBugCommandNames

The listed items have known issues that are not resolved in this release. The code using them may need to be corrected if the bug was not known during development.

ChangedCommandNames

The following changes have been made to existing cmdlets in this release. They can be new features, bug fixes, or deprecation. Carefully review the changes to understand how they may affect your usage. The code using them may need to be corrected if the bug was not known during development.

BreakingChangesCommandNames

List the modifications of commands having breaking changes. The behavior of the command has been modified, the code using them needs to be corrected.

Note:

new commands are not referenced in this hashtable, as it is assumed that they do not exist in the current source code. If necessary, changes to these new cmdlets will be specified in the next release.

Then the Find-CommandName cmdlet iterates through these .psd1 files.

Examples

cd Demo
Find-CommandName -path .\Examples\Test.ps1

Return for this file :

Version                    : 2002
Name                       : Set-CMScriptDeploymentType
Type                       : Cmdlet
Path                       : .\Examples\Test.ps1
isRemoved                  : False
isUnsupportedPSCore        : False
isDeprecated               : False
isUnResolvedBug            : False
isChanged                  : True
isBreakingChange           : True

Version                    : 2006
Name                       : Set-CMScriptDeploymentType
Type                       : Cmdlet
Path                       : .\Examples\Test.ps1
isRemoved                  : False
isUnsupportedPSCore        : False
isDeprecated               : False
isUnResolvedBug            : False
isChanged                  : True
isBreakingChange           : False

An command can be present in several release notes and for different reasons. Default code search target for Powershell v5.1.

If your Powershell Core target code ( >= V7) specify the VerifyCoreCLR parameter:

cd Demo
Find-CommandName -path .\Examples\TestUnsupportedPSCoreCmdlets.ps1 -VerifyCoreCLR

Return for this file :

Version             : 2111
Name                : Set-CMScriptDeploymentType
Type                : Cmdlet
Path                : .\Examples\TestUnsupportedPSCoreCmdlets.ps1
isRemoved           : False
isUnsupportedPSCore : False
isDeprecated        : False
isUnResolvedBug     : False
isChanged           : True
isBreakingChange    : False

Version             : 2103
Name                : Export-CMPackage
Type                : Cmdlet
Path                : .\Examples\TestUnsupportedPSCoreCmdlets.ps1
isRemoved           : False
isUnsupportedPSCore : True
isDeprecated        : False
isUnResolvedBug     : False
isChanged           : False
isBreakingChange    : False

Version             : 2111
Name                : Export-CMPackage
Type                : Cmdlet
Path                : .\Examples\TestUnsupportedPSCoreCmdlets.ps1
isRemoved           : False
isUnsupportedPSCore : True
isDeprecated        : False
isUnResolvedBug     : False
isChanged           : False
isBreakingChange    : False

In this case we can find two entries for the same version, here the 2111, one indicating that the cmdlet is not supported by Powershell Core, the other indicating the modifications for Powershell version 5.1.

You can also filter cmdlets that are not supported:

Find-CommandName -path .\Examples\TestUnsupportedPSCoreCmdlets.ps1 -VerifyCoreCLR|
  Where-Object { $_.isUnsupportedPSCore }|
  Select-Object -ExpandProperty Name -Unique

or group the result by version :

Find-CommandName -path .\Examples\TestUnsupportedPSCoreCmdlets.ps1 -VerifyCoreCLR|
 Group-object isUnsupportedPSCore