mirror of
https://github.com/EvotecIT/GPOZaurr.git
synced 2026-07-26 11:49:17 +00:00
Prefer local PowerForge module for website artifacts (#86)
* Prefer local PowerForge module for website artifacts * Ignore generated website artifact outputs
This commit is contained in:
Przemysław Kłys
@@ -6,3 +6,5 @@ ReleasesUnpacked/*
|
||||
*.log
|
||||
*.html
|
||||
Artefacts/*
|
||||
WebsiteArtifacts/
|
||||
en-US/
|
||||
|
||||
@@ -0,0 +1,188 @@
|
||||
[CmdletBinding()]
|
||||
param(
|
||||
[switch]$SkipBuild,
|
||||
[string]$ArtifactsRoot = (Join-Path $PSScriptRoot '..\WebsiteArtifacts')
|
||||
)
|
||||
|
||||
$ErrorActionPreference = 'Stop'
|
||||
|
||||
$repoRoot = [System.IO.Path]::GetFullPath((Join-Path $PSScriptRoot '..'))
|
||||
$moduleName = 'GPOZaurr'
|
||||
$slug = 'gpozaurr'
|
||||
$docsSource = Join-Path $repoRoot 'Docs'
|
||||
$helpCandidates = @(
|
||||
(Join-Path $repoRoot "en-US\$moduleName-help.xml"),
|
||||
(Join-Path $repoRoot "Artefacts\Unpacked\$moduleName\en-US\$moduleName-help.xml")
|
||||
)
|
||||
$examplesSource = Join-Path $repoRoot 'Examples'
|
||||
$placeholderMarkers = @(
|
||||
'{{ Fill in the Synopsis }}',
|
||||
'{{ Fill in the Description }}',
|
||||
'{{ Add example code here }}',
|
||||
'{{ Add example description here }}'
|
||||
)
|
||||
|
||||
function Import-LocalPSPublishModule {
|
||||
$candidateRoots = @()
|
||||
|
||||
if ($env:POWERFORGE_ROOT) {
|
||||
$candidateRoots += $env:POWERFORGE_ROOT
|
||||
}
|
||||
|
||||
$candidateRoots += [System.IO.Path]::GetFullPath((Join-Path $PSScriptRoot '..\..\PSPublishModule'))
|
||||
|
||||
foreach ($root in $candidateRoots | Select-Object -Unique) {
|
||||
if ([string]::IsNullOrWhiteSpace($root)) {
|
||||
continue
|
||||
}
|
||||
|
||||
$manifestPath = Join-Path $root 'Module\PSPublishModule.psd1'
|
||||
if (Test-Path -LiteralPath $manifestPath -PathType Leaf) {
|
||||
Import-Module $manifestPath -Force -ErrorAction Stop
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
Import-Module PSPublishModule -Force -ErrorAction Stop
|
||||
}
|
||||
|
||||
function Find-HelpFile {
|
||||
foreach ($candidate in $helpCandidates) {
|
||||
if (Test-Path -LiteralPath $candidate -PathType Leaf) {
|
||||
return [System.IO.Path]::GetFullPath($candidate)
|
||||
}
|
||||
}
|
||||
|
||||
return $null
|
||||
}
|
||||
|
||||
function Test-PlaceholderContent {
|
||||
param(
|
||||
[Parameter(Mandatory)]
|
||||
[string]$Path
|
||||
)
|
||||
|
||||
foreach ($marker in $placeholderMarkers) {
|
||||
$match = Select-String -Path $Path -Pattern $marker -SimpleMatch -List -ErrorAction SilentlyContinue
|
||||
if ($match) {
|
||||
throw "Placeholder API content detected in '$Path' ($marker)."
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
function Get-PlaceholderMatches {
|
||||
param(
|
||||
[Parameter(Mandatory)]
|
||||
[string]$Path
|
||||
)
|
||||
|
||||
if (-not (Test-Path -LiteralPath $Path)) {
|
||||
return @()
|
||||
}
|
||||
|
||||
$files = if (Test-Path -LiteralPath $Path -PathType Container) {
|
||||
Get-ChildItem -LiteralPath $Path -File -Recurse
|
||||
} else {
|
||||
Get-Item -LiteralPath $Path
|
||||
}
|
||||
|
||||
foreach ($file in $files) {
|
||||
foreach ($marker in $placeholderMarkers) {
|
||||
$match = Select-String -Path $file.FullName -Pattern $marker -SimpleMatch -List -ErrorAction SilentlyContinue
|
||||
if ($match) {
|
||||
[PSCustomObject]@{
|
||||
Path = $file.FullName
|
||||
Marker = $marker
|
||||
}
|
||||
break
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (-not (Get-Command Invoke-ModuleBuild -ErrorAction SilentlyContinue)) {
|
||||
Import-LocalPSPublishModule
|
||||
}
|
||||
|
||||
$helpPath = Find-HelpFile
|
||||
if (-not $helpPath -and -not $SkipBuild) {
|
||||
$docsPlaceholders = @(Get-PlaceholderMatches -Path $docsSource)
|
||||
if ($docsPlaceholders.Count -gt 0) {
|
||||
$sample = ($docsPlaceholders | Select-Object -First 5 | ForEach-Object { "$($_.Path) [$($_.Marker)]" }) -join '; '
|
||||
Write-Warning "Docs still contain placeholder markdown from a previous generation pass. Continuing with module build so fresh external help can be regenerated. Sample matches: $sample"
|
||||
}
|
||||
|
||||
try {
|
||||
& (Join-Path $PSScriptRoot 'Manage-Module.ps1') -SkipPublish
|
||||
} catch {
|
||||
$helpPath = Find-HelpFile
|
||||
if (-not $helpPath) {
|
||||
throw
|
||||
}
|
||||
|
||||
Write-Warning "Manage-Module.ps1 reported a build failure after external help was generated. Continuing website artifact export with the refreshed help output. Original error: $($_.Exception.Message)"
|
||||
}
|
||||
|
||||
$helpPath = Find-HelpFile
|
||||
}
|
||||
|
||||
if (-not $helpPath) {
|
||||
throw "Unable to find $moduleName external help. Run .\Build\Manage-Module.ps1 first."
|
||||
}
|
||||
|
||||
Test-PlaceholderContent -Path $helpPath
|
||||
|
||||
$resolvedArtifactsRoot = [System.IO.Path]::GetFullPath($ArtifactsRoot)
|
||||
$apiRoot = Join-Path $resolvedArtifactsRoot 'apidocs\powershell'
|
||||
$examplesTarget = Join-Path $apiRoot 'examples'
|
||||
|
||||
if (Test-Path -LiteralPath $apiRoot) {
|
||||
Remove-Item -LiteralPath $apiRoot -Recurse -Force
|
||||
}
|
||||
|
||||
New-Item -ItemType Directory -Path $apiRoot -Force | Out-Null
|
||||
Copy-Item -LiteralPath $helpPath -Destination (Join-Path $apiRoot "$moduleName-help.xml") -Force
|
||||
|
||||
if (Test-Path -LiteralPath $examplesSource -PathType Container) {
|
||||
Copy-Item -LiteralPath $examplesSource -Destination $examplesTarget -Recurse -Force
|
||||
}
|
||||
|
||||
$psd1Path = Join-Path $repoRoot "$moduleName.psd1"
|
||||
$version = $null
|
||||
if (Test-Path -LiteralPath $psd1Path -PathType Leaf) {
|
||||
$version = (Import-PowerShellDataFile -Path $psd1Path).ModuleVersion.ToString()
|
||||
}
|
||||
|
||||
$commit = (& git -C $repoRoot rev-parse HEAD).Trim()
|
||||
$manifest = [ordered]@{
|
||||
slug = $slug
|
||||
name = $moduleName
|
||||
description = 'GPOZaurr website artifacts for the Evotec multi-project hub.'
|
||||
mode = 'hub-full'
|
||||
contentMode = 'hybrid'
|
||||
status = 'active'
|
||||
listed = $true
|
||||
version = $version
|
||||
generatedAt = (Get-Date).ToString('o')
|
||||
commit = $commit
|
||||
links = [ordered]@{
|
||||
source = 'https://github.com/EvotecIT/GPOZaurr'
|
||||
}
|
||||
surfaces = [ordered]@{
|
||||
docs = $true
|
||||
apiPowerShell = $true
|
||||
apiDotNet = $false
|
||||
examples = $false
|
||||
}
|
||||
artifacts = [ordered]@{
|
||||
api = 'WebsiteArtifacts/apidocs'
|
||||
docs = 'Website/content/project-docs'
|
||||
examples = 'Examples'
|
||||
}
|
||||
}
|
||||
|
||||
$manifestPath = Join-Path $resolvedArtifactsRoot 'project-manifest.json'
|
||||
New-Item -ItemType Directory -Path $resolvedArtifactsRoot -Force | Out-Null
|
||||
$manifest | ConvertTo-Json -Depth 6 | Set-Content -LiteralPath $manifestPath -Encoding UTF8
|
||||
|
||||
Write-Host "Exported website artifacts -> $resolvedArtifactsRoot" -ForegroundColor Green
|
||||
+40
-3
@@ -1,4 +1,39 @@
|
||||
[CmdletBinding()]
|
||||
param(
|
||||
[switch]$SkipPublish
|
||||
)
|
||||
|
||||
try {
|
||||
Clear-Host
|
||||
} catch {
|
||||
Write-Verbose "Skipping Clear-Host because the current host is non-interactive."
|
||||
}
|
||||
|
||||
function Import-LocalPSPublishModule {
|
||||
$candidateRoots = @()
|
||||
|
||||
if ($env:POWERFORGE_ROOT) {
|
||||
$candidateRoots += $env:POWERFORGE_ROOT
|
||||
}
|
||||
|
||||
$candidateRoots += [System.IO.Path]::GetFullPath((Join-Path $PSScriptRoot '..\..\PSPublishModule'))
|
||||
|
||||
foreach ($root in $candidateRoots | Select-Object -Unique) {
|
||||
if ([string]::IsNullOrWhiteSpace($root)) {
|
||||
continue
|
||||
}
|
||||
|
||||
$manifestPath = Join-Path $root 'Module\PSPublishModule.psd1'
|
||||
if (Test-Path -LiteralPath $manifestPath -PathType Leaf) {
|
||||
Import-Module $manifestPath -Force -ErrorAction Stop
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
Import-Module PSPublishModule -Force -ErrorAction Stop
|
||||
}
|
||||
|
||||
Import-LocalPSPublishModule
|
||||
|
||||
Invoke-ModuleBuild -ModuleName 'GPOZaurr' {
|
||||
# Usual defaults as per standard module
|
||||
@@ -208,7 +243,7 @@ Invoke-ModuleBuild -ModuleName 'GPOZaurr' {
|
||||
# when creating PSD1 use special style without comments and with only required parameters
|
||||
New-ConfigurationFormat -ApplyTo 'DefaultPSD1', 'OnMergePSD1' -PSD1Style 'Minimal'
|
||||
# configuration for documentation, at the same time it enables documentation processing
|
||||
New-ConfigurationDocumentation -Enable:$false -StartClean -UpdateWhenNew -PathReadme 'Docs\Readme.md' -Path 'Docs'
|
||||
New-ConfigurationDocumentation -Enable:$true -StartClean -UpdateWhenNew -SyncExternalHelpToProjectRoot -PathReadme 'Docs\Readme.md' -Path 'Docs'
|
||||
|
||||
#New-ConfigurationImportModule -ImportSelf
|
||||
|
||||
@@ -220,6 +255,8 @@ Invoke-ModuleBuild -ModuleName 'GPOZaurr' {
|
||||
New-ConfigurationArtefact -Type Packed -Enable -Path "$PSScriptRoot\..\Artefacts\Packed" -ArtefactName '<ModuleName>.v<ModuleVersion>.zip' -AddRequiredModules
|
||||
|
||||
# options for publishing to github/psgallery
|
||||
#New-ConfigurationPublish -Type PowerShellGallery -FilePath 'C:\Support\Important\PowerShellGalleryAPI.txt' -Enabled:$true
|
||||
#New-ConfigurationPublish -Type GitHub -FilePath 'C:\Support\Important\GitHubAPI.txt' -UserName 'EvotecIT' -Enabled:$true
|
||||
if (-not $SkipPublish) {
|
||||
New-ConfigurationPublish -Type PowerShellGallery -FilePath 'C:\Support\Important\PowerShellGalleryAPI.txt' -Enabled:$true
|
||||
New-ConfigurationPublish -Type GitHub -FilePath 'C:\Support\Important\GitHubAPI.txt' -UserName 'EvotecIT' -Enabled:$true
|
||||
}
|
||||
} -ExitCode
|
||||
Reference in New Issue
Block a user