Skip to content

ci: check links with lychee, fix 27 broken Billomat doc links - #79

Merged
justpilot merged 1 commit into
4.xfrom
ci/docs-link-check
Oct 26, 2026
Merged

justpilot merged 1 commit into
4.xfrom
ci/docs-link-check

Conversation

@justpilot

Copy link
Copy Markdown
Owner

Last CI item before 4.0.0-beta.1.

Changes

  • Links workflow (.github/workflows/links.yml, config lychee.toml): lychee checks docs/**/*.md, the root Markdown files and the links in src/ docblocks and tools/codegen/definitions/. Runs on PRs touching them, on pushes to 4.x and weekly (Monday 06:00 UTC) for link rot. GITHUB_TOKEN avoids GitHub's rate limit; the result cache is kept between runs; 429 counts as reachable; example.com and mycompany.billomat.net placeholders are excluded.
  • 27 broken links fixed in docblocks and codegen definitions (generated files regenerated): Billomat retired the English pages (/en/api/confirmations/comments/ etc. → 410) and some paths were guessed (/api/abo-rechnungen/email-empfaenger/ → 404). They now point to the German pages listed in docs/spec/billomat.json; confirmation and delivery note sub-resources have no page of their own, so they link to the parent page.
  • The comment in canManageRecurringEmailReceiversInSandbox no longer claims receivers need action=EMAIL (seeding showed Billomat accepts them with CREATE).
  • docs/testing.md and AGENTS.md mention the workflow.

Test plan

  • lychee locally: 775 links, 0 errors
  • generate:check, PHPStan, lint, docs build

- New Links workflow: lychee checks docs/, the root Markdown files and the
  Billomat links in docblocks and codegen definitions, on PRs, on pushes to 4.x
  and weekly. Config in lychee.toml.
- 27 docblock links pointed to retired English pages (410) or guessed paths
  (404); they now use the German pages from docs/spec/billomat.json.
- The recurring email receiver test comment no longer claims Billomat needs
  action=EMAIL for receivers.
@justpilot
justpilot merged commit b96efc3 into 4.x Oct 26, 2026
9 of 10 checks passed
@justpilot
justpilot deleted the ci/docs-link-check branch October 26, 2026 16:18
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