Skip to content

ci: strengthen documentation validation pipeline - #184

Open
jankiluitel wants to merge 1 commit into
thoth-tech:mainfrom
jankiluitel:feature/splashkit-docs-validation
Open

ci: strengthen documentation validation pipeline#184
jankiluitel wants to merge 1 commit into
thoth-tech:mainfrom
jankiluitel:feature/splashkit-docs-validation

Conversation

@jankiluitel

Copy link
Copy Markdown
Collaborator

Summary

This PR strengthens the existing CI pipeline for the ThothTech Documentation Website by modernising GitHub Actions and adding automated production-build validation.

Changes

  • Upgraded actions/checkout from v2 to v4.
  • Upgraded actions/setup-node from v1 to v4.
  • Added npm dependency caching.
  • Replaced npm install with npm ci for reproducible CI installations.
  • Preserved the existing Linelint, Prettier, and Vale checks.
  • Added npm run build to 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 ci completed successfully.
  • npm run format:check passed.
  • npm run build completed successfully.
  • Temporarily introduced an invalid internal link in a SplashKit Usage Examples page to verify the new validation.
  • Confirmed that the build correctly failed and identified the invalid link.
  • Removed the temporary test change and confirmed the build passed again.
  • Confirmed no documentation content changes are included in this PR.

@netlify

netlify Bot commented Aug 29, 2026

Copy link
Copy Markdown

Deploy Preview for thoth-tech ready!

Name Link
🔨 Latest commit f1abc0b
🔍 Latest deploy log https://app.netlify.com/projects/thoth-tech/deploys/6a927fd134f1b0000828c90c
😎 Deploy Preview https://deploy-preview-184--thoth-tech.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@SteveDala SteveDala left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@Rhinoatron Rhinoatron left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

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.

3 participants