Skip to content

chore: docs setup

chore: docs setup #22

Workflow file for this run

name: Ci
on:
push:
branches: main
pull_request:
branches: main
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
pr-checker:
name: 🔃 PR
runs-on: ubuntu-latest
if: github.actor != 'dependabot[bot]'
steps:
- uses: thehanimo/[email protected]
with:
pass_on_octokit_error: false
configuration_path: .github/pr-checker.json
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
verify:
name: ☑️ Verify
runs-on: ubuntu-latest
permissions:
contents: read
id-token: write
steps:
- name: ⬇️ Clone repository
uses: actions/checkout@v3
- name: 🟢 Install Deno
uses: denoland/setup-deno@v1
- name: 🟢 Install Bun
uses: oven-sh/setup-bun@v2
- name: 🟢 Install Node
uses: actions/setup-node@v4
with:
node-version: 20
- name: 🟢 Install Pnpm
uses: pnpm/action-setup@v4
with:
version: 9
- name: 🟢 Install Yarn
run: npm install -g yarn
- name: 🧹 Cleanup
run: deno run --allow-read --allow-write scripts/clean/docs.ts
- name: ⏳ Run Install
run: deno run --allow-read --allow-env --allow-run scripts/run/install.ts
- name: ☰ Run Linter
run: deno run --allow-read --allow-env --allow-run --allow-sys scripts/run/format.ts
- name: ✅ Run Check
run: deno run --allow-read --allow-env --allow-run --allow-sys scripts/run/check.ts
- name: ⚡ Run Linter
run: deno run --allow-read --allow-env --allow-run --allow-sys scripts/run/lint.ts
- name: 🧪 Run Test
run: deno run --allow-read --allow-env --allow-run scripts/run/test.ts
- name: 📜 Generate Docs
run: deno run --allow-read --allow-env --allow-run scripts/gen/doc.ts
build:
name: 🏗️ Build
runs-on: ubuntu-latest
steps:
- name: ✅ Checkout
uses: actions/checkout@v3
- name: 🗐 Setup Pages
uses: actions/configure-pages@v3
- name: 🟢 Install Deno
uses: denoland/setup-deno@v1
- name: 📝 Build Docs
run: deno task lume
working-directory: ./docs
- name: 📤 Upload artifact
uses: actions/upload-pages-artifact@v2
with:
path: ./docs/_site
# Deployment job
deploy:
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: 🚀 Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2