-
Notifications
You must be signed in to change notification settings - Fork 15
75 lines (64 loc) · 1.82 KB
/
Copy pathdocs.yml
File metadata and controls
75 lines (64 loc) · 1.82 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
name: docs
on:
push:
branches:
- main
paths:
- "docs/**"
- "package.json"
- ".github/workflows/docs.yml"
pull_request:
paths:
- "docs/**"
- "package.json"
- ".github/workflows/docs.yml"
workflow_dispatch:
permissions:
contents: read
concurrency:
group: docs-pages
cancel-in-progress: true
jobs:
build:
name: Build
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v7
- name: Set up Node.js
uses: actions/setup-node@v7
with:
node-version: "20"
- name: Configure Pages
uses: actions/configure-pages@v6
- name: Install docs dependencies
run: npm install --no-package-lock --ignore-scripts
- name: Build GitBook site
run: npx -y honkit@6.0.3 build docs docs/_book
env:
NODE_PATH: ${{ github.workspace }}/node_modules
- name: Ensure .nojekyll
run: touch docs/_book/.nojekyll
# Uploading the Pages artifact does not require the `github-pages`
# deployment environment — only the actual deploy step below does.
# Keeping this in the build job means PRs get a build/lint signal
# without needing environment approval or protected-branch access.
- name: Upload Pages artifact
uses: actions/upload-pages-artifact@v5
with:
path: docs/_book
deploy:
name: Deploy
if: github.ref == 'refs/heads/main' && (github.event_name == 'push' || github.event_name == 'workflow_dispatch')
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
permissions:
pages: write
id-token: write
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v5