name: Deploy Documentation to GitHub Pages
on:
push:
branches: [ main, master ]
paths:
- 'docs/**'
- 'README.md'
- 'CHANGELOG.md'
- 'RELEASE*.md'
- '.github/workflows/deploy-docs.yml'
pull_request:
branches: [ main, master ]
paths:
- 'docs/**'
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Bun
uses: oven-sh/setup-bun@v1
with:
bun-version: latest
- name: Install dependencies
working-directory: ./docs
run: bun install --frozen-lockfile
- name: Build documentation
working-directory: ./docs
run: bun run build
- name: Setup Pages
uses: actions/configure-pages@v4
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./docs/build
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4