bitcal/.github/workflows/docs-pages.yml at master · LessUp/bitcal · 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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
name: Docs (GitHub Pages)

on:
  push:
    branches:
      - master
    paths:
      - "docs/**"
      - "README.md"
      - "README.zh-CN.md"
      - ".github/workflows/docs-pages.yml"
  pull_request:
    paths:
      - "docs/**"
      - "README.md"
      - "README.zh-CN.md"
      - ".github/workflows/docs-pages.yml"

permissions:
  contents: read
  pages: write
  id-token: write

jobs:
  verify:
    if: github.event_name == 'pull_request'
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Set up Node.js
        uses: actions/setup-node@v4
        with:
          node-version: "20"

      - name: Cache docs node_modules
        uses: actions/cache@v4
        with:
          path: docs/node_modules
          key: ${{ runner.os }}-docs-node-modules-${{ hashFiles('docs/package.json') }}
          restore-keys: |
            ${{ runner.os }}-docs-node-modules-

      - name: Install docs dependencies
        working-directory: docs
        run: npm install --no-package-lock

      - name: Check docs IA
        working-directory: docs
        run: npm run check:ia

      - name: Check docs theme contract
        working-directory: docs
        run: npm run check:theme-contract

      - name: Check docs content contract
        working-directory: docs
        run: npm run check:content-contract

      - name: Build docs
        working-directory: docs
        run: npm run build

  deploy:
    if: github.event_name == 'push' && github.repository == 'LessUp/bitcal'
    runs-on: ubuntu-latest
    environment:
      name: github-pages
      url: ${{ steps.deploy.outputs.page_url }}
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Set up Node.js
        uses: actions/setup-node@v4
        with:
          node-version: "20"

      - name: Cache docs node_modules
        uses: actions/cache@v4
        with:
          path: docs/node_modules
          key: ${{ runner.os }}-docs-node-modules-${{ hashFiles('docs/package.json') }}
          restore-keys: |
            ${{ runner.os }}-docs-node-modules-

      - name: Configure GitHub Pages
        id: pages
        uses: actions/configure-pages@v5

      - name: Set VitePress base
        shell: bash
        env:
          BASE_PATH: ${{ steps.pages.outputs.base_path }}
        run: |
          set -euo pipefail
          if [[ -z "${BASE_PATH}" ]]; then
            base="/"
          else
            base="${BASE_PATH%/}/"
          fi
          echo "VITEPRESS_BASE=${base}" >> "$GITHUB_ENV"

      - name: Install docs dependencies
        working-directory: docs
        run: npm install --no-package-lock

      - name: Check docs IA
        working-directory: docs
        run: npm run check:ia

      - name: Check docs theme contract
        working-directory: docs
        run: npm run check:theme-contract

      - name: Check docs content contract
        working-directory: docs
        run: npm run check:content-contract

      - name: Build docs
        working-directory: docs
        env:
          VITEPRESS_BASE: ${{ env.VITEPRESS_BASE }}
        run: npm run build

      - name: Add .nojekyll
        run: touch docs/.vitepress/dist/.nojekyll

      - name: Upload Pages artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: docs/.vitepress/dist

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