A manual run of the link check checks nothing

Open Beginner friendly
#130 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
1-3 hours
Newbie friendliness
85/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Active
Tech stack
github-actions
Domain
ci-cd

Research direction

The fix lives in the detect job of .github/workflows/link-check.yml, where the git diff <sha>~1 <sha> check decides whether lychee runs. Add a branch that sets docs_changed=true when github.event_name is workflow_dispatch, following test.yml's detect job. Done when the grep in the issue shows the manual case, and a hand-triggered run executes lychee.

Written by the indexing model from the issue text.

Description

type:tech-debt
Description of Technical Debt

Outside a pull request, the detect job of .github/workflows/link-check.yml compares the last commit only
(git diff <sha>~1 <sha>). So a manual (workflow_dispatch) run on a commit that changed no .md file skips lychee
and still passes: links that rotted since the last Markdown change cannot be re-checked by hand. living-doc-toolkit
and living-doc-generator-markdown fixed their copy: a manual run sets docs_changed=true, the way test.yml's
detect treats a manual run.

Impact of Technical Debt
  • Rotted links cannot be re-checked on demand; a green manual run means nothing.
Category

DevOps / Infrastructure

Priority

Low - Nice to have

Proposed Solution

In detect, set docs_changed=true when github.event_name is workflow_dispatch, as living-doc-toolkit's link-check.yml does; run it once by hand to show lychee ran.

Effort Estimate

1 hour

Dependencies / Related

No response

Additional Context

Measured 2026-11-12 at living-doc 2df73dc. Re-check:

grep -n 'workflow_dispatch\|docs_changed=true' .github/workflows/link-check.yml — fixed when the manual event sets docs_changed=true.

Dominant language
Python
Stars
0
Forks
0
Avg merge
6h 14m
Merged PRs (30d)
27

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from AbsaOSS/living-doc

All issues in AbsaOSS/living-doc

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.