ZimaOS-Blue/.github/workflows/docs.yml at main · IceWhaleTech/ZimaOS-Blue · 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
name: Docs

on:
  push:
    branches: [main]
    paths:
      - 'docs/**'
      - '.github/workflows/docs.yml'
  pull_request:
    branches: [main]
    paths:
      - 'docs/**'
      - '.github/workflows/docs.yml'
  workflow_dispatch:

env:
  NODE_VERSION: "20"

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

concurrency:
  group: docs-pages
  cancel-in-progress: true

jobs:
  build:
    name: Build docs
    runs-on: ubuntu-latest
    outputs:
      skip: ${{ steps.resolve.outputs.skip }}
    steps:
      - uses: actions/checkout@v4
        with:
          submodules: recursive

      - name: Resolve docs configuration
        id: resolve
        shell: bash
        run: |
          set -euo pipefail

          site_dir="docs"
          config_path=""
          for candidate in \
            "$site_dir/docusaurus.config.ts" \
            "$site_dir/docusaurus.config.mts" \
            "$site_dir/docusaurus.config.cts" \
            "$site_dir/docusaurus.config.js" \
            "$site_dir/docusaurus.config.mjs" \
            "$site_dir/docusaurus.config.cjs"
          do
            if [ -f "$candidate" ]; then
              config_path="$candidate"
              break
            fi
          done

          if [ -z "$config_path" ]; then
            echo "skip=true" >> "$GITHUB_OUTPUT"
            {
              echo "skip_reason=No Docusaurus config file found under docs/. Add docs/docusaurus.config.* before enabling the docs workflow."
            } >> "$GITHUB_OUTPUT"
            {
              echo "## Docs"
              echo
              echo "Skipped: No Docusaurus config file found under docs/."
            } >> "$GITHUB_STEP_SUMMARY"
          else
            echo "skip=false" >> "$GITHUB_OUTPUT"
            echo "site_dir=$site_dir" >> "$GITHUB_OUTPUT"
            echo "config_path=$config_path" >> "$GITHUB_OUTPUT"
          fi

      - uses: actions/configure-pages@v5
        if: steps.resolve.outputs.skip != 'true'

      - uses: actions/setup-node@v4
        if: steps.resolve.outputs.skip != 'true'
        with:
          node-version: ${{ env.NODE_VERSION }}
          cache: npm
          cache-dependency-path: docs/package-lock.json

      - name: Install & build docs
        if: steps.resolve.outputs.skip != 'true'
        working-directory: ${{ steps.resolve.outputs.site_dir }}
        run: |
          npm ci
          npm run build

      - name: Upload Pages artifact
        if: github.event_name != 'pull_request' && steps.resolve.outputs.skip != 'true'
        uses: actions/upload-pages-artifact@v5
        with:
          path: docs/build

  deploy:
    name: Deploy docs
    if: github.event_name != 'pull_request' && needs.build.outputs.skip != 'true'
    needs: build
    runs-on: ubuntu-latest
    permissions:
      pages: write
      id-token: write
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4