Skip to content

feat: mirror README.md on the PowerShell Gallery package page #85

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
mikemadeja merged 2 commits into from
Sep 19, 2026
Merged

feat: mirror README.md on the PowerShell Gallery package page #85

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
75bc612
feat: mirror README.md on the PowerShell Gallery package page
mikemadeja Sep 19, 2026
573f071
Merge pull request #84 from mikemadeja/feat/gallery-readme
mikemadeja Sep 19, 2026
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
11 changes: 9 additions & 2 deletions .github/workflows/CreateRelease.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,16 +51,23 @@ jobs:
git tag ${{ steps.bump.outputs.new_tag }}
git push origin ${{ steps.bump.outputs.new_tag }}

- name: Copy README into module folder
shell: pwsh
run: |
# PowerShell Gallery renders a module's README.md if it's included in the published
# package; Publish-Module only packages the PiHoleShell/ folder, so it has to live there.
Copy-Item -Path README.md -Destination PiHoleShell/README.md -Force

- name: Zip folder
shell: pwsh
run: |
$modulePath = "PiHoleShell"
$manifest = Get-ChildItem -Path $modulePath -Filter PiHoleShell.psd1 -Recurse | Select-Object -First 1

if (-not $manifest) {
throw "No module manifest (*.psd1) found in $modulePath"
}

$version = $env:NEW_TAG -replace '^v', ''
(Get-Content $manifest.FullName) -replace '0.0.0', $version | Set-Content $manifest.FullName
Write-Host "Replacing 0.0.0 with $version in $($manifest.FullName)"
Expand Down
3 changes: 2 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
notes.txt
tests/IntegrationConfig.local.ps1
TestResults/
TestResults/
PiHoleShell/README.md
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,11 +48,11 @@ Import-Module -Name PiHoleShell

1. Log into your Pi-hole web interface, then go to **Web Interface / API** settings and select **Configure app password**.

<img src="docs/images/webinterfance_api.png" alt="Pi-hole Web Interface / API settings" width="450"/>
<img src="https://raw.githubusercontent.com/mikemadeja/PiHoleShell/main/docs/images/webinterfance_api.png" alt="Pi-hole Web Interface / API settings" width="450"/>

2. Copy the generated password, then click **Enable new app password**.

<img src="docs/images/configure_app_password.png" alt="Configure app password dialog" width="450"/>
<img src="https://raw.githubusercontent.com/mikemadeja/PiHoleShell/main/docs/images/configure_app_password.png" alt="Configure app password dialog" width="450"/>

Keep this password secret — anyone with it has full API access to your Pi-hole.

Expand Down
Loading