Document action (#5304)

* fix: context * fix: context * action * update scripts * update action * fix: kubeconfig * update preview * docker file * perf: action per * update doc deploy yml * doc (#99) * doc * doc * rename * doc * fix: action on * doc (#100)
2025-10-15 15:41:05 +00:00 · 2025-07-23 23:27:37 +08:00
parent 55ad9085df
commit 393b7abe7d
16 changed files with 250 additions and 247 deletions
--- a/.github/workflows/docs-deploy-cf.yml
+++ b/.github/workflows/docs-deploy-cf.yml
@@ -1,71 +0,0 @@
-name: Deploy doc image to cf
-
-on:
-  workflow_dispatch:
-  push:
-    paths:
-      - 'docSite/**'
-    branches:
-      - 'main'
-
-# A workflow run is made up of one or more jobs that can run sequentially or in parallel
-jobs:
-  # This workflow contains jobs "deploy-production"
-  deploy-production:
-    # The environment this job references
-    environment:
-      name: Production
-      url: ${{ steps.vercel-action.outputs.preview-url }}
-
-    # The type of runner that the job will run on
-    runs-on: ubuntu-24.04
-
-    permissions:
-      contents: write
-    concurrency:
-      group: ${{ github.workflow }}-${{ github.ref }}
-
-    # Job outputs
-    outputs:
-      docs: ${{ steps.filter.outputs.docs }}
-
-    # Steps represent a sequence of tasks that will be executed as part of the job
-    steps:
-      # Step 1 - Checks-out your repository under $GITHUB_WORKSPACE
-      - name: Checkout
-        uses: actions/checkout@v3
-        with:
-          submodules: recursive # Fetch submodules
-          fetch-depth: 0 # Fetch all history for .GitInfo and .Lastmod
-
-      # Step 2 Detect changes to Docs Content
-      - name: Detect changes in doc content
-        uses: dorny/paths-filter@v2
-        id: filter
-        with:
-          filters: |
-            docs:
-              - 'docSite/content/docs/**'
-          base: main
-
-      - name: Add cdn for images
-        run: |
-          sed -i "s#\](/imgs/#\](https://cdn.jsdelivr.net/gh/yangchuansheng/fastgpt-imgs@main/imgs/#g" $(grep -rl "\](/imgs/" docSite/content/zh-cn/docs)
-
-      # Step 3 - Install Hugo (specific version)
-      - name: Install Hugo
-        uses: peaceiris/actions-hugo@v2
-        with:
-          hugo-version: '0.117.0'
-          extended: true
-
-      # Step 4 - Builds the site using Hugo
-      - name: Build
-        run: cd docSite && hugo mod get -u github.com/colinwilson/lotusdocs@6d0568e && hugo -v --minify
-
-      - name: Deploy to GitHub Pages
-        uses: peaceiris/actions-gh-pages@v4
-        if: github.ref == 'refs/heads/main'
-        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: docSite/public
--- a/.github/workflows/docs-deploy-kubeconfig.yml
+++ b/.github/workflows/docs-deploy-kubeconfig.yml
@@ -1,90 +0,0 @@
-name: Deploy doc image by kubeconfig
-on:
-  workflow_dispatch:
-  push:
-    paths:
-      - 'docSite/**'
-    branches:
-      - 'main'
-
-jobs:
-  build-fastgpt-docs-images:
-    runs-on: ubuntu-latest
-
-    permissions:
-      contents: read
-      packages: write
-      attestations: write
-      id-token: write
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Change baseURL
-        run: sed -i 's|^baseURL =.*|baseURL = "https://doc.fastgpt.cn"|g' ./docSite/hugo.toml
-
-      - name: Get current date and time
-        id: datetime
-        run: echo "datetime=$(date +'%Y%m%d%H%M%S')" >> "$GITHUB_OUTPUT"
-
-      - name: Docker meta
-        id: meta
-        uses: docker/metadata-action@v5
-        with:
-          # list of Docker images to use as base name for tags
-          images: |
-            ghcr.io/${{ github.repository_owner }}/fastgpt-docs
-            registry.cn-hangzhou.aliyuncs.com/${{ secrets.ALI_HUB_USERNAME }}/fastgpt-docs
-          tags: |
-            ${{ steps.datetime.outputs.datetime }}
-          flavor: latest=false
-
-      - name: Set up QEMU
-        uses: docker/setup-qemu-action@v3
-
-      - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v3
-
-      - name: Login to ghcr.io
-        uses: docker/login-action@v3
-        with:
-          registry: ghcr.io
-          username: ${{ github.actor }}
-          password: ${{ secrets.GITHUB_TOKEN }}
-
-      - name: Login to Aliyun
-        uses: docker/login-action@v3
-        with:
-          registry: registry.cn-hangzhou.aliyuncs.com
-          username: ${{ secrets.ALI_HUB_USERNAME }}
-          password: ${{ secrets.ALI_HUB_PASSWORD }}
-
-      - name: Build and push Docker images to ghcr.io and DockerHub
-        uses: docker/build-push-action@v5
-        with:
-          context: .
-          file: ./docSite/Dockerfile
-          push: true
-          tags: ${{ steps.meta.outputs.tags }}
-          labels: ${{ steps.meta.outputs.labels }}
-    outputs:
-      tags: ${{ steps.datetime.outputs.datetime }}
-
-  update-docs-image:
-    needs: build-fastgpt-docs-images
-    runs-on: ubuntu-24.04
-    if: github.repository == 'labring/FastGPT'
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v3
-      - uses: actions-hub/kubectl@master
-        env:
-          KUBE_CONFIG: ${{ secrets.KUBE_CONFIG }}
-        with:
-          args: set image deployment/fastgpt-docs fastgpt-docs=registry.cn-hangzhou.aliyuncs.com/${{ secrets.ALI_HUB_USERNAME }}/fastgpt-docs:${{ needs.build-fastgpt-docs-images.outputs.tags }}
-      - uses: actions-hub/kubectl@master
-        env:
-          KUBE_CONFIG: ${{ secrets.KUBE_CONFIG }}
-        with:
-          args: annotate deployment/fastgpt-docs originImageName="registry.cn-hangzhou.aliyuncs.com/${{ secrets.ALI_HUB_USERNAME }}/fastgpt-docs:${{ needs.build-fastgpt-docs-images.outputs.tags }}" --overwrite
--- a/.github/workflows/docs-deploy.yml
+++ b/.github/workflows/docs-deploy.yml
@@ -0,0 +1,117 @@
+name: Document deploy
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'document/**'
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  packages: write
+  attestations: write
+  id-token: write
+  pull-requests: write
+
+jobs:
+  build-images:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        domain_config:
+          - domain: 'https://fastgpt.io'
+            suffix: 'io'
+          - domain: 'https://fastgpt.cn'
+            suffix: 'cn'
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Get current datetime
+        id: datetime
+        run: echo "datetime=$(date +'%Y%m%d%H%M%S')" >> $GITHUB_OUTPUT
+
+      - name: Docker meta
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          # list of Docker images to use as base name for tags
+          images: |
+            ${{ secrets.ALI_IMAGE_NAME }}/fastgpt-docs
+          tags: |
+            ${{ matrix.domain_config.suffix }}-${{ steps.datetime.outputs.datetime }}
+          flavor: latest=false
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Cache Docker layers
+        uses: actions/cache@v4
+        with:
+          path: /tmp/.buildx-cache-${{ matrix.domain_config.suffix }}
+          key: ${{ runner.os }}-docs-buildx-${{ matrix.domain_config.suffix }}-${{ github.sha }}
+          restore-keys: |
+            ${{ runner.os }}-docs-buildx-${{ matrix.domain_config.suffix }}-
+
+      - name: Login to Aliyun
+        uses: docker/login-action@v3
+        with:
+          registry: registry.cn-hangzhou.aliyuncs.com
+          username: ${{ secrets.ALI_HUB_USERNAME }}
+          password: ${{ secrets.ALI_HUB_PASSWORD }}
+
+      - name: Build and push Docker images
+        uses: docker/build-push-action@v5
+        with:
+          context: ./document
+          file: ./document/Dockerfile
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          # 使用本地缓存替代 GHA 缓存
+          cache-from: type=local,src=/tmp/.buildx-cache-${{ matrix.domain_config.suffix }}
+          cache-to: type=local,dest=/tmp/.buildx-cache-${{ matrix.domain_config.suffix }}
+          build-args: |
+            NEXT_PUBLIC_SEARCH_APPKEY=c4708d48f2de6ac5d2f0f443979ef92a
+            NEXT_PUBLIC_SEARCH_APPID=HZAF4C2T88
+            NEXT_PUBLIC_HOME_DOMAIN=${{ matrix.domain_config.domain }}
+    outputs:
+      tags: ${{ steps.datetime.outputs.datetime }}
+
+  update-images:
+    needs: build-images
+    runs-on: ubuntu-24.04
+    strategy:
+      matrix:
+        domain_config:
+          - domain: 'https://fastgpt.io'
+            suffix: 'io'
+            deployment: 'fastgpt-docs'
+            kube_config: 'KUBE_CONFIG_IO'
+          - domain: 'https://fastgpt.cn'
+            suffix: 'cn'
+            deployment: 'fastgpt-docs'
+            kube_config: 'KUBE_CONFIG_CN'
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      # Add kubeconfig setup step to handle encoding issues
+      - name: Setup kubeconfig
+        run: |
+          mkdir -p $HOME/.kube
+          echo "${{ secrets[matrix.domain_config.kube_config] }}" > $HOME/.kube/config
+          chmod 600 $HOME/.kube/config
+
+      - name: Update deployment image
+        run: |
+          kubectl set image deployment/${{ matrix.domain_config.deployment }} ${{ matrix.domain_config.deployment }}=${{ secrets.ALI_IMAGE_NAME }}/fastgpt-docs:${{ matrix.domain_config.suffix }}-${{ needs.build-images.outputs.tags }}
+
+      - name: Annotate deployment
+        run: |
+          kubectl annotate deployment/${{ matrix.domain_config.deployment }} originImageName="${{ secrets.ALI_IMAGE_NAME }}/fastgpt-docs:${{ matrix.domain_config.suffix }}-${{ needs.build-images.outputs.tags }}" --overwrite
--- a/.github/workflows/docs-preview.yml
+++ b/.github/workflows/docs-preview.yml
@@ -5,20 +5,25 @@ on:
      - 'document/**'
  workflow_dispatch:

-jobs:
-  build-fastgpt-docs-images:
-    runs-on: ubuntu-latest
+permissions:
+  contents: read
+  packages: write
+  attestations: write
+  id-token: write
+  pull-requests: write

-    permissions:
-      contents: read
-      packages: write
-      attestations: write
-      id-token: write
+jobs:
+  build-images:
+    runs-on: ubuntu-latest

    steps:
      - name: Checkout
        uses: actions/checkout@v4

+      - name: Get current datetime
+        id: datetime
+        run: echo "datetime=$(date +'%Y%m%d%H%M%S')" >> $GITHUB_OUTPUT
+
      - name: Docker meta
        id: meta
        uses: docker/metadata-action@v5
@@ -36,6 +41,14 @@ jobs:
      - name: Set up Docker Buildx
        uses: docker/setup-buildx-action@v3

+      - name: Cache Docker layers
+        uses: actions/cache@v4
+        with:
+          path: /tmp/.buildx-cache
+          key: ${{ runner.os }}-docs-buildx-${{ github.sha }}
+          restore-keys: |
+            ${{ runner.os }}-docs-buildx-
+
      - name: Login to Aliyun
        uses: docker/login-action@v3
        with:
@@ -46,35 +59,42 @@ jobs:
      - name: Build and push Docker images
        uses: docker/build-push-action@v5
        with:
-          context: .
+          context: ./document
          file: ./document/Dockerfile
          push: true
          tags: ${{ steps.meta.outputs.tags }}
          labels: ${{ steps.meta.outputs.labels }}
+          # 使用本地缓存替代 GHA 缓存
+          cache-from: type=local,src=/tmp/.buildx-cache
+          cache-to: type=local,dest=/tmp/.buildx-cache
          build-args: |
            NEXT_PUBLIC_SEARCH_APPKEY=c4708d48f2de6ac5d2f0f443979ef92a
            NEXT_PUBLIC_SEARCH_APPID=HZAF4C2T88
-            NEXT_PUBLIC_DOMAIN=https://vzldqobwbwna.sealoshzh.site
+            NEXT_PUBLIC_HOME_DOMAIN=https://fastgpt.io
    outputs:
      tags: ${{ steps.datetime.outputs.datetime }}

-  update-docs-image:
-    needs: build-fastgpt-docs-images
+  update-images:
+    needs: build-images
    runs-on: ubuntu-24.04
-    if: github.repository == 'labring/FastGPT'
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
-      - uses: actions-hub/kubectl@master
-        env:
-          KUBE_CONFIG: ${{ secrets.KUBE_CONFIG }}
-        with:
-          args: set image deployment/fastgpt-docs-preview fastgpt-docs-preview=${{ secrets.ALI_IMAGE_NAME }}/fastgpt-docs:${{ needs.build-fastgpt-docs-images.outputs.tags }}
-      - uses: actions-hub/kubectl@master
-        env:
-          KUBE_CONFIG: ${{ secrets.KUBE_CONFIG }}
-        with:
-          args: annotate deployment/fastgpt-docs-preview originImageName="${{ secrets.ALI_IMAGE_NAME }}/fastgpt-docs:${{ needs.build-fastgpt-docs-images.outputs.tags }}" --overwrite
+
+      # Add kubeconfig setup step to handle encoding issues
+      - name: Setup kubeconfig
+        run: |
+          mkdir -p $HOME/.kube
+          echo "${{ secrets.KUBE_CONFIG_CN }}" > $HOME/.kube/config
+          chmod 600 $HOME/.kube/config
+
+      - name: Update deployment image
+        run: |
+          kubectl set image deployment/fastgpt-docs-preview fastgpt-docs-preview=${{ secrets.ALI_IMAGE_NAME }}/fastgpt-docs:${{ needs.build-images.outputs.tags }}
+
+      - name: Annotate deployment
+        run: |
+          kubectl annotate deployment/fastgpt-docs-preview originImageName="${{ secrets.ALI_IMAGE_NAME }}/fastgpt-docs:${{ needs.build-images.outputs.tags }}" --overwrite

      - name: '@finleyge/github-tools'
        uses: FinleyGe/github-tools@0.0.1
@@ -85,6 +105,7 @@ jobs:
          tool: issue-comment
          title: 'Docs Preview:'
          body: |
-            ```
-            🔗 Preview URL: https://vzldqobwbwna.sealoshzh.site
-            ```
+            ---
+            🚀 **FastGPT Document Preview Ready!**
+
+            🔗 [👀 Click here to visit preview](https://pueuoharpgcl.sealoshzh.site)
--- a/.github/workflows/docs-sync_imgs.yml
+++ b/.github/workflows/docs-sync_imgs.yml
@@ -1,23 +0,0 @@
-name: Sync images
-on:
-  push:
-    branches:
-      - main
-    paths:
-      - docSite/assets/imgs/**
-  workflow_dispatch:
-jobs:
-  sync:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-
-      - name: Run GitHub File Sync
-        uses: BetaHuhn/repo-file-sync-action@v1.21.0
-        with:
-          GH_PAT: ${{ secrets.IMG_GH_PAT }}
-          CONFIG_PATH: .github/doc-sync-image.yml
-          ORIGINAL_MESSAGE: true
-          SKIP_PR: true
-          COMMIT_EACH_FILE: false