Skip to content

Update generated docs to 6.1.0 - #441

Merged
nohwnd merged 2 commits into
mainfrom
nohwnd-regen-6.1.0
Aug 11, 2026
Merged

Update generated docs to 6.1.0#441
nohwnd merged 2 commits into
mainfrom
nohwnd-regen-6.1.0

Conversation

@nohwnd

@nohwnd nohwnd commented Aug 11, 2026

Copy link
Copy Markdown
Member

Regenerated the command reference and the configuration table against Pester 6.1.0, the follow-up to #440 that we kept separate until the release was out.

  • Adds the New-ShouldAssertion page. That also clears the two broken links Document 6.1.0 features and drop removed Run.BeforeContainer #440 knowingly left behind, yarn build now reports none.
  • Command reference picks up -NormalizeLineEnding on Should-BeString and Should-NotBeString, and the Should-Throw wildcard hint.
  • Configuration table gains Run.Shuffle, Run.ShuffleSeed, Output.ShowTags and Mock.Global, and drops the removed Run.BeforeContainer row.

Two things worth knowing:

The generator needs a pinned Alt3 version. Alt3.Docusaurus.PowerShell 2.0.0 is out, and generate-command-reference.ps1 asks for the latest stable, so it installs 2.0.0 and then dies on a YamlDotNet assembly conflict with PlatyPS. Worse, it deletes the existing MDX files before it fails, so the failure is not a no-op. I generated with -DocusaurusVersion 1.0.37. Until #418 lands it is probably worth defaulting the script to the 1.0.x line rather than latest.

Run.Parallel still describes a stale fallback. Its description says it falls back to sequential "when CodeCoverage is enabled", which stopped being true in pester/Pester#2860. The text comes from RunConfiguration.cs in the Pester repo, so it cannot be fixed here, it needs a fix there and then another regen. I left the generated output faithful to the module.

Verified with yarn build.

🤖

nohwnd added 2 commits August 11, 2026 20:39
Regenerated the command reference and the configuration table against Pester
6.1.0.

Adds the New-ShouldAssertion page, which also clears the two broken links that
#440 left behind. Picks up -NormalizeLineEnding on Should-BeString and
Should-NotBeString, the Should-Throw wildcard hint, and in the configuration
table Run.Shuffle, Run.ShuffleSeed, Output.ShowTags and Mock.Global. Drops the
removed Run.BeforeContainer row.

Generated with -DocusaurusVersion 1.0.37. Alt3.Docusaurus.PowerShell 2.0.0 is
out now, and the unpinned script picks it up and then fails on a YamlDotNet
assembly conflict with PlatyPS, so it needs pinning until #418 lands.

🤖
The v5 command reference and configuration section were still generated from
5.8.0. 5.9.1 changed no help text, so this is only the version stamp, but it
keeps the versioned docs honest about which release they describe.

🤖
@nohwnd
nohwnd merged commit 855030e into main Aug 11, 2026
4 checks passed
@nohwnd
nohwnd deleted the nohwnd-regen-6.1.0 branch August 11, 2026 18:56
nohwnd added a commit to fflaten/docs that referenced this pull request Aug 11, 2026
Most conflicts were generated command pages. Main regenerated them for 6.1.0
in pester#441 with the old generator while this branch has them from the v2
generator at the same version, so resolved by keeping this branch and
dropping the old-generator output.

Two real resolutions:

- versioned_docs/version-v5/usage/configuration.mdx, that section is
  generated separately and was still on 5.9.0 here, took 5.9.1 from main.
- versioned_sidebars/version-v4-sidebars.json, main restructured the whole
  v4 sidebar while this branch only changed one id in the old structure.
  Kept main structure and re-applied the id, commands/Add-ShouldOperator,
  to match the docId the v2 generator writes for Add-AssertionOperator.
  Without it the build fails with "Invalid sidebar file".

Verified: yarn build passes.

🤖
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