Merge pull request #21 from stiwicourage/develop

Enhance workflows and add Nova CLI functions for project management

Author: stiwicourage

.github/workflows/Tests.yml

@@ -2,11 +2,10 @@ name: Run Tests
 
 on:
   push:
-    branches:
-      - main
   pull_request:
     branches:
       - main
+      - develop
   workflow_dispatch:
 
 defaults:

.github/workflows/dependency-review.yml

@@ -0,0 +1,39 @@
+# Dependency Review Action
+#
+# This Action will scan dependency manifest files that change as part of a Pull Request,
+# surfacing known-vulnerable versions of the packages declared or updated in the PR.
+# Once installed, if the workflow run is marked as required, PRs introducing known-vulnerable
+# packages will be blocked from merging.
+#
+# Source repository: https://github.com/actions/dependency-review-action
+# Public documentation: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review#dependency-review-enforcement
+name: 'Dependency review'
+on:
+  pull_request:
+    branches: [ "develop" ]
+
+# If using a dependency submission action in this workflow this permission will need to be set to:
+#
+# permissions:
+#   contents: write
+#
+# https://docs.github.com/en/enterprise-cloud@latest/code-security/supply-chain-security/understanding-your-software-supply-chain/using-the-dependency-submission-api
+permissions:
+  contents: read
+  # Write permissions for pull-requests are required for using the `comment-summary-in-pr` option, comment out if you aren't using this option
+  pull-requests: write
+
+jobs:
+  dependency-review:
+    runs-on: ubuntu-latest
+    steps:
+      - name: 'Checkout repository'
+        uses: actions/checkout@v4
+      - name: 'Dependency Review'
+        uses: actions/dependency-review-action@v4
+        # Commonly enabled options, see https://github.com/actions/dependency-review-action#configuration-options for all available options.
+        with:
+          comment-summary-in-pr: always
+        #   fail-on-severity: moderate
+        #   deny-licenses: GPL-1.0-or-later, LGPL-2.0-or-later
+        #   retry-on-snapshot-warnings: true

.github/workflows/powershell.yml

@@ -0,0 +1,49 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+#
+# https://github.com/microsoft/action-psscriptanalyzer
+# For more information on PSScriptAnalyzer in general, see
+# https://github.com/PowerShell/PSScriptAnalyzer
+
+name: PSScriptAnalyzer
+
+on:
+  push:
+    branches: [ "develop" ]
+  pull_request:
+    branches: [ "develop" ]
+  schedule:
+    - cron: '22 19 * * 2'
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    permissions:
+      contents: read # for actions/checkout to fetch code
+      security-events: write # for github/codeql-action/upload-sarif to upload SARIF results
+      actions: read # only required for a private repository by github/codeql-action/upload-sarif to get the Action run status
+    name: PSScriptAnalyzer
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Run PSScriptAnalyzer
+        uses: microsoft/psscriptanalyzer-action@6b2948b1944407914a58661c49941824d149734f
+        with:
+          # Check https://github.com/microsoft/action-psscriptanalyzer for more info about the options.
+          # The below set up runs PSScriptAnalyzer to your entire repository and runs some basic security rules.
+          path: .\
+          recurse: true
+          # Include your own basic security rules. Removing this option will run all the rules
+          includeRule: '"PSAvoidGlobalAliases", "PSAvoidUsingConvertToSecureStringWithPlainText"'
+          output: results.sarif
+
+      # Upload the SARIF file generated in the previous step
+      - name: Upload SARIF results file
+        uses: github/codeql-action/upload-sarif@v3
+        with:
+          sarif_file: results.sarif

README.md

@@ -236,7 +236,7 @@ This is not required for local module builds. In this repository, GitHub Actions
 If you are running GitHub Actions, use the following yaml workflow template to test, build and publish a module, which helps to automate the process of:
 
 1. Checking out the repository code.
-1. Installing the `ModuleTools` bootstrap module from the PowerShell Gallery.
+1. Installing the `NovaModuleTools` bootstrap module from the PowerShell Gallery.
 1. Building the module.
 1. Running Pester tests.
 1. Running semantic-release to choose the version, update release files, tag, and publish.
@@ -273,9 +273,9 @@ jobs:
           npm ci
         shell: pwsh
 
-      - name: Install ModuleTools bootstrap module form PSGallery
+      - name: Install NovaModuleTools bootstrap module form PSGallery
         run: |
-          Install-PSResource -Repository PSGallery -Name ModuleTools -TrustRepository
+          Install-PSResource -Repository PSGallery -Name NovaModuleTools -TrustRepository
           Install-PSResource -Repository PSGallery -Name Microsoft.PowerShell.PlatyPS -TrustRepository
           Install-PSResource -Repository PSGallery -Name Pester -TrustRepository
         shell: pwsh

nova

@@ -0,0 +1,49 @@
+#!/usr/bin/env pwsh
+param(
+    [Parameter(Position = 0)]
+    [string]$Command,
+
+    [Parameter(Position = 1, ValueFromRemainingArguments)]
+    [string[]]$Arguments
+)
+
+$scriptRoot = Split-Path -Parent $MyInvocation.MyCommand.Path
+$projectFile = Join-Path $scriptRoot 'project.json'
+$projectName = if (Test-Path -LiteralPath $projectFile) {
+    (Get-Content -LiteralPath $projectFile -Raw | ConvertFrom-Json).ProjectName
+}
+else {
+    'NovaModuleTools'
+}
+
+function Import-NovaSourceScripts {
+    $srcRoot = Join-Path $scriptRoot 'src'
+    $scriptFolders = @('private', 'public')
+
+    foreach ($folder in $scriptFolders) {
+        $folderPath = Join-Path $srcRoot $folder
+        if (-not (Test-Path -LiteralPath $folderPath)) {
+            continue
+        }
+
+        $files = Get-ChildItem -Path $folderPath -Filter '*.ps1' -File -Recurse | Sort-Object FullName
+        foreach ($file in $files) {
+            . $file.FullName
+        }
+    }
+}
+
+$distModulePath = Join-Path $scriptRoot "dist/$projectName"
+$distModuleFile = Join-Path $distModulePath "$projectName.psm1"
+
+if (Test-Path -LiteralPath $distModuleFile) {
+    Import-Module $distModulePath -Force
+}
+elseif (Test-Path -LiteralPath (Join-Path $scriptRoot 'src/public/InvokeNovaCli.ps1')) {
+    Import-NovaSourceScripts
+}
+else {
+    Import-Module $projectName -Force
+}
+
+Invoke-NovaCli -Command $Command @Arguments

src/private/GetGitCommitMessagesForVersionBump.ps1

@@ -0,0 +1,29 @@
+function Get-GitCommitMessageForVersionBump {
+    [CmdletBinding()]
+    param(
+        [Parameter(Mandatory)][string]$ProjectRoot
+    )
+
+    if (-not (Test-Path -LiteralPath (Join-Path $ProjectRoot '.git'))) {
+        return @()
+    }
+
+    $format = '%s%n%b%n--END-COMMIT--'
+    $lastTag = & git -C $ProjectRoot describe --tags --abbrev=0 2> $null
+
+    if ($LASTEXITCODE -eq 0 -and -not [string]::IsNullOrWhiteSpace($lastTag)) {
+        $raw = & git -C $ProjectRoot log "$lastTag..HEAD" --format=$format 2> $null
+    }
+    else {
+        $raw = & git -C $ProjectRoot log --format=$format 2> $null
+    }
+
+    if ($LASTEXITCODE -ne 0 -or -not $raw) {
+        return @()
+    }
+
+    $text = ($raw -join [Environment]::NewLine)
+    $commits = $text -split '(?m)^--END-COMMIT--\r?$'
+    return @($commits | ForEach-Object {$_.Trim()} | Where-Object {-not [string]::IsNullOrWhiteSpace($_)})
+}
+

src/private/GetNovaCliOptions.ps1

@@ -0,0 +1,51 @@
+function ConvertFrom-NovaCliArgument {
+    [CmdletBinding()]
+    param(
+        [string[]]$Arguments
+    )
+
+    $options = @{}
+    $index = 0
+
+    while ($index -lt $Arguments.Count) {
+        $token = $Arguments[$index]
+
+        switch -Regex ($token) {
+            '^(--local|-Local)$' {
+                $options.Local = $true
+            }
+            '^(--repository|-Repository)$' {
+                $index++
+                if ($index -ge $Arguments.Count) {
+                    throw 'Missing value for --repository'
+                }
+
+                $options.Repository = $Arguments[$index]
+            }
+            '^(--path|-Path|-ModuleDirectoryPath)$' {
+                $index++
+                if ($index -ge $Arguments.Count) {
+                    throw 'Missing value for --path'
+                }
+
+                $options.ModuleDirectoryPath = $Arguments[$index]
+            }
+            '^(--apikey|-ApiKey)$' {
+                $index++
+                if ($index -ge $Arguments.Count) {
+                    throw 'Missing value for --apikey'
+                }
+
+                $options.ApiKey = $Arguments[$index]
+            }
+            default {
+                throw "Unknown argument: $token"
+            }
+        }
+
+        $index++
+    }
+
+    return $options
+}
+

src/private/GetVersionLabelFromCommitMessages.ps1

@@ -0,0 +1,21 @@
+function Get-VersionLabelFromCommitSet {
+    [CmdletBinding()]
+    param(
+        [Parameter(Mandatory)][string[]]$Messages
+    )
+
+    if ($Messages | Where-Object {$_ -match '(?im)BREAKING CHANGE|^[a-z]+(\(.+\))?!:'}) {
+        return 'Major'
+    }
+
+    if ($Messages | Where-Object {$_ -match '(?im)^\s*feat(\(.+\))?:'}) {
+        return 'Minor'
+    }
+
+    if ($Messages | Where-Object {$_ -match '(?im)^\s*fix(\(.+\))?:'}) {
+        return 'Patch'
+    }
+
+    return 'Patch'
+}
+

src/private/PublishNovaBuiltModule.ps1

@@ -0,0 +1,39 @@
+function Publish-NovaBuiltModule {
+    [CmdletBinding(DefaultParameterSetName = 'Local')]
+    param(
+        [Parameter(ParameterSetName = 'Repository')]
+        [string]$Repository,
+
+        [string]$ModuleDirectoryPath,
+        [string]$ApiKey
+    )
+
+    $projectInfo = Get-MTProjectInfo
+
+    if (-not (Test-Path -LiteralPath $projectInfo.OutputModuleDir)) {
+        throw 'Dist folder is empty, build the module before running publish command'
+    }
+
+    if ($PSCmdlet.ParameterSetName -eq 'Repository') {
+        $resolvedApiKey = $ApiKey
+        if ($Repository -eq 'PSGallery' -and [string]::IsNullOrWhiteSpace($resolvedApiKey)) {
+            $resolvedApiKey = $env:PSGALLERY_API
+        }
+
+        $publishParams = @{
+            Path = $projectInfo.OutputModuleDir
+            Repository = $Repository
+            Verbose = $true
+        }
+
+        if (-not [string]::IsNullOrWhiteSpace($resolvedApiKey)) {
+            $publishParams.ApiKey = $resolvedApiKey
+        }
+
+        Publish-PSResource @publishParams
+        return
+    }
+
+    Publish-MTLocal -ModuleDirectoryPath $ModuleDirectoryPath
+}
+

src/public/GetNovaProjectInfo.ps1

@@ -0,0 +1,17 @@
+function Get-NovaProjectInfo {
+    [CmdletBinding()]
+    param(
+        [Parameter(Position = 0)]
+        [string]$Path = (Get-Location).Path,
+
+        [switch]$Version
+    )
+
+    $projectInfo = Get-MTProjectInfo -Path $Path
+
+    if ($Version) {
+        return $projectInfo.Version
+    }
+
+    return $projectInfo
+}