Skip to content

chore: update dependencies and enhance documentation #14

chore: update dependencies and enhance documentation

chore: update dependencies and enhance documentation #14

Workflow file for this run

name: Docs
on:
pull_request:
paths:
- 'docs/**'
- '.github/workflows/docs.yml'
- 'package/**'
- 'README.md'
push:
branches:
- main
paths:
- 'docs/**'
- '.github/workflows/docs.yml'
- 'package/**'
- 'README.md'
tags:
- '*'
jobs:
build:
name: Build docs
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Bun
uses: oven-sh/setup-bun@v2
with:
bun-version: latest
- name: Install dependencies
run: bun install
- name: Build docs
run: bun run docs:build
- name: Upload build artifact
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
uses: actions/upload-artifact@v4
with:
name: docs-build
path: docs/build
deploy:
name: Deploy docs to gh-pages
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
needs: build
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- name: Download build artifact
uses: actions/download-artifact@v4
with:
name: docs-build
path: docs/build
- name: Deploy docs to gh-pages
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_branch: gh-pages
publish_dir: docs/build