Update help descriptions and devops files.

Author: homotechsual

.gitignore

@@ -1 +1,2 @@
 output
+docs

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 Please note that backwards compatibility breaks are prefixed with `{"BC"}` (short for Breaking Change).
 
+## 2024-02-18 - Version 2.0.0-RC4
+
+* Change secret vault to use the SecretManagement module.
+
 ## 2024-02-16 - Version 2.0.0-RC3
 
 * Fix broken ticket commandlet.

Source/Public/Connect-NinjaOne.ps1

@@ -19,7 +19,13 @@ function Connect-NinjaOne {
 
             This logs into NinjaOne using the refresh token flow.
         .EXAMPLE
-            PS> Connect-NinjaOne -UseSecretManagement -VaultName 'NinjaOneVault' -WriteToSecretVault
+            PS> Connect-NinjaOne -UseSecretManagement -VaultName 'NinjaOneVault' -WriteToSecretVault -Instance 'eu' -ClientId 'AAaaA1aaAaAA-aaAaaA11a1A-aA' -ClientSecret '00Z00zzZzzzZzZzZzZzZZZ0zZ0zzZ_0zzz0zZZzzZz0Z0ZZZzz0z0Z' -UseClientAuth
+
+            This logs into NinjaOne using the client credentials flow and writes the connection information to the secret vault.
+        .EXAMPLE
+            PS> Connect-NinjaOne -UseSecretManagement -VaultName 'NinjaOneVault' -ReadFromSecretVault
+
+            This reads the connection information from the secret vault.
         .OUTPUTS
             Sets two script-scoped variables to hold connection and authentication information.
         .LINK
@@ -85,7 +91,7 @@ function Connect-NinjaOne {
         [Parameter( ParameterSetName = 'Token Authentication' )]
         [Parameter( ParameterSetName = 'Client Credentials' )]
         [Switch]$ShowTokens,
-        # Use the secret management module to retrieve credentials and store tokens.
+        # Use the secret management module to retrieve credentials and store tokens. Check the docs on setting up the secret management module at https://docs.homotechsual.dev/common/secretmanagement.
         [Parameter( ParameterSetName = 'Authorisation Code' )]
         [Parameter( ParameterSetName = 'Token Authentication' )]
         [Parameter( ParameterSetName = 'Client Credentials' )]

build.ps1

@@ -4,10 +4,12 @@
 #>
 [CmdletBinding()]
 Param (
-    [String[]]$TaskNames = ('clean', 'build', 'test', 'updateManifest', 'publish', 'updateHelp', 'generateShortNamesMapping', 'push'),
+    [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 'buildConfig.psd1' | Import-PowerShellDataFile -LiteralPath { $_ } -ErrorAction SilentlyContinue
+        Join-Path -Path $PSScriptRoot -ChildPath 'Source' | Join-Path -ChildPath 'build.psd1' | Import-PowerShellDataFile -LiteralPath { $_ } -ErrorAction SilentlyContinue
     ),
     [Switch]$ExcludeCustomTasks = $false,
     [System.Management.Automation.SemanticVersion]$SemVer
@@ -20,14 +22,28 @@ if (-Not(Get-Module -Name 'Install-RequiredModule')) {
 Install-RequiredModule -RequiredModulesFile ('{0}\RequiredModules.psd1' -f $PSScriptRoot) -Scope CurrentUser -TrustRegisteredRepositories -Import -Quiet
 # 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
     )
-    Import-Module ('.\Source\{0}.psd1' -f $Script:ModuleName) -Force
+    $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)
@@ -90,7 +106,7 @@ This page has been generated from the {0} PowerShell module source. To make chan
 '@ -f $Script:ModuleName
     $ExcludeFiles = Get-ChildItem -Path "$($PSScriptRoot)\Private" -Filter '*.ps1' -Recurse | ForEach-Object { [System.IO.Path]::GetFileNameWithoutExtension($_.FullName) }
     $NewDocusaurusHelpParams = @{
-        Module = ('.\Source\{0}.psd1' -f $Script:ModuleName)
+        Module = (GetModulePath -ModuleName $Script:ModuleName)
         DocsFolder = $DocsFolderPath
         Exclude = $ExcludeFiles
         Sidebar = 'commandlets'
@@ -226,37 +242,6 @@ This page has been generated from the {0} PowerShell module source. To make chan
 function Build {
     Build-Module -Path '.\Source' -SemVer $SemVer.ToString()
 }
-# Task: Copy PowerShell Module files to output folder for release on PSGallery
-function CopyModuleFiles {
-    # Copy Module Files to Output Folder
-    if (-not (Test-Path "$($PSScriptRoot)\Output\$Script:ModuleName")) {
-        New-Item -Path "$($PSScriptRoot)\Output\$Script:ModuleName" -ItemType Directory | Out-Null
-    }
-    if (Test-Path -Path "$($PSScriptRoot)\Classes\") {
-        Copy-Item -Path "$($PSScriptRoot)\Classes\" -Filter *.* -Recurse -Destination "$($PSScriptRoot)\Output\$Script:ModuleName" -Force
-    }
-    if (Test-Path -Path "$($PSScriptRoot)\Data\") {
-        Copy-Item -Path "$($PSScriptRoot)\Data\" -Filter *.* -Recurse -Destination "$($PSScriptRoot)\Output\$Script:ModuleName" -Force
-    }
-    Copy-Item -Path "$($PSScriptRoot)\Private\" -Filter *.* -Recurse -Destination "$($PSScriptRoot)\Output\$Script:ModuleName" -Force
-    Copy-Item -Path "$($PSScriptRoot)\Public\" -Filter *.* -Recurse -Destination "$($PSScriptRoot)\Output\$Script:ModuleName" -Force
-
-    # Copy module, manifest and scaffold files
-    Copy-Item -Path @(
-        "$($PSScriptRoot)\LICENSE.md"
-        "$($PSScriptRoot)\CHANGELOG.md"
-        "$($PSScriptRoot)\README.md"
-        "$($PSScriptRoot)\$Script:ModuleName.psd1"
-        "$($PSScriptRoot)\$Script:ModuleName.psm1"
-    ) -Destination "$($PSScriptRoot)\Output\$Script:ModuleName" -Force
-}
-# Task: Run all Pester tests in folder .\Tests
-function Test {
-    $Result = Invoke-Pester "$($PSScriptRoot)\Tests" -PassThru
-    if ($Result.FailedCount -gt 0) {
-        throw 'Pester tests failed'
-    }
-}
 # Task: Update the Module Manifest file with info from the Changelog.
 function UpdateManifest {
     # Import PlatyPS. Needed for parsing the versions in the Changelog.