Skip to content

Migrate to Microsoft.PowerShell.PlatyPS and psake v5#55

Open
HeyItsGilbert wants to merge 4 commits intomainfrom
claude/migrate-platyps-v2-psake-v5
Open

Migrate to Microsoft.PowerShell.PlatyPS and psake v5#55
HeyItsGilbert wants to merge 4 commits intomainfrom
claude/migrate-platyps-v2-psake-v5

Conversation

@HeyItsGilbert
Copy link
Copy Markdown
Member

Summary

  • Replaces the dead Alt3.Docusaurus.Powershell + PlatyPS v0 pipeline with Microsoft.PowerShell.PlatyPS (v2 schema)
  • Adds scripts/New-PsakeDocusaurusHelp.ps1 — a custom transformer that converts PlatyPS v2 markdown (tables, new frontmatter) into the same Docusaurus MDX format the site already uses
  • Bumps psake to 5.0.3 and adopts v5 features: Version 5 declaration, declarative hashtable task syntax, Inputs/Outputs caching on Init, exec {} wrappers for external commands
  • Adds -Quiet flag to build.ps1 for structured PsakeBuildResult output — reduces token usage when running from Claude Code
  • Adds 8 new command reference MDX files for psake v5 commands (BuildSetup, BuildTearDown, Clear-PsakeCache, Execute, Get-PsakeBuildPlan, Test-BuildEnvironment, Test-PsakeTask, Version)

Test plan

  • Run .\build.ps1 -Bootstrap to install Microsoft.PowerShell.PlatyPS
  • Run .\build.ps1 -Quiet -Task GenerateCommandReference and inspect docs/commands/Assert.mdx — frontmatter, yaml param fences, .mdx cross-links, and escaped curly braces should all be present
  • Run .\build.ps1 -Quiet -Task Test — all 44 Pester tests pass
  • Run .\build.ps1 -Quiet -Task Build — Docusaurus build completes without broken-link errors

🤖 Generated with Claude Code

- Replace Alt3.Docusaurus.Powershell + PlatyPS v0 with Microsoft.PowerShell.PlatyPS
- Add scripts/New-PsakeDocusaurusHelp.ps1 to transform PlatyPS v2 markdown to Docusaurus MDX
- Bump psake to 5.0.3; convert main tasks to v5 declarative hashtable syntax
- Add -Quiet flag to build.ps1 for structured PsakeBuildResult output (reduces token usage)
- Add 8 new command reference MDX files for psake v5 commands

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@netlify
Copy link
Copy Markdown

netlify Bot commented Apr 24, 2026

Deploy Preview for psake failed.

Name Link
🔨 Latest commit 2d2ed9a
🔍 Latest deploy log https://app.netlify.com/projects/psake/deploys/69ebc8342cccd200082350bf

HeyItsGilbert and others added 3 commits April 24, 2026 12:07
The sidebar was generated by the old Alt3 module and only listed 12
commands. The 8 new v5 command MDX files are now included.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Add PowerShellBuild module to requirements.psd1
- Add $psbOptions/$psbVersion/$psbOutputFolder to Properties block
- Add GenerateCommandReferencePSB task set (Clean, Gen)
- Wire GenerateCommandReferencePSB into Build task DependsOn
- Add docs/psb-commands/ placeholder sidebar (empty until task runs)
- Import psbCommands in sidebars.ts with conditional category in powershellBuildSidebar

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Rename New-PsakeDocusaurusHelp.ps1 -> New-DocusaurusModuleHelp.ps1
- Rename function to New-DocusaurusModuleHelp (works for any PS module)
- Add CommandVersionMap parameter; injects :::note Since <module> X.Y::: admonition
- Add CommandVersionMap to $docusaurusOptions for the 8 psake v5-only commands
- Update both GenerateCommandReference-Gen and GenerateCommandReferencePSB-Gen to use new script/function
- Remove Exec.mdx (command was renamed to Execute in psake v5; no longer exported)
- Remove 'commands/Exec' from docusaurus.sidebar.js

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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.

1 participant