Skip to content
This repository was archived by the owner on Dec 19, 2025. It is now read-only.

Commit faf06a7

Browse files
authored
Create docs.yml
1 parent d81ac1a commit faf06a7

1 file changed

Lines changed: 59 additions & 0 deletions

File tree

.github/workflows/docs.yml

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
name: Docs
2+
3+
on:
4+
push:
5+
branches: [ "main" ]
6+
paths:
7+
- "docs/**"
8+
workflow_dispatch:
9+
10+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
11+
permissions:
12+
contents: read
13+
pages: write
14+
id-token: write
15+
16+
# Allow one concurrent deployment
17+
concurrency:
18+
group: "pages"
19+
cancel-in-progress: true
20+
21+
jobs:
22+
deploy:
23+
name: Deploy to GitHub Pages
24+
runs-on: ubuntu-latest
25+
environment:
26+
name: github-pages
27+
url: ${{ steps.deployment.outputs.page_url }}
28+
steps:
29+
- uses: actions/checkout@v2
30+
- uses: actions/setup-node@v3
31+
with:
32+
node-version: 18
33+
- name: Get npm cache directory
34+
id: npm-cache-dir
35+
run: |
36+
echo "::set-output name=dir::$(npm config get cache)"
37+
- uses: actions/cache@v3
38+
id: npm-cache
39+
with:
40+
path: ${{ steps.npm-cache-dir.outputs.dir }}
41+
key: ${{ runner.os }}-node-${{ hashFiles('**/docs/package-lock.json') }}
42+
restore-keys: |
43+
${{ runner.os }}-node-
44+
- name: Install dependencies
45+
run: npm ci
46+
if: steps.npm-cache.outputs.cache-hit != 'true'
47+
working-directory: docs
48+
- name: Build website
49+
run: npm run build
50+
working-directory: docs
51+
- name: Setup Pages
52+
uses: actions/configure-pages@v2
53+
- name: Upload artifact
54+
uses: actions/upload-pages-artifact@v1
55+
with:
56+
path: './docs/build'
57+
- name: Deploy to GitHub Pages
58+
id: deployment
59+
uses: actions/deploy-pages@v1

0 commit comments

Comments
 (0)