Repository navigation
feat(workflows): step 10, add reusable lint-docs dead-link check - #52
seantronsen wants to merge 2 commits into
Conversation
Signed-off-by: Sean Tronsen <sean.tronsen@gmail.com>
|
You are seeing this message because GitHub Code Scanning has recently been set up for this repository, or this pull request contains the workflow file for the Code Scanning tool. What Enabling Code Scanning Means:
For more information about GitHub Code Scanning, check out the documentation. |
synackd
left a comment
There was a problem hiding this comment.
This looks cool. Just one finding on concurrent jobs.
| concurrency: | ||
| group: lint-docs-issue-${{ github.repository }} | ||
| cancel-in-progress: false |
There was a problem hiding this comment.
The concurrency group prevents two report-issue jobs from editing the issue at the same time, but it does not ensure they run in commit order. If an older default-branch link scan finishes after a newer one, it can overwrite or close the issue using stale findings.
Could the reporter check that GITHUB_SHA still matches the current default-branch HEAD before updating the issue? A stale run could then exit without changing the latest issue state.
Description
Adds
lint-docs, a reusable dead-link check ported from OpenCHAMI/fabrica#48. It runs lychee vialycheeverse/lychee-actionover every.md,.html, and.rstfile, and reports broken links instead of failing:github-advanced-securityreview comments with "Dismiss alert", likelint-ci's zizmor findings. They clear once a later commit fixes the link. Fork PRs only get the job summary.lychee.tomland.lycheeignore. The only input isissue-title.0-local-ciruns it against this repo's docs.docs/workflows.md#lint-docs, plus the README index.Stacked on #51. Closes #49.
Testbed: OpenCHAMI/github-actions-testbed#15.
Checklist
make test(or equivalent) locally and all tests passgit commit -s) with my real name and email<filename>.licensesidecarLICENSES/directoryType of Change