Skip to content

feat(ci): add lychee broken link test#14231

Draft
skjnldsv wants to merge 9 commits intomasterfrom
feat/ci-lychee
Draft

feat(ci): add lychee broken link test#14231
skjnldsv wants to merge 9 commits intomasterfrom
feat/ci-lychee

Conversation

@skjnldsv
Copy link
Copy Markdown
Member

@skjnldsv skjnldsv commented Apr 3, 2026

Summary

Restructures the documentation build and deployment workflow with improved caching, link validation, and automation.

Changes

Deployment Automation

  • ✨ Adds GitHub Pages deployment via pull request with auto-merge (enables review/audit trail)
  • Updates generate-top-index.yml for index page deployments

Performance Improvements

  • 🚀 Extracts LaTeX caching to dedicated setup-latex-cache job (runs once, shared by all builds)
  • Refactors build matrix to restore from shared cache instead of per-job installation
  • ⚡ Adds workflow concurrency with auto-cancellation for in-progress runs

Quality Assurance

  • 🔍 Adds stage-and-check job with Lychee broken link validation
  • Validates all generated documentation links via offline scanning
  • Fails workflow if broken links detected

Commits

  1. fix(ci): deploy pages via pull request with auto-merge - Deployment process upgrade
  2. perf(ci): improve LaTeX caching with dedicated setup job - Caching layer optimization
  3. feat(ci): add lychee broken link checker and stage-and-check job - Link validation
  4. perf(ci): add build concurrency and auto-cancel in-progress builds - Concurrency control

Benefits

  • Faster builds (shared LaTeX cache, fewer duplicate runs)
  • Safer deployments (auditable via PRs, broken links caught early)
  • Better reliability (prevents broken documentation from being deployed)

@skjnldsv skjnldsv self-assigned this Apr 3, 2026
@skjnldsv skjnldsv added enhancement 2. developing github_actions Pull requests that update GitHub Actions code labels Apr 3, 2026
@skjnldsv skjnldsv force-pushed the feat/ci-lychee branch 26 times, most recently from d2d4a70 to 0b645ad Compare April 7, 2026 17:05
@skjnldsv skjnldsv force-pushed the feat/ci-lychee branch 15 times, most recently from 639ad2e to 033e934 Compare April 9, 2026 09:29
skjnldsv added 6 commits April 9, 2026 11:39
Signed-off-by: skjnldsv <skjnldsv@protonmail.com>
Signed-off-by: skjnldsv <skjnldsv@protonmail.com>
Signed-off-by: skjnldsv <skjnldsv@protonmail.com>
Signed-off-by: skjnldsv <skjnldsv@protonmail.com>
Signed-off-by: skjnldsv <skjnldsv@protonmail.com>
Signed-off-by: skjnldsv <skjnldsv@protonmail.com>
@skjnldsv skjnldsv force-pushed the feat/ci-lychee branch 3 times, most recently from 53e5c39 to ec23d82 Compare April 9, 2026 10:07
skjnldsv added 2 commits April 9, 2026 12:18
Signed-off-by: skjnldsv <skjnldsv@protonmail.com>
- Replace 49 absolute https://docs.nextcloud.com/server/latest/ URLs with relative paths
- Improves documentation portability and offline validation
- Updates 36 RST files across user_manual, admin_manual, and developer_manual
- Maintains .html→.rst conversion and anchor links
- Preserves special URLs (OpenAPI, go.php, version 20)
…oy jobs

- Standardize cache staging directory from 'deploy-staging/' to 'stage/'
- Ensures cache save and restore paths match
- Fixes 'fail-on-cache-miss: true' cache miss error
- Updates all references in organize, cache, and validation steps

Signed-off-by: skjnldsv <skjnldsv@protonmail.com>
@skjnldsv skjnldsv marked this pull request as draft April 10, 2026 06:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

2. developing enhancement github_actions Pull requests that update GitHub Actions code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant