superutils/.github/workflows/docs.yml at main · alien45/superutils · GitHub

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
# .github/workflows/docs.yml

name: 'Docs: Build and Deploy'

on:
    # Trigger the workflow on pushes to the main branch
    push:
        branches:
            - main

# Allow this job to clone the repo and create a page deployment
permissions:
    contents: read
    pages: write
    id-token: write

jobs:
    build-and-deploy:
        runs-on: ubuntu-latest
        steps:
            - name: 'Checkout 🛎️'
              uses: actions/checkout@v4

            - name: 'Setup Node.js ⚙️'
              uses: actions/setup-node@v4
              with:
                  node-version: '24' # using LTS (even numbered) version
                  cache: 'npm'

            - name: 'Install Dependencies 📦'
              run: npm install

            - name: 'Build all packages 🚀'
              # This script uses lerna (using nx & tsup) to build all packages
              run: npm run build

            - name: 'Build VitePress Site 🚀'
              # This script runs 'typedoc' and then 'vitepress build'
              run: npm run docs:build

            - name: 'Upload artifact 📦'
              uses: actions/upload-pages-artifact@v3
              with:
                  # This is the default output directory for VitePress
                  path: docs/.vitepress/dist

            - name: 'Deploy to GitHub Pages 🚀'
              id: deployment
              uses: actions/deploy-pages@v4