From c75903a5cc0617a547c436969b79bcf92700b628 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sat, 7 Dec 2024 15:55:45 +0100 Subject: [PATCH 1/5] Moving docs one level out (not in a modulename folder --- .../helpers/Build/Build-PSModuleDocumentation.ps1 | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/scripts/helpers/Build/Build-PSModuleDocumentation.ps1 b/scripts/helpers/Build/Build-PSModuleDocumentation.ps1 index 0509373..fe6360f 100644 --- a/scripts/helpers/Build/Build-PSModuleDocumentation.ps1 +++ b/scripts/helpers/Build/Build-PSModuleDocumentation.ps1 @@ -71,29 +71,28 @@ function Build-PSModuleDocumentation { } } - # Markdown files are called the same as the source files, but with a .md extension. - # They are all located flat in the docsoutputfolder. - # I want the markdown files to be moved in the same folder structure as the source files. LogGroup 'Build docs - Structure markdown files to match source files' { - $PublicFunctions = Join-Path $ModuleSourceFolder.FullName 'functions\public' | Get-Item + $tmpDocsFolderPath = Join-Path -Path $DocsOutputFolder -ChildPath $ModuleName + Move-Item -Path $tmpDocsFolderPath -Destination $DocsOutputFolder -Force + $PublicFunctionsFolder = Join-Path $ModuleSourceFolder.FullName 'functions\public' | Get-Item Get-ChildItem -Path $DocsOutputFolder -Recurse -Force -Include '*.md' | ForEach-Object { $file = $_ Write-Verbose "Processing: $file" # find the source code file that matches the markdown file - $scriptPath = Get-ChildItem -Path $PublicFunctions -Recurse -Force | Where-Object { $_.Name -eq ($file.BaseName + '.ps1') } + $scriptPath = Get-ChildItem -Path $PublicFunctionsFolder -Recurse -Force | Where-Object { $_.Name -eq ($file.BaseName + '.ps1') } Write-Verbose "Found script path: $scriptPath" - $docsFilePath = ($scriptPath.FullName).Replace($PublicFunctions.FullName, $DocsOutputFolder.FullName).Replace('.ps1', '.md') + $docsFilePath = ($scriptPath.FullName).Replace($PublicFunctionsFolder.FullName, $DocsOutputFolder.FullName).Replace('.ps1', '.md') Write-Verbose "Doc file path: $docsFilePath" $docsFolderPath = Split-Path -Path $docsFilePath -Parent New-Item -Path $docsFolderPath -ItemType Directory -Force Move-Item -Path $file.FullName -Destination $docsFilePath -Force } # Get the MD files that are in the public functions folder and move them to the same place in the docs folder - Get-ChildItem -Path $PublicFunctions -Recurse -Force -Include '*.md' | ForEach-Object { + Get-ChildItem -Path $PublicFunctionsFolder -Recurse -Force -Include '*.md' | ForEach-Object { $file = $_ Write-Verbose "Processing: $file" - $docsFilePath = ($file.FullName).Replace($PublicFunctions.FullName, $DocsOutputFolder.FullName) + $docsFilePath = ($file.FullName).Replace($PublicFunctionsFolder.FullName, $DocsOutputFolder.FullName) Write-Verbose "Doc file path: $docsFilePath" $docsFolderPath = Split-Path -Path $docsFilePath -Parent New-Item -Path $docsFolderPath -ItemType Directory -Force From 7ab6f3284a6da00ea7631aa69ecb45870b47921b Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sat, 7 Dec 2024 15:59:18 +0100 Subject: [PATCH 2/5] move to parrent --- scripts/helpers/Build/Build-PSModuleDocumentation.ps1 | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/scripts/helpers/Build/Build-PSModuleDocumentation.ps1 b/scripts/helpers/Build/Build-PSModuleDocumentation.ps1 index fe6360f..5a14d58 100644 --- a/scripts/helpers/Build/Build-PSModuleDocumentation.ps1 +++ b/scripts/helpers/Build/Build-PSModuleDocumentation.ps1 @@ -72,8 +72,8 @@ function Build-PSModuleDocumentation { } LogGroup 'Build docs - Structure markdown files to match source files' { - $tmpDocsFolderPath = Join-Path -Path $DocsOutputFolder -ChildPath $ModuleName - Move-Item -Path $tmpDocsFolderPath -Destination $DocsOutputFolder -Force + $tmpDocsFolderPath = Split-Path -Path $DocsOutputFolder.FullName -Parent + Move-Item -Path $tmpDocsFolderPath -Destination $tmpDocsFolderPath -Force $PublicFunctionsFolder = Join-Path $ModuleSourceFolder.FullName 'functions\public' | Get-Item Get-ChildItem -Path $DocsOutputFolder -Recurse -Force -Include '*.md' | ForEach-Object { $file = $_ From 86e66dabe8441fa9d8504bb0ec27c465eb7761c7 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sat, 7 Dec 2024 15:59:38 +0100 Subject: [PATCH 3/5] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Fix=20destination?= =?UTF-8?q?=20path=20for=20moving=20documentation=20files=20in=20Build-PSM?= =?UTF-8?q?oduleDocumentation.ps1?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- scripts/helpers/Build/Build-PSModuleDocumentation.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/helpers/Build/Build-PSModuleDocumentation.ps1 b/scripts/helpers/Build/Build-PSModuleDocumentation.ps1 index 5a14d58..59989c3 100644 --- a/scripts/helpers/Build/Build-PSModuleDocumentation.ps1 +++ b/scripts/helpers/Build/Build-PSModuleDocumentation.ps1 @@ -73,7 +73,7 @@ function Build-PSModuleDocumentation { LogGroup 'Build docs - Structure markdown files to match source files' { $tmpDocsFolderPath = Split-Path -Path $DocsOutputFolder.FullName -Parent - Move-Item -Path $tmpDocsFolderPath -Destination $tmpDocsFolderPath -Force + Move-Item -Path $DocsOutputFolder -Destination $tmpDocsFolderPath -Force $PublicFunctionsFolder = Join-Path $ModuleSourceFolder.FullName 'functions\public' | Get-Item Get-ChildItem -Path $DocsOutputFolder -Recurse -Force -Include '*.md' | ForEach-Object { $file = $_ From d21f0b2a443f53eb7b4b2f9d1b5b616214b52060 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sat, 7 Dec 2024 16:06:52 +0100 Subject: [PATCH 4/5] test --- scripts/helpers/Build-PSModule.ps1 | 2 +- scripts/helpers/Build/Build-PSModuleDocumentation.ps1 | 2 -- 2 files changed, 1 insertion(+), 3 deletions(-) diff --git a/scripts/helpers/Build-PSModule.ps1 b/scripts/helpers/Build-PSModule.ps1 index bf4c219..4101b64 100644 --- a/scripts/helpers/Build-PSModule.ps1 +++ b/scripts/helpers/Build-PSModule.ps1 @@ -51,7 +51,7 @@ function Build-PSModule { Build-PSModuleManifest -ModuleName $ModuleName -ModuleOutputFolder $moduleOutputFolder Build-PSModuleRootModule -ModuleName $ModuleName -ModuleOutputFolder $moduleOutputFolder Update-PSModuleManifestAliasesToExport -ModuleName $ModuleName -ModuleOutputFolder $moduleOutputFolder - Build-PSModuleDocumentation -ModuleName $ModuleName -ModuleSourceFolder $moduleSourceFolder -DocsOutputFolder $docsOutputFolder + Build-PSModuleDocumentation -ModuleName $ModuleName -ModuleSourceFolder $moduleSourceFolder -DocsOutputFolder $DocsOutputFolderPath LogGroup 'Build manifest file - Final Result' { $outputManifestPath = Join-Path -Path $ModuleOutputFolder -ChildPath "$ModuleName.psd1" diff --git a/scripts/helpers/Build/Build-PSModuleDocumentation.ps1 b/scripts/helpers/Build/Build-PSModuleDocumentation.ps1 index 59989c3..423c406 100644 --- a/scripts/helpers/Build/Build-PSModuleDocumentation.ps1 +++ b/scripts/helpers/Build/Build-PSModuleDocumentation.ps1 @@ -72,8 +72,6 @@ function Build-PSModuleDocumentation { } LogGroup 'Build docs - Structure markdown files to match source files' { - $tmpDocsFolderPath = Split-Path -Path $DocsOutputFolder.FullName -Parent - Move-Item -Path $DocsOutputFolder -Destination $tmpDocsFolderPath -Force $PublicFunctionsFolder = Join-Path $ModuleSourceFolder.FullName 'functions\public' | Get-Item Get-ChildItem -Path $DocsOutputFolder -Recurse -Force -Include '*.md' | ForEach-Object { $file = $_ From d7c05efb7f6b2cb06960a042abe620a9aa4770c4 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sat, 7 Dec 2024 16:09:28 +0100 Subject: [PATCH 5/5] fix --- scripts/helpers/Build-PSModule.ps1 | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/scripts/helpers/Build-PSModule.ps1 b/scripts/helpers/Build-PSModule.ps1 index 4101b64..4dbb424 100644 --- a/scripts/helpers/Build-PSModule.ps1 +++ b/scripts/helpers/Build-PSModule.ps1 @@ -43,7 +43,7 @@ function Build-PSModule { $moduleOutputFolder = New-Item -Path $ModulesOutputFolderPath -Name $ModuleName -ItemType Directory -Force Write-Verbose "Module output folder: [$moduleOutputFolder]" - $docsOutputFolder = New-Item -Path $DocsOutputFolderPath -Name $ModuleName -ItemType Directory -Force + $docsOutputFolder = New-Item -Path $DocsOutputFolderPath -ItemType Directory -Force Write-Verbose "Docs output folder: [$docsOutputFolder]" } @@ -51,7 +51,7 @@ function Build-PSModule { Build-PSModuleManifest -ModuleName $ModuleName -ModuleOutputFolder $moduleOutputFolder Build-PSModuleRootModule -ModuleName $ModuleName -ModuleOutputFolder $moduleOutputFolder Update-PSModuleManifestAliasesToExport -ModuleName $ModuleName -ModuleOutputFolder $moduleOutputFolder - Build-PSModuleDocumentation -ModuleName $ModuleName -ModuleSourceFolder $moduleSourceFolder -DocsOutputFolder $DocsOutputFolderPath + Build-PSModuleDocumentation -ModuleName $ModuleName -ModuleSourceFolder $moduleSourceFolder -DocsOutputFolder $docsOutputFolder LogGroup 'Build manifest file - Final Result' { $outputManifestPath = Join-Path -Path $ModuleOutputFolder -ChildPath "$ModuleName.psd1"