Merge pull request #426 from flashcatcloud/feat/ai-sre

Feat/ai sre

Author: ysyneu

.github/workflows/upload.yml

@@ -12,11 +12,14 @@
 #   MEILI_ENDPOINT  - Meilisearch instance URL
 #   MEILI_API_KEY   - API key with documents read/write permission
 #   MEILI_INDEX     - Target index name
-# Repository secrets for the tarball: CDN_ACCESS_KEY, CDN_SECRET_KEY,
-# CDN_BUCKET, CDN_REGION, CDN_ENDPOINT.
+# Branch mapping for the Meilisearch sync: main -> production,
+# test -> development.
 #
-# Branch mapping: main -> production (https://docs-cdn.flashcat.cloud/docs/),
-# test -> development (https://docs-cdn.flashcat.cloud/test/docs/)
+# The tarball is published from main only, to the Flashduty static
+# distribution: https://static.flashcat.cloud/flashduty-docs/flashduty-docs.tar.gz
+# (OSS bucket flashduty-public). Every deployment reads that one copy.
+# Repository secrets for it: STATIC_ACCESS_KEY, STATIC_SECRET_KEY (an AK allowed
+# to put objects under flashduty-public/flashduty-docs/).
 
 name: Publish docs for AI search
 
@@ -74,12 +77,12 @@ jobs:
           bash ./scripts/upload.sh
 
   bundle:
+    if: github.ref == 'refs/heads/main'
     runs-on: ubuntu-latest
-    environment: ${{ github.event.inputs.environment || (github.ref == 'refs/heads/main' && 'production' || 'development') }}
     # Every run uploads the whole tarball, so a newer run supersedes an older
     # one; cancelling the older keeps it from finishing last with stale docs.
     concurrency:
-      group: docs-bundle-${{ github.event.inputs.environment || (github.ref == 'refs/heads/main' && 'production' || 'development') }}
+      group: docs-bundle
       cancel-in-progress: true
     steps:
       - name: Checkout
@@ -101,11 +104,11 @@ jobs:
       - name: Build and upload docs bundle
         working-directory: integration-docs
         env:
-          CDN_ACCESS_KEY: ${{ secrets.CDN_ACCESS_KEY }}
-          CDN_SECRET_KEY: ${{ secrets.CDN_SECRET_KEY }}
-          CDN_BUCKET: ${{ secrets.CDN_BUCKET }}
-          CDN_REGION: ${{ secrets.CDN_REGION }}
-          CDN_ENDPOINT: ${{ secrets.CDN_ENDPOINT }}
-          CDN_URL: 'https://docs-cdn.flashcat.cloud'
-          CDN_DIR: ${{ (github.event.inputs.environment || (github.ref == 'refs/heads/main' && 'production' || 'development')) == 'production' && '/docs' || '/test/docs' }}
+          CDN_ACCESS_KEY: ${{ secrets.STATIC_ACCESS_KEY }}
+          CDN_SECRET_KEY: ${{ secrets.STATIC_SECRET_KEY }}
+          CDN_BUCKET: 'flashduty-public'
+          CDN_REGION: 'oss-cn-beijing'
+          CDN_ENDPOINT: 'oss-cn-beijing.aliyuncs.com'
+          CDN_URL: 'https://static.flashcat.cloud'
+          CDN_DIR: '/flashduty-docs'
         run: npm run upload:docs-bundle

integration-docs/scripts/oss-cdn.mjs

@@ -1,6 +1,7 @@
-// Shared OSS upload + CDN refresh helpers for the docs-cdn publishing scripts
+// Shared OSS upload + CDN refresh helpers for the publishing scripts
 // (upload-openapi.mjs, upload-docs-bundle.mjs). All of them read the same
-// CDN_* secrets and publish under CDN_URL + CDN_DIR.
+// CDN_* env vars, publish under CDN_URL + CDN_DIR and refresh the CDN copy of
+// what they upload.
 
 export const requiredEnv = [
   'CDN_ACCESS_KEY',

integration-docs/scripts/upload-docs-bundle.mjs

@@ -25,6 +25,8 @@ export function buildOssFilePath(cdnDir) {
 // ~3 MB tarball has taken 5.5 minutes to reach OSS (~9 KB/s).
 const TAR_UPLOAD_TIMEOUT_MS = 30 * 60 * 1000;
 
+// The static CDN caches by its own path TTL, not this Cache-Control, so
+// uploadDocsBundle refreshes the tarball URL after every upload.
 function buildTarUploadOptions() {
   return {
     timeout: TAR_UPLOAD_TIMEOUT_MS,

integration-docs/scripts/upload-docs-bundle.test.mjs

@@ -43,19 +43,19 @@ test('uploadDocsBundle uploads the tarball with gzip headers and refreshes the C
   const env = {
     CDN_ACCESS_KEY: 'access-key',
     CDN_SECRET_KEY: 'secret-key',
-    CDN_BUCKET: 'bucket',
-    CDN_REGION: 'oss-cn-hangzhou',
-    CDN_ENDPOINT: 'bucket.oss-cn-hangzhou.aliyuncs.com',
-    CDN_URL: 'https://docs-cdn.flashcat.cloud',
-    CDN_DIR: '/docs'
+    CDN_BUCKET: 'flashduty-public',
+    CDN_REGION: 'oss-cn-beijing',
+    CDN_ENDPOINT: 'oss-cn-beijing.aliyuncs.com',
+    CDN_URL: 'https://static.flashcat.cloud',
+    CDN_DIR: '/flashduty-docs'
   };
 
   const uploaded = [];
   const refreshed = [];
   const ossClient = {
     async put(ossFilePath, localFilePath, options) {
       uploaded.push({ ossFilePath, localFilePath, options });
-      return { url: `https://bucket.oss-cn-hangzhou.aliyuncs.com${ossFilePath}` };
+      return { url: `https://flashduty-public.oss-cn-beijing.aliyuncs.com${ossFilePath}` };
     }
   };
   const cdnRuntime = {
@@ -69,11 +69,11 @@ test('uploadDocsBundle uploads the tarball with gzip headers and refreshes the C
 
   const cdnUrl = await uploadDocsBundle({ tarPath, env, ossClient, cdnRuntime });
 
-  assert.equal(cdnUrl, 'https://docs-cdn.flashcat.cloud/docs/flashduty-docs.tar.gz');
-  assert.deepEqual(uploaded.map((item) => item.ossFilePath), ['/docs/flashduty-docs.tar.gz']);
+  assert.equal(cdnUrl, 'https://static.flashcat.cloud/flashduty-docs/flashduty-docs.tar.gz');
+  assert.deepEqual(uploaded.map((item) => item.ossFilePath), ['/flashduty-docs/flashduty-docs.tar.gz']);
   assert.equal(uploaded[0].localFilePath, tarPath);
   assert.equal(uploaded[0].options.headers['Content-Type'], 'application/gzip');
   assert.equal(uploaded[0].options.headers['Cache-Control'], 'public, max-age=300');
   assert.equal(uploaded[0].options.timeout, 30 * 60 * 1000);
-  assert.deepEqual(refreshed, ['https://docs-cdn.flashcat.cloud/docs/flashduty-docs.tar.gz']);
+  assert.deepEqual(refreshed, ['https://static.flashcat.cloud/flashduty-docs/flashduty-docs.tar.gz']);
 });