Skip to content

GitHub Actions cleanup: remove GitHub Pages deploy, add lychee link checker - #135

Open
AMD-melliott wants to merge 3 commits into
ROCm:developfrom
AMD-melliott:github-actions-cleanup
Open

AMD-melliott wants to merge 3 commits into
ROCm:developfrom
AMD-melliott:github-actions-cleanup

Conversation

@AMD-melliott

@AMD-melliott AMD-melliott commented Sep 10, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Removes .github/workflows/docs.yml ("Deploy Docs to GitHub Pages"), which was used during theme testing.
  • Adds .github/workflows/links.yml + lychee.toml, a lychee-based link checker that runs on push/PR to develop/main, weekly, and via manual dispatch. Scoped to docs/**/*.md, excludes docs/_build.
  • Fixes two dead links surfaced while validating the new checker

Why combined

Both changes touch .github/workflows/ and are being landed together as a general Actions cleanup rather than as separate PRs.

Notes for reviewers

  • lychee.toml excludes a few known-flaky patterns: LinkedIn/Reddit (block automated checkers), AMD's PDF CDN, account.amd.com (rejects lychee's HTTP/2 requests), and local .html nav targets used by the instinct-design card partials (e.g. system-admin/co-tools.html) can't be validated without a full docs build. That's a known coverage gap, not an oversight.

Related

Closes/supersedes the intent of #113 ("Add broken image link checker"), which targeted the old MyST image-tile card syntax removed by the recent instinct-design flavor migration (#133).

Test plan

  • lychee --config lychee.toml docs/**/*.md run locally, 0 errors
  • CI run on this PR (links + linting workflows both green)

Adapts the lychee config/workflow from ~/git/awesome-rocm, scoped to
docs/**/*.md and excluding docs/_build. Also excludes account.amd.com
(rejects lychee's HTTP/2 requests) and local .html nav targets used by
the instinct-design card partials, which only resolve post-Sphinx-build
and can't be validated against markdown source.

Fixes two stale links surfaced by the initial run: AMDResearch/omnistat
was renamed to ROCm/omnistat, and its GitHub Pages docs moved from
amdresearch.github.io/omnistat to rocm.github.io/omnistat.
docs/conf.py's DOCS_BASE_URL already defaults to instinct.docs.amd.com,
and production docs aren't served from GitHub Pages, so this workflow
is dead weight. No other GitHub Pages-specific config exists in the
repo (no CNAME, no gh-pages branch refs).
lychee-action@v2 pins lychee v0.24.2 by default, which changed
--include-fragments from a bool flag to a string enum
(none|anchor-only|text-only|full). `include_fragments = false` fails
to parse on that version ("wanted string or table"), even though it
parses fine on the older 0.23.0 CLI used to validate this locally.
@AMD-melliott AMD-melliott self-assigned this Sep 11, 2026
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