Skip to content

Commit 8b12ecc

Browse files
🚀 [Feature]: Moved documentation management to Process-PSModule (#32)
## Description - Moved documentation management to Process-PSModule. ## Type of change <!-- Use the check-boxes [x] on the options that are relevant. --> - [ ] 📖 [Docs] - [ ] 🪲 [Fix] - [ ] 🩹 [Patch] - [ ] ⚠️ [Security fix] - [x] 🚀 [Feature] - [ ] 🌟 [Breaking change] ## Checklist <!-- Use the check-boxes [x] on the options that are relevant. --> - [x] I have performed a self-review of my own code - [x] I have commented my code, particularly in hard-to-understand areas
1 parent 58d3285 commit 8b12ecc

File tree

9 files changed

+0
-312
lines changed

9 files changed

+0
-312
lines changed

.github/workflows/Action-Test.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,5 @@ jobs:
3030
with:
3131
Name: PSModuleTest
3232
ModulePath: tests/outputs/modules
33-
DocsPath: tests/outputs/docs
3433
APIKey: ${{ secrets.APIKEY }}
3534
WhatIf: true

README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,6 @@ The action can be configured using the following settings:
5252
| `AutoPatching` | Control wether to automatically handle patches. If disabled, the action will only create a patch release if the pull request has a 'patch' label. | `true` | false |
5353
| `ConfigurationFile` | The path to the configuration file. Settings in the configuration file take precedence over the action inputs. | `.github\auto-release.yml` | false |
5454
| `DatePrereleaseFormat` | The format to use for the prerelease number using [.NET DateTime format strings](https://learn.microsoft.com/en-us/dotnet/standard/base-types/standard-date-and-time-format-strings). | `''` | false |
55-
| `DocsPath` | Path to the folder where the module documentation is located. | `outputs/docs` | false |
5655
| `IgnoreLabels` | A comma separated list of labels that do not trigger a release. | `NoRelease` | false |
5756
| `IncrementalPrerelease` | Control wether to automatically increment the prerelease number. If disabled, the action will ensure only one prerelease exists for a given branch. | `true` | false |
5857
| `MajorLabels` | A comma separated list of labels that trigger a major release. | `major, breaking` | false |

action.yml

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,6 @@ inputs:
1313
description: Path to the module to publish.
1414
required: false
1515
default: outputs/modules
16-
DocsPath:
17-
description: Path to the module documentation.
18-
required: false
19-
default: outputs/docs
2016
APIKey:
2117
description: PowerShell Gallery API Key.
2218
required: true
@@ -73,7 +69,6 @@ runs:
7369
env:
7470
GITHUB_ACTION_INPUT_Name: ${{ inputs.Name }}
7571
GITHUB_ACTION_INPUT_ModulePath: ${{ inputs.ModulePath }}
76-
GITHUB_ACTION_INPUT_DocsPath: ${{ inputs.DocsPath }}
7772
GITHUB_ACTION_INPUT_APIKey: ${{ inputs.APIKey }}
7873
GITHUB_ACTION_INPUT_AutoCleanup: ${{ inputs.AutoCleanup }}
7974
GITHUB_ACTION_INPUT_AutoPatching: ${{ inputs.AutoPatching }}

scripts/helpers/Publish-PSModule.ps1

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,6 @@ function Publish-PSModule {
2121
[Parameter(Mandatory)]
2222
[string] $ModulePath,
2323

24-
# The path to the documentation to process.
25-
[Parameter(Mandatory)]
26-
[string] $DocsPath,
27-
2824
# The API key for the destination repository.
2925
[Parameter(Mandatory)]
3026
[string] $APIKey
@@ -380,13 +376,6 @@ function Publish-PSModule {
380376
Write-Output "::notice::Release created: [$newVersion]"
381377
Stop-LogGroup
382378
#endregion New-GitHubRelease
383-
384-
#region Publish-Docs
385-
Start-LogGroup "Publish docs - [$DocsPath]"
386-
Write-Verbose 'Publish docs to GitHub Pages'
387-
Write-Verbose 'Update docs path: Update-ModuleMetadata'
388-
Stop-LogGroup
389-
#endregion Publish-Docs
390379
}
391380
#endregion Create releases
392381

scripts/main.ps1

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,17 +23,11 @@ Write-Verbose "Module path: [$modulePath]"
2323
if (-not (Test-Path -Path $modulePath)) {
2424
throw "Module path [$modulePath] does not exist."
2525
}
26-
$docsPath = Join-Path -Path $env:GITHUB_WORKSPACE -ChildPath $env:GITHUB_ACTION_INPUT_DocsPath $name
27-
Write-Verbose "Docs path: [$docsPath]"
28-
if (-not (Test-Path -Path $docsPath)) {
29-
throw "Documentation path [$docsPath] does not exist."
30-
}
3126
Stop-LogGroup
3227

3328
$params = @{
3429
Name = $name
3530
ModulePath = $modulePath
36-
DocsPath = $docsPath
3731
APIKey = $env:GITHUB_ACTION_INPUT_APIKey
3832
}
3933
Publish-PSModule @params -Verbose

tests/outputs/docs/PSModuleTest/Get-PSModuleTest.md

Lines changed: 0 additions & 72 deletions
This file was deleted.

tests/outputs/docs/PSModuleTest/New-PSModuleTest.md

Lines changed: 0 additions & 72 deletions
This file was deleted.

tests/outputs/docs/PSModuleTest/Set-PSModuleTest.md

Lines changed: 0 additions & 72 deletions
This file was deleted.

tests/outputs/docs/PSModuleTest/Test-PSModuleTest.md

Lines changed: 0 additions & 72 deletions
This file was deleted.

0 commit comments

Comments
 (0)