Skip to content

Commit 0bba42e

Browse files
Setup CI
1 parent cddfff4 commit 0bba42e

2 files changed

Lines changed: 59 additions & 0 deletions

File tree

.github/workflows/build.yml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
on:
2+
pull_request:
3+
4+
permissions:
5+
contents: read
6+
7+
jobs:
8+
build-doc:
9+
name: Build documentation
10+
runs-on: ubuntu-24.04
11+
steps:
12+
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
13+
- name: Move to docs
14+
run: cd docs
15+
- uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0
16+
with:
17+
node-version: 21
18+
- name: Install dependencies
19+
run: cd docs && yarn install --frozen-lockfile
20+
- name: Build documentation website
21+
# Check URLs are valid, path to images, etc.
22+
run: cd docs && yarn build

.github/workflows/deploy.yml

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
on:
2+
push:
3+
branches:
4+
- main
5+
6+
permissions:
7+
contents: write
8+
9+
jobs:
10+
deploy:
11+
name: Deploy doc to GitHub Pages
12+
runs-on: ubuntu-24.04
13+
steps:
14+
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
15+
- uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0
16+
with:
17+
node-version: 21
18+
- name: Install dependencies
19+
run: cd docs && yarn install --frozen-lockfile
20+
- name: Build website
21+
run: cd docs && yarn build
22+
# Popular action to deploy to GitHub Pages:
23+
# Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
24+
- name: Deploy to GitHub Pages
25+
uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e # v4.0.0
26+
with:
27+
github_token: ${{ secrets.GITHUB_TOKEN }}
28+
# Build output to publish to the `gh-pages` branch:
29+
publish_dir: ./docs/build
30+
cname: nspanelmanager.com
31+
# The following lines assign commit authorship to the official
32+
# GH-Actions bot for deploys to `gh-pages` branch:
33+
# https://github.com/actions/checkout/issues/13#issuecomment-724415212
34+
# The GH actions bot is used by default if you didn't specify the two fields.
35+
# You can swap them out with your own user credentials.
36+
user_name: github-actions[bot]
37+
user_email: 41898282+github-actions[bot]@users.noreply.github.com

0 commit comments

Comments
 (0)