Centralize the project's version too

Add help document to updateVersion.ps1

Author: andyleejordan

.pipelines/PSScriptAnalyzer-Official.yml

@@ -63,8 +63,8 @@ extends:
           ob_outputDirectory: $(Build.SourcesDirectory)/out
         steps:
           - pwsh: |
-              [xml]$xml = Get-Content Engine/Engine.csproj
-              $version = $xml.SelectSingleNode(".//VersionPrefix")."#text"
+              [xml]$xml = Get-Content ./Directory.Build.props
+              $version = $xml.Project.PropertyGroup.ModuleVersion
               Write-Output "##vso[task.setvariable variable=version;isOutput=true]$version"
             name: package
             displayName: Get version from project properties

Directory.Build.props

@@ -1,5 +1,7 @@
 <Project>
+  <!-- See https://aka.ms/dotnet/msbuild/customize for more details on customizing your build -->
   <PropertyGroup>
+    <ModuleVersion>1.22.0</ModuleVersion>
     <ManagePackageVersionsCentrally>true</ManagePackageVersionsCentrally>
   </PropertyGroup>
 </Project>

Engine/Engine.csproj

@@ -1,10 +1,10 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <VersionPrefix>1.22.0</VersionPrefix>
+    <VersionPrefix>$(ModuleVersion)</VersionPrefix>
     <TargetFrameworks>net6;net462</TargetFrameworks>
     <AssemblyName>Microsoft.Windows.PowerShell.ScriptAnalyzer</AssemblyName>
-    <AssemblyVersion>1.22.0</AssemblyVersion>
+    <AssemblyVersion>$(ModuleVersion)</AssemblyVersion>
     <PackageId>Engine</PackageId>
     <RootNamespace>Microsoft.Windows.PowerShell.ScriptAnalyzer</RootNamespace> <!-- Namespace needs to match Assembly name for ressource binding -->
     <LangVersion>9.0</LangVersion>

Engine/PSScriptAnalyzer.psd1

@@ -11,7 +11,7 @@ Author = 'Microsoft Corporation'
 RootModule = 'PSScriptAnalyzer.psm1'
 
 # Version number of this module.
-ModuleVersion = '1.22.0'
+ModuleVersion = '{{ModuleVersion}}'
 
 # ID used to uniquely identify this module
 GUID = 'd6245802-193d-4068-a631-8863a4342a18'

PSCompatibilityCollector/Microsoft.PowerShell.CrossCompatibility/Microsoft.PowerShell.CrossCompatibility.csproj

@@ -1,9 +1,9 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <VersionPrefix>1.22.0</VersionPrefix>
+    <VersionPrefix>$(ModuleVersion)</VersionPrefix>
     <TargetFrameworks>netstandard2.0;net462</TargetFrameworks>
-    <AssemblyVersion>1.22.0</AssemblyVersion>
+    <AssemblyVersion>$(ModuleVersion)</AssemblyVersion>
   </PropertyGroup>
 
   <PropertyGroup Condition="'$(TargetFramework)' == 'netstandard2.0'">

Rules/Rules.csproj

@@ -1,10 +1,10 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <VersionPrefix>1.22.0</VersionPrefix>
+    <VersionPrefix>$(ModuleVersion)</VersionPrefix>
     <TargetFrameworks>net6;net462</TargetFrameworks>
     <AssemblyName>Microsoft.Windows.PowerShell.ScriptAnalyzer.BuiltinRules</AssemblyName>
-    <AssemblyVersion>1.22.0</AssemblyVersion>
+    <AssemblyVersion>$(ModuleVersion)</AssemblyVersion>
     <PackageId>Rules</PackageId>
     <RootNamespace>Microsoft.Windows.PowerShell.ScriptAnalyzer</RootNamespace> <!-- Namespace needs to match Assembly name for ressource binding -->
     <CopyLocalLockFileAssemblies>true</CopyLocalLockFileAssemblies> <!-- Needed in order for Pluralize.NET DLL to appear in bin folder - https://github.com/NuGet/Home/issues/4488 -->

Utils/ReleaseMaker.psm1

@@ -7,8 +7,8 @@ $analyzerName = "PSScriptAnalyzer"
 
 function Get-AnalyzerVersion
 {
-    [xml]$xml = Get-Content $([io.path]::Combine($projectRoot,"Engine","Engine.csproj"))
-    $xml.SelectSingleNode(".//VersionPrefix")."#text"
+    [xml]$xml = Get-Content $([io.path]::Combine($projectRoot, "Directory.Build.props"))
+    $xml.Project.PropertyGroup.ModuleVersion
 }
 
 $analyzerVersion = Get-AnalyzerVersion
@@ -159,9 +159,15 @@ function Start-ScriptAnalyzerBuild
             throw "Not in solution root"
         }
 
+        # "Copy" the module file with the version placeholder replaced
+        $manifestContent = Get-Content -LiteralPath "$projectRoot\Engine\PSScriptAnalyzer.psd1" -Raw
+        $newManifestContent = $manifestContent -replace '{{ModuleVersion}}', $analyzerVersion
+        Set-Content -LiteralPath "$script:destinationDir\PSScriptAnalyzer.psd1" -Encoding utf8 -Value $newManifestContent
+
         $itemsToCopyCommon = @(
-            "$projectRoot\Engine\PSScriptAnalyzer.psd1", "$projectRoot\Engine\PSScriptAnalyzer.psm1",
-            "$projectRoot\Engine\ScriptAnalyzer.format.ps1xml", "$projectRoot\Engine\ScriptAnalyzer.types.ps1xml"
+            "$projectRoot\Engine\PSScriptAnalyzer.psm1",
+            "$projectRoot\Engine\ScriptAnalyzer.format.ps1xml",
+            "$projectRoot\Engine\ScriptAnalyzer.types.ps1xml"
             )
 
         switch ($PSVersion)

build.psm1

@@ -0,0 +1,29 @@
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+
+param(
+    [Parameter(Mandatory)]
+    [semver]$Version,
+
+    [Parameter(Mandatory)]
+    [string]$Changes
+)
+
+git diff --staged --quiet --exit-code
+if ($LASTEXITCODE -ne 0) {
+    throw "There are staged changes in the repository. Please commit or reset them before running this script."
+}
+
+$Path = "Directory.Build.props"
+$f = Get-Content -Path $Path
+$f = $f -replace '^(?<prefix>\s+<ModuleVersion>)(.+)(?<suffix></ModuleVersion>)$', "`${prefix}${Version}`${suffix}"
+$f | Set-Content -Path $Path
+git add $Path
+
+$Path = "docs/Cmdlets/PSScriptAnalyzer.md"
+$f = Get-Content -Path $Path
+$f = $f -replace '^(?<prefix>Help Version: )(.+)$', "`${prefix}${Version}"
+$f | Set-Content -Path $Path
+git add $Path
+
+git commit --edit --message "v${Version}: $Changes"