Skip to content

Add test CI: internal link check and markdownlint - #13

Merged
miharp merged 1 commit into
OpenVoxProject:mainfrom
miharp:ci/internal-link-check
Aug 12, 2026
Merged

Add test CI: internal link check and markdownlint#13
miharp merged 1 commit into
OpenVoxProject:mainfrom
miharp:ci/internal-link-check

Conversation

@miharp

@miharp miharp commented Aug 12, 2026

Copy link
Copy Markdown
Contributor

Adds a test.yml workflow with two PR-triggered jobs, mirroring the openvox-docs CI approach:

Internal links — builds the site (npm run buildjekyll build) and runs html-proofer over _site with --checks Links,Images,Scripts. External links are deliberately excluded: sites like Slack 403 non-browser clients, which makes external checks flaky in CI (the whole site's external links were verified manually instead). The Images/Scripts checks double as a guard on the Vite manifest lookup — a stale or broken hashed asset path fails CI instead of shipping.

Markdown lint — markdownlint-cli2 over git-tracked Markdown files only (so _site/node_modules can't leak in), using the openvox-docs ruleset copied in as .markdownlint.yaml for cross-repo consistency.

Supporting changes: html-proofer ~> 5.0 added to the Gemfile's development group with lockfile update.

Verified locally: both checks pass green against the current site, and both were confirmed to catch injected breakage (a bad internal link, and lint violations during authoring).

Written with AI assistance (Claude Code); reviewed and verified by me.

Mirrors the openvox-docs approach. A new test workflow runs two jobs
on PRs: html-proofer over the built _site (internal links, images,
and scripts only -- external checks are flaky because sites like
Slack 403 non-browser clients), and markdownlint-cli2 over tracked
Markdown files using the openvox-docs ruleset.

The Images/Scripts checks also verify hashed Vite asset paths, so a
stale manifest fails CI instead of shipping broken pages.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Signed-off-by: Michael Harp <mike@mikeharp.com>
@miharp
miharp merged commit 34a5f87 into OpenVoxProject:main Aug 12, 2026
4 checks passed
@miharp
miharp deleted the ci/internal-link-check branch August 12, 2026 13:10
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.

2 participants