Skip to content

Add htmlproofer CI workflow (advisory)#120

Draft
miharp wants to merge 3 commits intoOpenVoxProject:masterfrom
miharp:feat/htmlproofer
Draft

Add htmlproofer CI workflow (advisory)#120
miharp wants to merge 3 commits intoOpenVoxProject:masterfrom
miharp:feat/htmlproofer

Conversation

@miharp
Copy link
Copy Markdown
Contributor

@miharp miharp commented Apr 29, 2026

Summary

Adds htmlproofer to the CI pipeline to catch broken internal links on every PR and push to master.

Currently runs in advisory mode (continue-on-error: true) due to significant inherited link debt from the Puppet docs migration. Will be made enforced once the outstanding issues are resolved.

What it checks

  • Internal links only (--disable-external) — avoids flakiness from third-party sites going down
  • Ignores legacy URL prefixes (/puppet/, /pe/, /puppetlabs/) that appear in inherited content
  • Runs against the full built _site/ directory

Known outstanding failures (advisory until fixed)

Category Count Tracked in
.markdown ref-style link definitions ~122 #118 / #119
.html links to deleted/missing pages ~783 follow-up
.md extension links ~38 follow-up

Roadmap to enforcement

  1. Merge Fix broken reference-style link definitions using .markdown extension #119 (ref-style link definitions) — drops ~1000 failures
  2. Fix remaining .markdown and .md edge cases
  3. Address broken .html links (deleted man pages, missing hiera pages)
  4. Flip continue-on-error to false

miharp and others added 3 commits April 29, 2026 08:22
Runs htmlproofer against the built site on every PR and push to master.
Currently advisory (continue-on-error: true) due to existing link debt
in inherited content. Will be made enforced once broken links are resolved.

Checks internal links only (--disable-external) to avoid flakiness from
third-party sites. Ignores known legacy URL prefixes (/puppet/, /pe/,
/puppetlabs/).

Signed-off-by: Michael Harp <mike@mikeharp.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…flow

Signed-off-by: Michael Harp <mike@mikeharp.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Using || true instead of continue-on-error at job level so the check
appears green in the PR UI while still reporting failures in the logs.

Signed-off-by: Michael Harp <mike@mikeharp.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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.

1 participant