#32723: Add a GitHub action to run the Sphinx linkcheck builder.
-------------------------------------+-------------------------------------
Reporter: Nick Pope | Owner: nobody
Type: | Status: new
Cleanup/optimization |
Component: | Version: dev
Documentation | Keywords: linkcheck, github,
Severity: Normal | action
Triage Stage: | Has patch: 0
Unreviewed |
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 1
UI/UX: 0 |
-------------------------------------+-------------------------------------
This is a follow on step from #32720. (Migrated to this new ticket as
[https://code.djangoproject.com/ticket/32720#comment:1 suggested] by
Mariusz.)
Add a scheduled GitHub action to check for broken links, or redirects that
could be simplified, on a weekly/monthly basis.
This would need to wait for [https://github.com/sphinx-
doc/sphinx/issues/6525 sphinx-doc/sphinx#6525] to be addressed so that we
can treat desired redirections as "working" links instead of "redirected",
e.g. `https://docs.djangoproject.com/en/stable/` →
`https://docs.djangoproject.com/en/3.2/`.
The linkcheck builder generates `docs/_build/linkcheck/output.{json,txt}`
which could be filtered and attached as an artifact from the GitHub action
to make it easier to provide a report on what needs fixing.
--
Ticket URL: <https://code.djangoproject.com/ticket/32723>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/050.bb935063cbc4ecdd5e6ea90f73709d10%40djangoproject.com.
