Skip to content

Commit 20483d3

Browse files
authored
docs action (#2660) (#2661)
1 parent 7fbf2a1 commit 20483d3

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

.github/workflows/docs.yml

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# This is a basic workflow to help you get started with Actions
2+
3+
name: Docs
4+
5+
# Controls when the workflow will run
6+
on:
7+
# Triggers the workflow on push or pull request events but only for the main branch
8+
push:
9+
branches: [ master ]
10+
11+
# Allows you to run this workflow manually from the Actions tab
12+
workflow_dispatch:
13+
14+
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
15+
jobs:
16+
# This workflow contains a single job called "build"
17+
build:
18+
# The type of runner that the job will run on
19+
runs-on: ubuntu-latest
20+
21+
# Steps represent a sequence of tasks that will be executed as part of the job
22+
steps:
23+
- name: Perform Checkout
24+
uses: actions/checkout@v2
25+
- name: Setup Node
26+
uses: actions/setup-node@v2
27+
with:
28+
node-version: '16'
29+
- name: Npm install
30+
run: npm ci
31+
- name: Build docs
32+
run: npm run docs
33+
- name: Deploy Docs
34+
uses: peaceiris/actions-gh-pages@v3
35+
with:
36+
github_token: ${{ secrets.GITHUB_TOKEN }}
37+
publish_dir: ./docs
38+
keep_files: true

0 commit comments

Comments
 (0)