Skip to content

ci: validate docs package version against module manifest - #63

Merged
2chevskii merged 2 commits into
masterfrom
ci/validate-docs-package-version
Sep 30, 2026
Merged

2chevskii merged 2 commits into
masterfrom
ci/validate-docs-package-version

Conversation

@2chevskii

Copy link
Copy Markdown
Owner

Summary

Documentation builds could succeed with a package.json version that differs from the PowerShell module version. Validate package.json's version against ModuleVersion before building documentation in CI and the publishing workflow, and document the requirement to keep them in sync.

Validation

  • Pester tests
  • Documentation build, when documentation changed
  • Manual verification, when applicable

npm run docs:build passed. Executed the validation blocks from both workflows against the repository and isolated fixtures: matching versions pass; mismatched versions, a missing version, and invalid JSON fail. git diff --check passed. Actionlint passed with the existing unknown ubuntu-26.04 runner-label warning excluded. Pester was not run because module behavior is unchanged.

Checklist

  • The change is focused and does not include unrelated modifications.
  • Tests and documentation have been updated where needed.
  • I have read and agree to follow the Code of Conduct.

@2chevskii 2chevskii added github_actions GitHub Actions, CI, release, or deployment workflow area-documentation Documentation, examples, or website content labels Sep 30, 2026
@2chevskii 2chevskii self-assigned this Sep 30, 2026
@2chevskii
2chevskii merged commit 93efcf5 into master Sep 30, 2026
12 checks passed
@2chevskii
2chevskii deleted the ci/validate-docs-package-version branch September 30, 2026 20:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area-documentation Documentation, examples, or website content github_actions GitHub Actions, CI, release, or deployment workflow

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant