Skip to content

Commit bf6fe98

Browse files
committed
chore: add GitHub workflows and README assets
- Add GitHub Pages deployment workflow for documentation - Add CI workflow for testing and building - Add logo and demo assets referenced in README
1 parent 539c330 commit bf6fe98

File tree

4 files changed

+116
-0
lines changed

4 files changed

+116
-0
lines changed

.github/assets/demo.gif

940 KB
Loading

.github/assets/logo.png

18.7 KB
Loading

.github/workflows/deploy-docs.yml

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
name: Deploy Documentation
2+
3+
on:
4+
push:
5+
branches: [main]
6+
paths:
7+
- "docs/**"
8+
- ".github/workflows/deploy-docs.yml"
9+
workflow_dispatch:
10+
11+
# Allow only one concurrent deployment
12+
concurrency:
13+
group: "pages"
14+
cancel-in-progress: false
15+
16+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
17+
permissions:
18+
contents: read
19+
pages: write
20+
id-token: write
21+
22+
jobs:
23+
build:
24+
runs-on: ubuntu-latest
25+
steps:
26+
- name: Checkout 🛎️
27+
uses: actions/checkout@v5
28+
- name: Setup pnpm 🔧
29+
uses: pnpm/action-setup@v4
30+
- name: Setup Node.js 🔧
31+
uses: actions/setup-node@v6
32+
with:
33+
node-version: "lts/*"
34+
check-latest: true
35+
cache: "pnpm"
36+
- name: Install dependencies 🪄
37+
run: |
38+
cd docs
39+
pnpm install --frozen-lockfile
40+
- name: Build documentation 💎
41+
run: |
42+
cd docs
43+
pnpm run build
44+
- name: Setup Pages 📄
45+
uses: actions/configure-pages@v5
46+
- name: Upload artifact 🚀
47+
uses: actions/upload-pages-artifact@v3
48+
with:
49+
path: ./docs/dist
50+
51+
deploy:
52+
needs: build
53+
runs-on: ubuntu-latest
54+
environment:
55+
name: github-pages
56+
url: ${{ steps.deployment.outputs.page_url }}
57+
steps:
58+
- name: Deploy to GitHub Pages
59+
id: deployment
60+
uses: actions/deploy-pages@v4

.github/workflows/main.yaml

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
name: Test & Build Package
2+
3+
on:
4+
push:
5+
branches: [master, main]
6+
pull_request:
7+
branches: [master, main]
8+
workflow_dispatch:
9+
10+
jobs:
11+
test:
12+
runs-on: ubuntu-latest
13+
strategy:
14+
matrix:
15+
node: ["lts/*"]
16+
name: Test on node@v${{ matrix.node }}
17+
steps:
18+
- name: Checkout 🛎️
19+
uses: actions/checkout@v5
20+
- name: Setup pnpm 🔧
21+
uses: pnpm/action-setup@v4
22+
- name: Setup node 🔧
23+
uses: actions/setup-node@v6
24+
with:
25+
node-version: ${{ matrix.node }}
26+
check-latest: true
27+
cache: "pnpm"
28+
- name: Install 🪄
29+
run: pnpm install --frozen-lockfile
30+
- name: Lint 🔍
31+
run: pnpm run lint
32+
- name: TypeScript 🔍
33+
run: pnpm run check
34+
- name: Jest 🔍
35+
run: pnpm run spec
36+
build:
37+
runs-on: ubuntu-latest
38+
strategy:
39+
matrix:
40+
node: ["lts/*"]
41+
name: Build on node@v${{ matrix.node }}
42+
steps:
43+
- name: Checkout 🛎️
44+
uses: actions/checkout@v5
45+
- name: Setup pnpm 🔧
46+
uses: pnpm/action-setup@v4
47+
- name: Setup node 🔧
48+
uses: actions/setup-node@v6
49+
with:
50+
node-version: ${{ matrix.node }}
51+
check-latest: true
52+
cache: "pnpm"
53+
- name: Install 🪄
54+
run: pnpm install --frozen-lockfile
55+
- name: Build 💎
56+
run: pnpm run build

0 commit comments

Comments
 (0)