Skip to content

Comments

Add comprehensive PowerShellBuild documentation section#42

Merged
HeyItsGilbert merged 4 commits intomainfrom
claude/plan-powershellbuild-docs-P99p5
Feb 22, 2026
Merged

Add comprehensive PowerShellBuild documentation section#42
HeyItsGilbert merged 4 commits intomainfrom
claude/plan-powershellbuild-docs-P99p5

Conversation

@HeyItsGilbert
Copy link
Member

Summary

This PR adds a complete documentation section for PowerShellBuild, the official companion module to psake that provides pre-built tasks for PowerShell module projects. The new section includes five focused guides covering introduction, getting started, task reference, configuration, and a real-world example.

Key Changes

  • New documentation category: Created docs/powershellbuild/ with five comprehensive markdown files:

    • introduction.md — Overview of PowerShellBuild, its relationship to psake, and when to use it
    • getting-started.md — Step-by-step guide to set up PowerShellBuild in a new project with minimal configuration
    • task-reference.md — Complete reference of all pre-built tasks with dependency graph (Mermaid diagram) and descriptions
    • configuration.md — Full $PSBPreference hashtable reference with all configuration options organized by category
    • real-world-example.md — Production-ready example project showing custom tasks, CI/CD integration, and PSGallery publishing
  • Sidebar integration: Updated sidebars.ts to add the new PowerShellBuild category to the guides sidebar (positioned between "Advanced Techniques" and "Build Type Examples")

  • Category metadata: Added _category_.json for Docusaurus sidebar auto-generation

Notable Implementation Details

  • The task reference includes a Mermaid diagram visualizing the complete task dependency graph
  • Configuration reference is organized into logical sections (General, Build, Test, Help, Docs, Publish, Sign) with tables for easy lookup
  • Real-world example demonstrates combining PowerShellBuild's pre-built tasks with custom project-specific tasks
  • Getting started guide includes both psake and Invoke-Build approaches
  • All examples are production-ready and include GitHub Actions CI/CD workflow configuration

https://claude.ai/code/session_01TU1s3wRx7eGZhMJJXvY5Kz

Documents the proposed structure for adding PowerShellBuild coverage
to the psake docs site, including five new pages and sidebar changes.

https://claude.ai/code/session_01TU1s3wRx7eGZhMJJXvY5Kz
Creates five new pages under docs/powershellbuild/:
- introduction.md    — What PowerShellBuild is and how it relates to psake
- getting-started.md — Step-by-step setup guide with minimal psakeFile.ps1
- task-reference.md  — All tasks with dependency graph (Mermaid) and descriptions
- configuration.md   — Full $PSBPreference and dependency variable reference
- real-world-example.md — Complete project with CI/CD and PSGallery publishing

Also adds the PowerShellBuild category to guidesSidebar in sidebars.ts,
positioned between Advanced Techniques and Build Type Examples.

https://claude.ai/code/session_01TU1s3wRx7eGZhMJJXvY5Kz
@netlify
Copy link

netlify bot commented Feb 21, 2026

Deploy Preview for psake ready!

Name Link
🔨 Latest commit d0fa872
🔍 Latest deploy log https://app.netlify.com/projects/psake/deploys/699a4bf35f46b9000833089d
😎 Deploy Preview https://deploy-preview-42--psake.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Moves PowerShellBuild out of the Guides sidebar into a dedicated
powershellBuildSidebar so it appears as a peer of Get Started, Guides,
and Reference in the navbar. Also adds a footer link under Docs.

https://claude.ai/code/session_01TU1s3wRx7eGZhMJJXvY5Kz
…ngs.psd1

The default SettingsPath is not $null — PowerShellBuild automatically
looks for PSScriptAnalyzerSettings.psd1 in the project root. Updated
the configuration reference default value and description, the
real-world example to rely on the convention instead of an explicit
override, and the example filename from .psscriptanalyzer.psd1 to
PSScriptAnalyzerSettings.psd1.

https://claude.ai/code/session_01TU1s3wRx7eGZhMJJXvY5Kz
@HeyItsGilbert HeyItsGilbert merged commit 36b7e92 into main Feb 22, 2026
8 checks passed
@HeyItsGilbert HeyItsGilbert deleted the claude/plan-powershellbuild-docs-P99p5 branch February 22, 2026 00:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants