Skip to content

Fix docs package index deployment#38

Merged
eric-tramel merged 1 commit into
mainfrom
codex/fix-docs-package-list-download
May 8, 2026
Merged

Fix docs package index deployment#38
eric-tramel merged 1 commit into
mainfrom
codex/fix-docs-package-list-download

Conversation

@eric-tramel
Copy link
Copy Markdown
Contributor

What

Update the Documentation workflow so deploy builds can reliably include the released package index metadata.

Why

The data-designer-retrieval-sdg v0.1.0 release successfully published wheel and sdist assets, but the main docs deployment rebuilt Pages with an empty package list. That left the public Simple index empty even though the release artifact bucket had packages.json.

How

  • Download ddp-package-assets/packages.json by resolving the release asset through the GitHub API instead of relying on the lossy gh release download fallback.
  • Log the package-list byte count so empty deploys are visible in CI logs.
  • Allow workflow_dispatch runs on main to configure, upload, and deploy Pages, which gives maintainers a safe manual recovery path after package asset changes.

Validation

  • Parsed .github/workflows/docs.yml with PyYAML.
  • Verified the new gh api asset download returns the 338-byte released packages.json.
  • Ran make docs PACKAGE_LIST= locally and confirmed site/simple/data-designer-retrieval-sdg/index.html and pypi JSON files are generated.

@eric-tramel eric-tramel requested a review from a team as a code owner May 8, 2026 18:30
@eric-tramel eric-tramel merged commit 05b845f into main May 8, 2026
6 checks passed
@eric-tramel eric-tramel deleted the codex/fix-docs-package-list-download branch May 8, 2026 18:31
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.

2 participants