Skip to content

chore: update readme #124

chore: update readme

chore: update readme #124

Workflow file for this run

---
# yaml-language-server: $schema=https://json.schemastore.org/github-workflow.json
name: "Docs"
on:
workflow_dispatch:
push:
branches: ["main"]
paths:
- .github/workflows/publish-docs.yaml
- docs/**
- README.md
permissions:
actions: write
contents: read
id-token: write
pages: write
jobs:
build:
name: Build Docs
runs-on: ubuntu-latest
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
steps:
- name: Generate Token
uses: actions/create-github-app-token@v1
id: app-token
with:
app-id: "${{ secrets.BOT_APP_ID }}"
private-key: "${{ secrets.BOT_APP_PRIVATE_KEY }}"
- name: Checkout
uses: actions/checkout@v4
with:
token: "${{ steps.app-token.outputs.token }}"
- name: Setup Pages
id: pages
uses: actions/configure-pages@v5
with:
token: "${{ steps.app-token.outputs.token }}"
enablement: true
- name: Build docs
uses: docker://ghcr.io/bjw-s/mdbook:0.4.37@sha256:329c0c1cd83e9daaa877c8bec09a77a06bc78685c99d9ccff832a19e99349766
with:
args: mdbook build docs
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./docs/book
publish:
name: Publish Docs
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Generate Token
uses: actions/create-github-app-token@v1
id: app-token
with:
app-id: "${{ secrets.BOT_APP_ID }}"
private-key: "${{ secrets.BOT_APP_PRIVATE_KEY }}"
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
with:
token: "${{ steps.app-token.outputs.token }}"