update the build cache logic for cache friendly build (#36)

* chore: update the build cache logic for cache friendly build, for a pr safety build check

* chore: update the build cache logic for cache friendly build, for a pr safety build check

* update: add references at vairant staff

* update: add reference for types

Author: Charliechen114514

.github/workflows/build-check.yml

@@ -31,8 +31,10 @@ jobs:
         uses: actions/cache@v4
         with:
           path: site/.vitepress/.build-cache
-          key: vitepress-build-${{ hashFiles('documents/**') }}
-          restore-keys: vitepress-build-
+          key: vitepress-build-${{ runner.os }}-${{ hashFiles('documents/**', 'site/.vitepress/config/**', 'site/.vitepress/plugins/**', 'site/.vitepress/public/**', 'site/.vitepress/theme/**', 'scripts/build.ts', 'package.json', 'pnpm-lock.yaml') }}
+          restore-keys: |
+            vitepress-build-${{ runner.os }}-
+            vitepress-build-
 
       - name: Build
         run: pnpm build

.github/workflows/deploy.yml

@@ -36,8 +36,10 @@ jobs:
         uses: actions/cache@v4
         with:
           path: site/.vitepress/.build-cache
-          key: vitepress-build-${{ hashFiles('documents/**') }}
-          restore-keys: vitepress-build-
+          key: vitepress-build-${{ runner.os }}-${{ hashFiles('documents/**', 'site/.vitepress/config/**', 'site/.vitepress/plugins/**', 'site/.vitepress/public/**', 'site/.vitepress/theme/**', 'scripts/build.ts', 'package.json', 'pnpm-lock.yaml') }}
+          restore-keys: |
+            vitepress-build-${{ runner.os }}-
+            vitepress-build-
 
       - name: Build
         run: pnpm build

documents/vol2-modern-features/ch04-type-safety/03-variant.md

@@ -437,6 +437,9 @@ std::cout << "sizeof(string): " << sizeof(std::string) << "\n";
 // 典型输出：32
 ```
 
+> 这里稍作补充，int 的大小如何，可以在这个[网址](https://en.cppreference.com/cpp/language/types)上阅读，简单的说，int 被规定为至少16 bits，也就是2字节大小，其他平台一律4字节。当然这个事情别当八股文背诵。
+> 可以参考 [YukunJ](https://github.com/YukunJ) 老师提供的[案例](https://godbolt.org/z/sbvEMW56G)
+
 这个大小对于大多数应用来说完全可接受。但在内存极端受限的嵌入式场景中，你可能需要评估一下是否值得用 `variant` 替代手写的 `union` + `enum` 标签方案。`variant` 带来的类型安全收益通常远大于几个字节的内存开销。
 
 ## 小结

scripts/build.ts

@@ -94,7 +94,7 @@ function countMdFiles(dir: string): number {
   return count
 }
 
-/** Compute a fast hash of a directory's file mtimes + sizes for change detection */
+/** Compute a stable content hash for change detection across fresh checkouts. */
 function hashDir(dir: string): string {
   const h = createHash('sha256')
   function walk(d: string) {
@@ -104,15 +104,36 @@ function hashDir(dir: string): string {
         if (e.name.startsWith('.')) continue
         const full = join(d, e.name)
         if (e.isDirectory()) { walk(full); continue }
-        const s = statSync(full)
-        h.update(`${relative(dir, full)}:${s.size}:${s.mtimeMs}\n`)
+        h.update(`file:${relative(dir, full)}\n`)
+        h.update(readFileSync(full))
+        h.update('\n')
       }
     } catch { /* ignore */ }
   }
   walk(dir)
   return h.digest('hex').substring(0, 16)
 }
 
+function hashFile(path: string): string {
+  const h = createHash('sha256')
+  if (!existsSync(path)) return ''
+  h.update(readFileSync(path))
+  return h.digest('hex').substring(0, 16)
+}
+
+function hashBuildInputs(): string {
+  const h = createHash('sha256')
+  for (const [label, value] of [
+    ['site', hashDir(MAIN_VP)],
+    ['package', hashFile(join(PROJECT_ROOT, 'package.json'))],
+    ['lockfile', hashFile(join(PROJECT_ROOT, 'pnpm-lock.yaml'))],
+    ['build-script', hashFile(join(PROJECT_ROOT, 'scripts', 'build.ts'))],
+  ]) {
+    h.update(`${label}:${value}\n`)
+  }
+  return h.digest('hex').substring(0, 16)
+}
+
 // ── Manifest (incremental build state) ──────────────────────
 
 interface ManifestEntry { hash: string; timestamp: string }
@@ -232,10 +253,11 @@ interface SearchIndexSource {
   lang: 'zh' | 'en' | 'mixed'
 }
 
-function prepareVolume(vol: Volume, lang: 'zh' | 'en', manifest: Manifest): BuildTask {
+function prepareVolume(vol: Volume, lang: 'zh' | 'en', manifest: Manifest, buildInputsHash: string): BuildTask {
   const volDocDir = lang === 'en' ? join(DOCUMENTS, 'en', vol.srcDir) : join(DOCUMENTS, vol.srcDir)
   const id = lang === 'en' ? `${vol.name}-en` : vol.name
-  const cacheKey = existsSync(volDocDir) ? hashDir(volDocDir) : ''
+  const docHash = existsSync(volDocDir) ? hashDir(volDocDir) : ''
+  const cacheKey = `${buildInputsHash}-${docHash}`
   const prev = manifest[id]
   const cached = !FORCE_REBUILD && prev && prev.hash === cacheKey && existsSync(join(CACHE_DIR, 'output', id))
   return { id, vol, lang, cacheKey, cached }
@@ -585,6 +607,7 @@ async function main() {
   mkdirSync(join(BUILD_TMP, 'output'), { recursive: true })
 
   const manifest = readManifest()
+  const buildInputsHash = hashBuildInputs()
 
   // ── Step 1: Build root ──────────────────────────────────
   logStep('Step 1/4: Building root site (index, tags)')
@@ -629,7 +652,7 @@ async function main() {
     for (const lang of ['zh', 'en'] as const) {
       const volDocDir = lang === 'en' ? join(DOCUMENTS, 'en', vol.srcDir) : join(DOCUMENTS, vol.srcDir)
       if (!existsSync(volDocDir)) continue
-      tasks.push(prepareVolume(vol, lang, manifest))
+      tasks.push(prepareVolume(vol, lang, manifest, buildInputsHash))
     }
   }