ci: add enforcing internal-link check across all collections (#262 G)#293
Merged
Merged
Conversation
Add a `rake test:links` task and a Link Check workflow that run html-proofer over every collection's `<name>/latest` build (a symlink to the current stable version, so each page is checked once and the check follows new versions automatically). Covers openvox, openvox-server, openvoxdb, openbolt, openfact, ecosystem, and openvox-containers. The workflow generates all reference docs into docs/ and builds the site first, matching the publish workflow, so the shared sidebar's links into the generated reference pages resolve. The nine OpenBolt generated reference pages 404 site-wide until an openbolt release > 5.5.0 ships the front-matter fix (issue OpenVoxProject#202): CI builds the newest openbolt release tag, which predates it, and those pages are linked from the shared sidebar on every page. They're ignored by basename until OpenVoxProject#202 ships in a release. Part of OpenVoxProject#262 (workstream G) Signed-off-by: Michael Harp <mike@mikeharp.com>
- openbolt glossary: `plan_functions` -> `plan_functions.html` so the link resolves (and matches the OpenVoxProject#202 ignore until the page renders). - ecosystem quickref: `/latest/config_file_environment.html` -> `/openvox/latest/config_file_environment.html`; the link was missing its collection prefix. These were the only non-OpenVoxProject#202 broken links left once the check covered all collections. Signed-off-by: Michael Harp <mike@mikeharp.com>
bastelfreak
reviewed
Jun 4, 2026
bastelfreak
reviewed
Jun 4, 2026
| @@ -0,0 +1,42 @@ | |||
| --- | |||
| name: Link Check | |||
Contributor
There was a problem hiding this comment.
Could you integrate the check into https://github.com/OpenVoxProject/openvox-docs/blob/master/.github/workflows/test.yml? That makes it easier for us to enforce the CI job (test.yml has our generic dummy check. It always runs and CI enforces it).
Contributor
Author
There was a problem hiding this comment.
yep, I debated that as well
Move the Internal links job from the standalone Link Check workflow into test.yml and add it to the alls-green `tests` gate, so it runs and is enforced alongside the existing rubocop/build checks. Remove the separate link-check.yml. Per review on OpenVoxProject#293: test.yml always runs and CI enforces its gate, so the link check belongs there rather than in its own workflow. Signed-off-by: Michael Harp <mike@mikeharp.com>
tuxmea
reviewed
Jun 4, 2026
tuxmea
approved these changes
Jun 4, 2026
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
3 participants
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.
What
Adds the regression gate for the broken-link effort (workstream G of #262): a
rake test:linkstask plus an Internal links CI job (intest.yml, wired into the enforcedtestsgate) that run html-proofer over every collection and fail CI on broken internal links.<name>/latestbuild — a symlink to the current stable version, so every page is checked once and the gate follows new versions automatically. Coversopenvox,openvox-server,openvoxdb,openbolt,openfact,ecosystem,openvox-containers.docs/and builds the site first (same as the publish workflow), so the shared sidebar's links into generated reference pages resolve.html-prooferto theGemfile.Plus two real link bugs the all-collections sweep surfaced (separate commit):
plan_functions→plan_functions.html/latest/config_file_environment.html→/openvox/latest/config_file_environment.html(missing collection prefix)Verification
Full CI-equivalent run locally (generate all references into
docs/→jekyll build→rake test:links):Rubocop clean.
Known temporary ignore (OpenBolt #202)
The nine OpenBolt generated reference pages (
bolt_*_reference,plan_functions,packaged_modules,privilege_escalation) 404 site-wide because CI builds the newest openbolt release tag (currently 5.5.0), which predates the front-matter fix that lets them render. They're linked from the shared sidebar on every page, so the task ignores them by basename until an openbolt release > 5.5.0 ships the fix (OpenVoxProject/openbolt#233 + #251, both merged to openboltmain). Remove the ignore inRakefileonce that release lands — tracked via #202.Closes #262