feat: migrate generate pipeline to markdown model and OpenAI HTTP stack (#5)

Author: tsurumi-yizhou

.clice/cache/clore/extract/cache.json

@@ -1,15 +1,14 @@
-name: generate-docs
+name: Generate Docs
 
 on:
   push:
     branches: ["main"]
-  workflow_dispatch:
 
 jobs:
   generate:
-    runs-on: windows-latest
+    runs-on: macos-latest
     permissions:
-      contents: write
+      contents: read
 
     steps:
       - name: Checkout clore
@@ -21,67 +20,53 @@ jobs:
           pixi-version: v0.67.0
           activate-environment: true
           cache: true
-          locked: true
 
-      - name: Restore compiler cache
-        uses: actions/cache@v5
+      - name: Restore build cache
+        id: restore-build-cache
+        uses: actions/cache/restore@v4
         with:
-          path: .cache/sccache
-          key: Windows-sccache-${{ github.sha }}
+          path: build/Debug/
+          key: ${{ runner.os }}-debug-build-${{ hashFiles('pixi.lock', 'pixi.toml', '**/CMakeLists.txt', 'cmake/**/*.cmake') }}
           restore-keys: |
-            Windows-sccache-
-
-      - name: Restore configure artifacts cache
-        id: restore-configure-cache
-        uses: actions/cache/restore@v5
-        with:
-          path: |
-            build/RelWithDebInfo/.llvm
-            build/RelWithDebInfo/include
-            build/RelWithDebInfo/_deps
-            build/RelWithDebInfo/*.tar.*
-          key: >-
-            Windows-configure-RelWithDebInfo-${{
-            hashFiles('pixi.lock', 'pixi.toml', '**/CMakeLists.txt', 'cmake/**/*.cmake')
-            }}-${{ github.sha }}
-          restore-keys: |
-            Windows-configure-RelWithDebInfo-${{ hashFiles('pixi.lock', 'pixi.toml', '**/CMakeLists.txt', 'cmake/**/*.cmake') }}-
-
-      - name: Start sccache
-        run: sccache --start-server
+            ${{ runner.os }}-debug-build-
 
       - name: Configure
-        run: pixi run cmake-config
-
-      - name: Save configure artifacts cache
-        if: success()
-        uses: actions/cache/save@v5
-        with:
-          path: |
-            build/RelWithDebInfo/.llvm
-            build/RelWithDebInfo/include
-            build/RelWithDebInfo/_deps
-            build/RelWithDebInfo/*.tar.*
-          key: ${{ steps.restore-configure-cache.outputs.cache-primary-key }}
+        run: pixi run cmake-config Debug
 
       - name: Build
-        run: pixi run cmake-build
+        run: pixi run cmake-build Debug
+
+      - name: Save build cache
+        if: ${{ success() && steps.restore-build-cache.outputs.cache-hit != 'true' }}
+        uses: actions/cache/save@v4
+        with:
+          path: build/Debug/
+          key: ${{ steps.restore-build-cache.outputs.cache-primary-key }}
 
       - name: Generate documentation
+        timeout-minutes: 10
+        env:
+          OPENAI_BASE_URL: ${{ secrets.OPENAI_BASE_URL }}
+          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
         run: |
-          ./build/RelWithDebInfo/bin/clore `
-            --compile-commands build/RelWithDebInfo/compile_commands.json `
-            --source-dir src `
-            --output-dir generated `
-            --log-level info `
-            --dry-run
+          if [[ -z "${OPENAI_API_KEY}" || -z "${OPENAI_BASE_URL}" ]]; then
+            echo "OPENAI_API_KEY and OPENAI_BASE_URL must be set to generate documentation." >&2
+            exit 1
+          fi
+
+          ./build/Debug/bin/clore \
+            --compile-commands build/Debug/compile_commands.json \
+            --source-dir src \
+            --output-dir generated \
+            --log-level info \
+            --model deepseek-chat
 
       - name: Package documentation
-        run: Compress-Archive -Path generated/* -DestinationPath clore-docs.zip
+        run: tar -czvf clore-docs.tar.gz generated
 
       - name: Upload documentation artifact
         uses: actions/upload-artifact@v7
         with:
           name: clore-docs
-          path: clore-docs.zip
+          path: clore-docs.tar.gz
           retention-days: 30

.github/workflows/generate-docs.yml

@@ -0,0 +1,45 @@
+name: Build
+
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        os: ["windows-latest", "ubuntu-latest", "macos-latest"]
+    runs-on: "${{ matrix.os }}"
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - name: Setup pixi
+        uses: prefix-dev/setup-pixi@v0.9.4
+        with:
+          pixi-version: v0.67.0
+          activate-environment: true
+          cache: true
+
+      - name: Restore build directory cache
+        id: restore-build-cache
+        uses: actions/cache/restore@v5
+        with:
+          path: build/Debug/
+          key: ${{ runner.os }}-debug-build-${{ hashFiles('pixi.lock', 'pixi.toml', '**/CMakeLists.txt', 'cmake/**/*.cmake') }}
+          restore-keys: |
+            ${{ runner.os }}-debug-build-
+
+      - name: Configure
+        run: pixi run cmake-config Debug
+
+      - name: Save build directory cache
+        if: steps.restore-build-cache.outputs.cache-hit != 'true'
+        uses: actions/cache/save@v5
+        with:
+          path: build/Debug/
+          key: ${{ steps.restore-build-cache.outputs.cache-primary-key }}
+
+      - name: Build
+        run: pixi run cmake-build Debug

.github/workflows/verify-build.yml

@@ -0,0 +1,23 @@
+# .prettierrc.yaml
+
+printWidth: 100
+tabWidth: 4
+useTabs: false
+semi: true
+singleQuote: false
+jsxSingleQuote: false
+quoteProps: "as-needed"
+trailingComma: "all"
+bracketSpacing: true
+arrowParens: "always"
+endOfLine: "lf"
+
+overrides:
+  - files: "**/*.md"
+    options:
+      proseWrap: "preserve"
+      tabWidth: 2
+
+  - files: ["**/*.json", "**/*.yaml", "**/*.yml", ".clang-format", ".clang-tidy"]
+    options:
+      tabWidth: 2

.prettierrc.yaml

@@ -17,6 +17,14 @@ option(CLORE_ENABLE_LTO "Enable ThinLTO for all targets" ON)
 option(CLORE_OFFLINE_BUILD "Disable network downloads during configuration" OFF)
 option(CLORE_ENABLE_TEST "Build unit tests" ON)
 
+if(WIN32 AND (MSVC OR (CMAKE_CXX_COMPILER_ID MATCHES "Clang" AND
+                      (CMAKE_CXX_COMPILER_FRONTEND_VARIANT STREQUAL "MSVC" OR
+                       CMAKE_CXX_COMPILER_LINKER_FRONTEND_VARIANT STREQUAL "MSVC"))))
+    set(CMAKE_MSVC_RUNTIME_LIBRARY "MultiThreadedDLL" CACHE STRING
+        "Use the release CRT to stay ABI-compatible with the bundled Windows LLVM artifacts."
+        FORCE)
+endif()
+
 # Global flags that apply to all targets (including FetchContent dependencies).
 if(NOT MSVC)
     add_compile_options(-ffunction-sections -fdata-sections)