Skip to content

🚀 [Feature]: Moved documentation management to Process-PSModule #32

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jul 18, 2024
Merged

🚀 [Feature]: Moved documentation management to Process-PSModule #32

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
15254af
Adjust for docs being in site folder
MariusStorhaug Jul 12, 2024
a4b0c9c
Fix docs path
MariusStorhaug Jul 12, 2024
057d921
Remove placeholder code for docs publishing
MariusStorhaug Jul 14, 2024
5e6de97
Remove docs param from action docs
MariusStorhaug Jul 14, 2024
000f52d
Publish module no longer caters for docs
MariusStorhaug Jul 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .github/workflows/Action-Test.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,5 @@ jobs:
with:
Name: PSModuleTest
ModulePath: tests/outputs/modules
DocsPath: tests/outputs/docs
APIKey: ${{ secrets.APIKEY }}
WhatIf: true
1 change: 0 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,6 @@ The action can be configured using the following settings:
| `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 |
| `ConfigurationFile` | The path to the configuration file. Settings in the configuration file take precedence over the action inputs. | `.github\auto-release.yml` | false |
| `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 |
| `DocsPath` | Path to the folder where the module documentation is located. | `outputs/docs` | false |
| `IgnoreLabels` | A comma separated list of labels that do not trigger a release. | `NoRelease` | false |
| `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 |
| `MajorLabels` | A comma separated list of labels that trigger a major release. | `major, breaking` | false |
Expand Down
5 changes: 0 additions & 5 deletions action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,6 @@ inputs:
description: Path to the module to publish.
required: false
default: outputs/modules
DocsPath:
description: Path to the module documentation.
required: false
default: outputs/docs
APIKey:
description: PowerShell Gallery API Key.
required: true
Expand Down Expand Up @@ -73,7 +69,6 @@ runs:
env:
GITHUB_ACTION_INPUT_Name: ${{ inputs.Name }}
GITHUB_ACTION_INPUT_ModulePath: ${{ inputs.ModulePath }}
GITHUB_ACTION_INPUT_DocsPath: ${{ inputs.DocsPath }}
GITHUB_ACTION_INPUT_APIKey: ${{ inputs.APIKey }}
GITHUB_ACTION_INPUT_AutoCleanup: ${{ inputs.AutoCleanup }}
GITHUB_ACTION_INPUT_AutoPatching: ${{ inputs.AutoPatching }}
Expand Down
11 changes: 0 additions & 11 deletions scripts/helpers/Publish-PSModule.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,6 @@ function Publish-PSModule {
[Parameter(Mandatory)]
[string] $ModulePath,

# The path to the documentation to process.
[Parameter(Mandatory)]
[string] $DocsPath,

# The API key for the destination repository.
[Parameter(Mandatory)]
[string] $APIKey
Expand Down Expand Up @@ -380,13 +376,6 @@ function Publish-PSModule {
Write-Output "::notice::Release created: [$newVersion]"
Stop-LogGroup
#endregion New-GitHubRelease

#region Publish-Docs
Start-LogGroup "Publish docs - [$DocsPath]"
Write-Verbose 'Publish docs to GitHub Pages'
Write-Verbose 'Update docs path: Update-ModuleMetadata'
Stop-LogGroup
#endregion Publish-Docs
}
#endregion Create releases

Expand Down
6 changes: 0 additions & 6 deletions scripts/main.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,17 +23,11 @@ Write-Verbose "Module path: [$modulePath]"
if (-not (Test-Path -Path $modulePath)) {
throw "Module path [$modulePath] does not exist."
}
$docsPath = Join-Path -Path $env:GITHUB_WORKSPACE -ChildPath $env:GITHUB_ACTION_INPUT_DocsPath $name
Write-Verbose "Docs path: [$docsPath]"
if (-not (Test-Path -Path $docsPath)) {
throw "Documentation path [$docsPath] does not exist."
}
Stop-LogGroup

$params = @{
Name = $name
ModulePath = $modulePath
DocsPath = $docsPath
APIKey = $env:GITHUB_ACTION_INPUT_APIKey
}
Publish-PSModule @params -Verbose
72 changes: 0 additions & 72 deletions tests/outputs/docs/PSModuleTest/Get-PSModuleTest.md
View file
Open in desktop

This file was deleted.

72 changes: 0 additions & 72 deletions tests/outputs/docs/PSModuleTest/New-PSModuleTest.md
View file
Open in desktop

This file was deleted.

72 changes: 0 additions & 72 deletions tests/outputs/docs/PSModuleTest/Set-PSModuleTest.md
View file
Open in desktop

This file was deleted.

72 changes: 0 additions & 72 deletions tests/outputs/docs/PSModuleTest/Test-PSModuleTest.md
View file
Open in desktop

This file was deleted.