Fix the GitHub Pages deployment (docs + dashboard) - #11
Merged
Conversation
docgen-action's build script invokes `~/.elan/bin/lake`, which did not exist because elan was installed after the docs build — install it first. Also temporarily add `fix-pages-deploy` to the push trigger so the combined GitHub Pages site can be deployed and tested from this branch before merging (to be removed before merge).
docgen-action@v1 uploads the `github-pages` artifact on every push regardless of its `deploy` input, so a second `upload-pages-artifact` collided (409). Instead of deploying separately, build the dashboard first, drop it into docgen's `docs/` output directory, and let docgen perform the one upload + deploy of everything (landing page at /, API docs at /docs, dashboard at /dashboard).
The `v1` tag of docgen-action has no `deploy`/`build-page` inputs and uploads + deploys unconditionally (and runs Jekyll whenever a `docs/` folder exists, which failed with no Gemfile). Pin to a newer docgen revision that honours `deploy: false` + `build-page: false`, so docgen only *builds* the API docs; we then assemble the combined site (landing /, docs /docs, dashboard /dashboard) and do the single upload + deploy ourselves.
Drop the `fix-pages-deploy` branch from the push trigger now that the combined docs + dashboard deployment is validated; the `github-pages` environment branch policy for it has been removed too.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes the GitHub Pages deployment added in #10, which failed on
master.Two bugs
lake: No such file or directory—pages.ymlinstalled elan after the docs step, but docgen-action's build script invokes~/.elan/bin/lakedirectly. Install elan first.409 Conflicton thegithub-pagesartifact — docgen-action@v1 runsupload-pages-artifacton every push regardless of itsdeployinput (only itsdeploy-pagesstep honours the flag). So the workflow's ownupload-pages-artifactwas a secondgithub-pagesartifact and collided.Fix
Since GitHub Pages allows only one deployment per repo and docgen-action insists on uploading its
docs/directory, let docgen own the single upload + deploy instead of deploying separately. The workflow now:docs/dashboard) and adds a landingdocs/index.html,docgen-action(build-page: false), which builds the API docs intodocs/docsand uploads + deploys the wholedocs/tree.Resulting site: landing page at
/, API docs at/docs, dashboard at/dashboard.(docgen's
build_docs.shonly doesmkdir -p docs+cp … docs/docs, norm, so the pre-placed dashboard survives.)Before merging
This branch is set up so the site can be deployed and tested from it. Remove the temporary bits before/after merge:
fix-pages-deployfrom thepush:trigger inpages.yml;fix-pages-deploybranch from thegithub-pagesenvironment's deployment-branch policies.🤖 Generated with Claude Code