Context
Parent epic: #24
Depends on: #25 (VitePress initialized)
Workflow: .github/workflows/docs.yml
Triggers
on:
push:
branches: [main]
paths:
- "docs/**"
- ".github/workflows/docs.yml"
workflow_dispatch:
Job: build
- uses: oven-sh/setup-bun@v2
with:
bun-version: latest
- run: bun install --frozen-lockfile
- run: bun run docs:build
- uses: actions/upload-pages-artifact@v3
with:
path: docs/.vitepress/dist
Job: deploy (depends on build)
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- uses: actions/deploy-pages@v4
id: deployment
Tasks
Acceptance criteria
Context
Parent epic: #24
Depends on: #25 (VitePress initialized)
Workflow:
.github/workflows/docs.ymlTriggers
Job:
buildJob:
deploy(depends onbuild)Tasks
.github/workflows/docs.ymlwith the above structuremainhttps://fulll.github.io/github-code-search/docsbadge to the slim README (docs: Slim down README.md (keep install + link to docs) #32)Acceptance criteria
docs/**auto-triggers a deploymenthttps://fulll.github.io/github-code-search/oven-sh/setup-bun— no third-party deploy serviceworkflow_dispatch