Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 8 additions & 16 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,8 @@ jobs:
if: startsWith(github.event.release.tag_name, 'data-designer-') && contains(github.event.release.tag_name, '/v')
runs-on: ubuntu-latest
permissions:
actions: write
contents: write
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- uses: actions/checkout@v4
with:
Expand Down Expand Up @@ -136,14 +132,10 @@ jobs:
gh release delete-asset "${ASSET_TAG}" packages.json -y || true
gh release upload "${ASSET_TAG}" release-metadata/packages.json

- uses: actions/configure-pages@v5

- name: Build documentation and static package index
run: make docs PACKAGE_LIST=release-metadata/packages.json

- uses: actions/upload-pages-artifact@v4
with:
path: site

- uses: actions/deploy-pages@v4
id: deployment
- name: Trigger Pages deployment
env:
GH_TOKEN: ${{ github.token }}
GITHUB_REPOSITORY: ${{ github.repository }}
run: |
gh workflow run docs.yml --ref main --repo "${GITHUB_REPOSITORY}"
echo "Triggered Documentation workflow on main to rebuild and deploy Pages."
7 changes: 5 additions & 2 deletions docs/releasing.md
Original file line number Diff line number Diff line change
Expand Up @@ -160,5 +160,8 @@ publish workflow. It verifies that:

If all checks pass, CI uploads the wheel and source distribution to the
`ddp-package-assets` GitHub Release, updates the mutable `packages.json`
metadata asset, rebuilds the `dumb-pypi` Simple API index, and deploys the
complete GitHub Pages site.
metadata asset, and dispatches the Documentation workflow on `main`. The
Documentation workflow is the only workflow that deploys GitHub Pages: it
downloads `ddp-package-assets/packages.json`, rebuilds the `dumb-pypi` Simple
API index, and deploys the complete Pages site with docs, catalog JSON, and the
package index in one pass.
5 changes: 3 additions & 2 deletions docs/workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,8 @@ Pull requests run the main CI workflow:
`make check-package-index` for package-list and static index generation

Documentation changes also run the documentation workflow. On pull requests the
workflow builds the site and uploads a preview artifact. On pushes to `main`, it
builds the same site and deploys `site/` to GitHub Pages. Every Pages deploy
workflow builds the site and uploads a preview artifact. On pushes to `main`, or
when a package release dispatches the workflow after updating package metadata,
it builds the same site and deploys `site/` to GitHub Pages. Every Pages deploy
includes documentation, `catalog/plugins.json`, and the static package index so
docs-only deploys do not remove installer-facing files.
Loading