Skip to content

fix(docs): harden GitHub Pages deployment - #103

Merged
wangjk9527 merged 1 commit into
datagallery-lab:mainfrom
iancaoo:codex/fix-pages-deploy
Aug 6, 2026
Merged

fix(docs): harden GitHub Pages deployment#103
wangjk9527 merged 1 commit into
datagallery-lab:mainfrom
iancaoo:codex/fix-pages-deploy

Conversation

@iancaoo

@iancaoo iancaoo commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

Summary

  • exclude the README-only tui-demo.mp4 from the MkDocs Pages artifact while keeping it in the repository
  • extend the actions/deploy-pages polling timeout from 10 to 20 minutes

Root cause

The docs build and artifact upload both succeed. Starting with 5e9bcff, GitHub Pages remains deployment_in_progress until actions/deploy-pages reaches its default 10-minute timeout. The site artifact changed by only about 18 KB in that commit, while an identical-size artifact had already slowed from seconds to 4m37s, indicating Pages backend processing degradation rather than invalid DataLink docs.

The artifact was approximately 67.6 MB because MkDocs copied a 31 MB MP4 used only by the repository README. Excluding that duplicate payload reduces the generated site to about 40 MB and the longer timeout tolerates transient Pages processing delays.

Verification

  • uv run --with-requirements requirements-docs.txt mkdocs build --strict
  • node scripts/smoke-doc-links.mjs
  • confirmed site/assets/readme/tui-demo.mp4 is absent and the repository source asset remains available

Closes #104

@wangjk9527
wangjk9527 self-requested a review August 6, 2026 14:34

@wangjk9527 wangjk9527 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@wangjk9527
wangjk9527 merged commit 08afa7b into datagallery-lab:main Aug 6, 2026
4 checks passed
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.

GitHub Pages deployment times out after docs artifact upload

2 participants