-
-
Notifications
You must be signed in to change notification settings - Fork 26
/
build.ps1
376 lines (374 loc) · 16.5 KB
/
build.ps1
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
# requires -Version 7.0
<#
.SYNOPSIS
Homotechsual portable module build script.
#>
[CmdletBinding()]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseCompatibleSyntax', '', Justification = 'Script runs in CI/CD pipelines and is not designed to run on old versions.')]
Param (
[ValidateSet('clean', 'build', 'updateManifest', 'publish', 'updateHelp', 'generateShortNamesMapping', 'push')]
[String[]]$TaskNames = ('clean', 'build', 'updateManifest', 'publish', 'updateHelp', 'generateShortNamesMapping', 'push'),
[ValidateSet('origin', 'homotechsual')]
[String[]]$Remotes = @('origin', 'homotechsual'),
[Hashtable]$BuildConfig = (
Join-Path -Path $PSScriptRoot -ChildPath 'Source' | Join-Path -ChildPath 'build.psd1' | Import-PowerShellDataFile -LiteralPath { $_ } -ErrorAction SilentlyContinue
),
[Switch]$ExcludeCustomTasks = $false,
[System.Management.Automation.SemanticVersion]$SemVer
)
$Script:ModuleName = 'NinjaOne'
# Install required modules
if (-Not(Get-Module -Name 'Install-RequiredModule')) {
Install-Script -Name 'Install-RequiredModule' -Force -Scope CurrentUser
}
Install-RequiredModule -RequiredModulesFile ('{0}\RequiredModules.psd1' -f $PSScriptRoot) -Scope CurrentUser -TrustRegisteredRepositories -Import -Quiet
Import-Module 'R:\Development\Docusaurus.PowerShell\Output\Alt3.Docusaurus.PowerShell\1.0.34\Alt3.Docusaurus.PowerShell.psd1' -Force
# Use strict mode when building.
Set-StrictMode -Version Latest
# Helper: Get the module PSD1 file path.
function GetModulePath {
[CmdletBinding()]
param(
[Parameter(Mandatory)]
[String]$ModuleName
)
$ModulePath = (Get-ChildItem -Path ('{0}\Output\*\*\{1}.psd1' -f $PSScriptRoot, $ModuleName)).FullName
if (!(Test-Path -Path $ModulePath)) {
throw ('Module {0} not found at "{1}".' -f $ModuleName, $ModulePath)
}
return $ModulePath
}
# Helper: Get functions from the module.
function GetFunctions {
[CmdletBinding()]
param(
[Parameter(Mandatory)]
[String]$ModuleName
)
$ModulePath = GetModulePath -ModuleName $ModuleName
Import-Module $ModulePath -Force
$Module = Get-Module -Name $Script:ModuleName
$CommandletList = [System.Collections.Generic.List[String]]::new()
$CommandletList.AddRange($Module.ExportedFunctions.Keys)
return $CommandletList
}
# Task: Push to remote repositories.
function Push {
[CmdletBinding()]
param(
[Parameter()]
[String[]]$Remotes = @('origin', 'homotechsual')
)
# Push to remote repositories.
foreach ($Remote in $Remotes) {
Start-Process -FilePath 'git' -ArgumentList @('push', $Remote) -Wait -NoNewWindow
Start-Process -FilePath 'git' -ArgumentList @('push', $Remote, '--tags') -Wait -NoNewWindow
}
}
# Task: (Re)Generate the mapping file for the short names of the commandlets. Stored in the Functionality item of the comment based help. The file will be stored in .\.build\CommandletShortNames.yaml
## Requres YAYAML installed.
function GenerateShortNamesMapping {
$OutputFilePath = [System.IO.FileInfo]'.\.build\CommandletShortNames.yaml'
$ShortNameOutput = [System.Collections.Generic.Dictionary[String, String]]::new()
$CommandletList = GetFunctions -ModuleName $Script:ModuleName
foreach ($Commandlet in $CommandletList) {
$AST = (Get-Content -Path ('function:/{0}' -f $Commandlet) -ErrorAction Ignore).AST
$ShortName = $AST.GetHelpContent().Functionality
if ($ShortName) {
$ShortNameOutput.Add($Commandlet, $ShortName)
} else {
throw ('Commandlet {0} does not have a short name.' -f $Commandlet)
}
}
if ($ShortNameOutput.Count -eq $CommandletList.Count) {
$ShortNameOutput | ConvertTo-Yaml | Out-File -FilePath $OutputFilePath -Force
} else {
$CommandletList | Where-Object { -not $ShortNameOutput.ContainsKey($_) } | ForEach-Object { WriteMessage ('Commandlet {0} not present in the short name list.' -f $_) -Category Warning }
throw 'Not all commandlets have a short name.'
}
}
# Task: Update the PowerShell Module Help Files.
## Requires PlatyPS, Pester, PSScriptAnalyzer and Alt3.Docusaurus.PowerShell installed.
function UpdateHelp {
[CmdletBinding()]
param (
[System.IO.DirectoryInfo]$DocusaurusPath = '.\docs',
[bool]$ForceUpdateCategoryFiles = $true
)
$DocsFolderPath = Join-Path -Path $DocusaurusPath -ChildPath $Script:ModuleName
if (-Not(Test-Path -Path $DocsFolderPath)) {
New-Item -Path $DocsFolderPath -ItemType Directory | Out-Null
}
$ShortNamesFilePath = [System.IO.FileInfo]'.\.build\CommandletShortNames.yaml'
$ShortNamesYAML = Get-Content -Path $ShortNamesFilePath
$ShortNamesDictionary = ConvertFrom-Yaml -InputObject $ShortNamesYAML
$MarkdownHeader = @'
:::powershell[Generated Cmdlet Help]
This page has been generated from the {0} PowerShell module source. To make changes please edit the appropriate PowerShell source file.
:::
'@ -f $Script:ModuleName
$ExcludeFiles = Get-ChildItem -Path "$($PSScriptRoot)\Private" -Filter '*.ps1' -Recurse | ForEach-Object { [System.IO.Path]::GetFileNameWithoutExtension($_.FullName) }
$NewDocusaurusHelpParams = @{
Module = (GetModulePath -ModuleName $Script:ModuleName)
DocsFolder = $DocsFolderPath
Exclude = $ExcludeFiles
Sidebar = 'commandlets'
# MetaDescription = 'Generated cmdlet help for the %1 commandlet.'
GroupByVerb = $true
UseDescriptionFromHelp = $true
NoPlaceHolderExamples = $true
UseCustomShortTitles = $true
ShortTitles = $ShortNamesDictionary
PrependMarkdown = $MarkdownHeader
RemoveParameters = @('-ProgressAction', '-FakeParam')
}
New-DocusaurusHelp @NewDocusaurusHelpParams | Out-Null
$CommandletDocsFolder = Join-Path -Path $DocusaurusPath -ChildPath $Script:ModuleName -AdditionalChildPath 'commandlets'
$VerbFolders = Get-ChildItem -Path $CommandletDocsFolder -Directory
$CategoryFileBase = @{
position = 1
collapsible = $true
collapsed = $true
link = @{
type = 'generated-index'
}
customProps = @{
description = ''
}
}
foreach ($VerbFolder in $VerbFolders) {
$HasCategoryFile = Get-ChildItem -Path $VerbFolder.FullName -Filter '_category_.*' -File -ErrorAction SilentlyContinue
$CategoryFilePath = Join-Path -Path $VerbFolder.FullName -ChildPath '_category_.json'
switch ($VerbFolder.Name) {
'Connect' {
$CategoryFile = $CategoryFileBase
$CategoryFile.label = 'Connect to Services'
$CategoryFile.position = 0.1
$CategoryFile.collapsed = $false
$CategoryFile.className = 'category-connect'
$CategoryFile.link.title = 'Connect to Services'
$CategoryFile.customProps.description = 'This category contains commands for connecting to services, retrieving and storing credentials and managing connections.'
}
'Find' {
$CategoryFile = $CategoryFileBase
$CategoryFile.label = 'Find Information'
$CategoryFile.position = 0.2
$CategoryFile.className = 'category-find'
$CategoryFile.link.title = 'Find Information'
$CategoryFile.customProps.description = 'This category contains commands for finding information from services, this may include data, objects, settings and more.'
}
'Get' {
$CategoryFile = $CategoryFileBase
$CategoryFile.label = 'Retrieve Information'
$CategoryFile.position = 0.3
$CategoryFile.className = 'category-get'
$CategoryFile.link.title = 'Retrieve Information'
$CategoryFile.customProps.description = 'This category contains commands for retrieving information from services, this may include data, objects, settings and more.'
}
'Invoke' {
$CategoryFile = $CategoryFileBase
$CategoryFile.label = 'Invoke Actions'
$CategoryFile.position = 0.4
$CategoryFile.className = 'category-invoke'
$CategoryFile.link.title = 'Invoke Actions'
$CategoryFile.customProps.description = 'This category contains commands for invoking actions, this may include running scripts, executing commands and more. For API modules, this category will contain commands for sending arbitrary requests to the API - that is requests not covered by existing commands.'
}
'New' {
$CategoryFile = $CategoryFileBase
$CategoryFile.label = 'Create Data'
$CategoryFile.position = 0.5
$CategoryFile.className = 'category-new'
$CategoryFile.link.title = 'Create Data'
$CategoryFile.customProps.description = 'This category contains commands for creating data, objects, settings and more.'
}
'Remove' {
$CategoryFile = $CategoryFileBase
$CategoryFile.label = 'Remove Data'
$CategoryFile.position = 0.6
$CategoryFile.className = 'category-remove'
$CategoryFile.link.title = 'Remove Data'
$CategoryFile.customProps.description = 'This category contains commands for removing data, objects, settings and more.'
}
'Reset' {
$CategoryFile = $CategoryFileBase
$CategoryFile.label = 'Reset State'
$CategoryFile.position = 0.6
$CategoryFile.className = 'category-reset'
$CategoryFile.link.title = 'Reset State'
$CategoryFile.customProps.description = 'This category contains commands for resetting state, this may include resetting settings, connections and more.'
}
'Restart' {
$CategoryFile = $CategoryFileBase
$CategoryFile.label = 'Restart Services'
$CategoryFile.position = 0.6
$CategoryFile.className = 'category-restart'
$CategoryFile.link.title = 'Restart Services'
$CategoryFile.customProps.description = 'This category contains commands for restarting services, this may include restarting services, processes and more.'
}
'Restore' {
$CategoryFile = $CategoryFileBase
$CategoryFile.label = 'Restore Data'
$CategoryFile.position = 0.6
$CategoryFile.className = 'category-restore'
$CategoryFile.link.title = 'Restore Data'
$CategoryFile.customProps.description = 'This category contains commands for restoring data, objects, settings and more. These commands will primarily be used for restoring data to a previous state.'
}
'Set' {
$CategoryFile = $CategoryFileBase
$CategoryFile.label = 'Update Data (Set)'
$CategoryFile.position = 0.4
$CategoryFile.className = 'category-set'
$CategoryFile.link.title = 'Update Data (Set)'
$CategoryFile.customProps.description = 'This category contains commands for updating data, objects, settings and more. This category will overlap with the Update category.'
}
'Update' {
$CategoryFile = $CategoryFileBase
$CategoryFile.label = 'Update Data (Update)'
$CategoryFile.position = 0.4
$CategoryFile.className = 'category-update'
$CategoryFile.link.title = 'Update Data (Update)'
$CategoryFile.customProps.description = 'This category contains commands for updating data, objects, settings and more. This category will overlap with the Set category.'
}
}
if (-Not($HasCategoryFile)) {
$CategoryFile | ConvertTo-Json | Out-File -FilePath $CategoryFilePath -Force
} else {
if (-Not($ForceUpdateCategoryFiles)) {
Write-Warning -Message ('Category file already exists in "{0}" verb folder. Use the ForceUpdateCategoryFiles switch to overwrite existing category files.' -f $VerbFolder.Name)
} else {
Set-Content -Path $CategoryFilePath -Value ($CategoryFile | ConvertTo-Json) -Force
}
}
}
}
# Task: Build the PowerShell Module
function Build {
Build-Module -Path '.\Source' -SemVer $SemVer.ToString()
}
# Task: Update the Module Manifest file with info from the Changelog.
function UpdateManifest {
# Import PlatyPS. Needed for parsing the versions in the Changelog.
Import-Module -Name PlatyPS
# Find Latest Version in Change log.
$CHANGELOG = Get-Content -Path "$($PSScriptRoot)\CHANGELOG.md"
$MarkdownObject = [Markdown.MAML.Parser.MarkdownParser]::new()
[regex]$Regex = '\d\.\d\.\d'
$Versions = $Regex.Matches($MarkdownObject.ParseString($CHANGELOG).Children.Spans.Text) | ForEach-Object { $_.Value }
$ChangeLogVersion = ($Versions | Measure-Object -Maximum).Maximum
$ManifestPath = "$($PSScriptRoot)\$Script:ModuleName.psd1"
# Start by importing the manifest to determine the version, then add 1 to the Build
$Manifest = Test-ModuleManifest -Path $ManifestPath
[System.Version]$Version = $Manifest.Version
if ($ChangeLogVersion -eq $Version) {
throw 'No new version found in CHANGELOG.md'
}
Write-Output -InputObject ("Current Module Version: $($Version)")
Write-Output -InputObject ("New Module version: $($ChangeLogVersion)")
# Update Manifest file with Release Notes
$CHANGELOG = Get-Content -Path "$($PSScriptRoot)\CHANGELOG.md"
$MarkdownObject = [Markdown.MAML.Parser.MarkdownParser]::new()
$ReleaseNotes = ((($MarkdownObject.ParseString($CHANGELOG).Children.Spans.Text) -Match '\d\.\d\.\d') -Split ' - ')[1]
# Update Module with new version
Update-ModuleManifest -ModuleVersion $ChangeLogVersion -Path "$($PSScriptRoot)\$Script:ModuleName.psd1" -ReleaseNotes $ReleaseNotes
}
# Task: Publish Module to PowerShell Gallery
function Publish {
[CmdletBinding()]
param()
Try {
# Build a splat containing the required details and make sure to Stop for errors which will trigger the catch
$PublishParams = @{
Path = Join-Path -Path $PSScriptRoot -ChildPath 'output\*\*\*.psd1' | Get-Item | Where-Object { $_.BaseName -eq $_.Directory.Parent.Name } | Select-Object -ExpandProperty Directory
NuGetApiKey = $ENV:TF_BUILD ? $ENV:PSGalleryAPIKey : (Get-AzKeyVaultSecret -VaultName $ENV:PSGalleryVault -Name $ENV:PSGallerySecret -AsPlainText) # If running in Azure DevOps, use the Environment Variable, otherwise use the Key Vault
ErrorAction = 'Stop'
}
$ManifestPath = Get-ChildItem -Path $PublishParams.Path -Filter '*.psd1'
$Manifest = Test-ModuleManifest -Path $ManifestPath
if ($Manifest.PrivateData.PSData.Prerelease) {
[System.Management.Automation.SemanticVersion]$Version = ('{0}-{1}' -f $Manifest.Version, $Manifest.PrivateData.PSData.Prerelease)
} else {
[System.Management.Automation.SemanticVersion]$Version = $Manifest.Version
}
Publish-Module @PublishParams
Write-Output -InputObject ("$Script:ModuleName PowerShell Module version $($Version.ToString()) published to the PowerShell Gallery")
} Catch {
throw $_
}
}
# Task: Clean up Output folder
function Clean {
# Clean output folder
if ((Test-Path "$($PSScriptRoot)\Build")) {
Remove-Item -Path "$($PSScriptRoot)\Build" -Recurse -Force
}
}
# Helper: Write a message to the console.
function WriteMessage {
[CmdletBinding()]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidUsingWriteHost', '', Justification = 'Script is not intended to be used as a module.')]
param (
# The message to write to the console.
[Parameter(Mandatory, ValueFromPipeline)]
[String]$Message,
# The category of the message.
[ValidateSet('Information', 'Warning', 'Error', 'Success')]
[String]$Category = 'Information',
# Additional details to write to the console.
[String]$Details
)
process {
$Params = @{
Object = ('{0}: {1}' -f $Message, $Details).TrimEnd(' :')
ForegroundColor = switch ($Category) {
'Success' { 'Green' }
'Information' { 'Cyan' }
'Warning' { 'Yellow' }
'Error' { 'Red' }
}
}
Write-Host @Params
}
}
# Helper: Invoke a task.
function InvokeTask {
[CmdletBinding()]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidUsingWriteHost', '', Justification = 'Script is not intended to be used as a module.')]
param (
[Parameter(Mandatory, ParameterSetName = 'ExecuteFunction', ValueFromPipeline)]
[String]$TaskName,
[Parameter(Mandatory, ParameterSetName = 'ExecuteScript', ValueFromPipelineByPropertyName)]
[Alias('FullName')]
[String]$Path
)
begin {
WriteMessage ('Build {0}' -f $PSCommandPath) -Category Success
}
process {
if ($PSCmdlet.ParameterSetName -eq 'ExecuteScript') {
$TaskName = [System.IO.Path]::GetFileNameWithoutExtension($Path)
}
$ErrorActionPreference = 'Stop'
try {
$StopWatch = [System.Diagnostics.Stopwatch]::StartNew()
WriteMessage -Message ('Task {0}' -f $TaskName)
if ($PSCmdlet.ParameterSetName -eq 'ExecuteFunction') {
& "Script:$TaskName"
} else {
& $Path
}
WriteMessage -Message ('Done {0} {1}' -f $TaskName, $StopWatch.Elapsed)
} catch {
WriteMessage -Message ('Failed {0} [{1}]' -f $TaskName, $StopWatch.Elapsed) -Category Error -Details $_.Exception.Message
exit 1
} finally {
$StopWatch.Stop()
}
}
}
$TasksPath = Join-Path -Path $PSScriptRoot -ChildPath '.build\tasks'
@(
$TaskNames
if ((-not $ExcludeCustomTasks) -and (Test-Path $TasksPath)) {
Get-ChildItem -Path $TasksPath
}
) | Where-Object { -not $BuildConfig -or $BuildConfig['Skip'] -NotContains $_ } | InvokeTask