Repository navigation
ci(high/easy): validate deployment documentation on every PR - #581
Open
umpireboulianne-design wants to merge 1 commit into
Open
umpireboulianne-design wants to merge 1 commit into
umpireboulianne-design wants to merge 1 commit into
Conversation
Run check-deploy-docs.mjs alongside check-links.js and in CI, add docs:test script and CI wiring assertion in check-deploy-docs.test.mjs, and document in docs/CI.md. Fixes Sub-Rosa-Issue#523
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Runs
docs:check(scripts/check-deploy-docs.mjs) alongside the local Markdown link checker (scripts/check-links.js) and in the PR CI check suite sodocs/DEPLOY.mdenvironment variable andpnpmscript references are validated on every PR.Fixes #523
Closes #523
Changes
scripts/check-links.js: Invokescripts/check-deploy-docs.mjsafter local Markdown link verification succeeds (unless--links-onlyis passed).package.json: Add"docs:test": "node --test scripts/check-deploy-docs.test.mjs"and wirecheck-deploy-docs.test.mjsandcheck-deploy-docs.mjsinto the CI check suite.scripts/check-deploy-docs.test.mjs: Use cross-platformfileURLToPathpaths and add an automated test verifyingdocs:checkanddocs:testCI wiring.docs/CI.md: Document the deployment documentation check and local commands (pnpm docs:check,pnpm docs:test,pnpm docs:check-links).