ghostbird/.github/workflows/doc.yml at main · exteditor/ghostbird · 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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
name: Documentation

on:
  push:
    branches:
      - main
    paths:
      - 'README.md'
      - 'doc/**/*'
      - '.github/site/**/*'
      - '.github/workflows/doc.yml'
jobs:
  build-doc:
    runs-on: ubuntu-latest
    permissions:
      contents: write
      pages: write
      id-token: write

    steps:
      - uses: actions/checkout@v5

      - name: Setup Node.js
        uses: actions/setup-node@v5
        with:
          node-version: 22
          cache: npm

      - name: Enable corepack
        run: corepack enable

      - name: Install Yarn
        run: corepack install

      - name: Get Yarn cache folder
        id: yarn-cache-dir
        run: echo "cache-dir=$(corepack yarn config get cacheFolder)" >> $GITHUB_OUTPUT

      - name: Restore Yarn cache
        uses: actions/cache@v4
        with:
          path: ${{ steps.yarn-cache-dir.outputs.cache-dir }}
          key: yarn-${{ runner.os }}-${{ hashFiles('yarn.lock') }}

      - name: Install dependencies
        run: corepack yarn install --immutable

      - name: Generate docs
        run: corepack yarn run doc

      - name: Configure pages
        uses: actions/configure-pages@v4

      - name: Add typedoc to site
        run: mv build/doc/ .github/site/typedoc/

      - name: Add markdown files to site
        run: mv *.md doc/ ext/ .github/site/

      - name: Upload pages artifact
        uses: actions/upload-pages-artifact@v4
        with:
          path: .github/site/

      - name: Deploy pages
        uses: actions/deploy-pages@v4