-
-
Notifications
You must be signed in to change notification settings - Fork 97
Open
Description
Set up the GitHub Actions workflow to build the library, copy the bundle, build the Astro site, and deploy to AstroDraw/astrodraw.github.io via deploy key.
Deliverable
A fully functional CI/CD pipeline that deploys the docs site to https://astrodraw.github.io/ on every push to main.
Acceptance Criteria
-
One-time setup completed (§8 in docs-plan.md):
- SSH key pair generated (
docs_deploy_keyanddocs_deploy_key.pub) - Public key added as Deploy Key in AstroDraw/astrodraw.github.io repo (with write access)
- Private key added as
DOCS_DEPLOY_KEYActions secret in AstroDraw/AstroChart repo - Local key files deleted
- SSH key pair generated (
-
.github/workflows/docs-deploy.ymlcreated with:- Trigger: push to main, paths:
website/**andproject/src/** - Allow manual trigger via
workflow_dispatch - Single job:
build-and-deploy - Steps: checkout → Node 20 → build library → copy bundle → build Astro → deploy via peaceiris/actions-gh-pages
- Trigger: push to main, paths:
-
Workflow YAML is syntactically valid (no validation errors)
-
Manual test:
- Run workflow manually via GitHub Actions UI
- Verify build logs show:
- "Build library" succeeds
- "Copy bundle" succeeds
- "Build Astro site" succeeds
- "Deploy to astrodraw.github.io" shows git push output
-
Deployment verification:
- Visit https://astrodraw.github.io/ in browser
- Verify homepage loads (title, hero, demo chart visible)
- Verify navigation sidebar visible and clickable
- Check browser console: no 404s for /astrochart.js
-
Documentation:
- Update CONTRIBUTING.md (or create docs-deploy.md guide) explaining:
- What the workflow does
- How to manually trigger
- How to debug deploy failures
- Update CONTRIBUTING.md (or create docs-deploy.md guide) explaining:
Related Plan Section
docs-plan.md §8 (GitHub Pages Deployment), §9 (CI/CD Pipeline)
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels