Repository navigation
ci: strengthen documentation validation pipeline - #184
Conversation
✅ Deploy Preview for thoth-tech ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Rhinoatron
left a comment
There was a problem hiding this comment.
Amazing work. The CI changes look focused and useful. Updating the GitHub Actions versions, switching to npm ci, adding npm caching, and keeping the existing Linelint, Prettier, and Vale checks all make sense. Adding npm run build is also a good improvement because it validates the actual Astro/MDX documentation build and can catch issues that formatting or prose checks would miss. I also checked for overlap with other PRs and did not find another current PR making this same CI/build-validation change. Approved.
ralphweng2023
left a comment
There was a problem hiding this comment.
Approved, the new npm ci and build steps pass in CI.
Planner card: unable to identify the ticket for this PR.
Summary
This PR strengthens the existing CI pipeline for the ThothTech Documentation Website by modernising GitHub Actions and adding automated production-build validation.
Changes
actions/checkoutfrom v2 to v4.actions/setup-nodefrom v1 to v4.npm installwithnpm cifor reproducible CI installations.npm run buildto validate Astro/MDX compilation and internal links.Motivation
The existing CI pipeline validates formatting and prose quality but does not run the Astro production build.
This means documentation changes could potentially pass CI while still containing build errors, invalid MDX, or broken internal links.
Adding the production build provides an additional automated quality gate for documentation contributions, including the SplashKit documentation workflow.
Testing
npm cicompleted successfully.npm run format:checkpassed.npm run buildcompleted successfully.