GitHub Actions

當你希望倉庫自動翻譯已變更的文件並以產生的輸出建立拉取請求時，使用 GitHub Actions。

大多數倉庫應使用標準的 GITHUB_TOKEN 設定。只有當你的組織限制預設權杖權限或需要基於應用程式的驗證時，才使用 GitHub App 設定。

先決條件

在建立工作流程之前，先設定翻譯執行所需的 AI 服務祕密。

文字翻譯需要一個語言模型提供者：

• Azure OpenAI: AZURE_OPENAI_API_KEY, AZURE_OPENAI_ENDPOINT, AZURE_OPENAI_MODEL_NAME, AZURE_OPENAI_CHAT_DEPLOYMENT_NAME, AZURE_OPENAI_API_VERSION
• OpenAI: OPENAI_API_KEY, OPENAI_CHAT_MODEL_ID, plus optional OPENAI_ORG_ID and OPENAI_BASE_URL

影像翻譯另外需要 Azure AI Vision：

• AZURE_AI_SERVICE_API_KEY
• AZURE_AI_SERVICE_ENDPOINT

請參閱 設定 與 Azure AI 設定 以取得本機設定細節。

標準設定

對於大多數公開與私人倉庫，請使用此設定。

第 1 步：新增倉庫祕密

在目標倉庫中，開啟 Settings > Secrets and variables > Actions，然後新增工作流程將使用的提供者祕密。

第 2 步：啟用工作流程權限

開啟 Settings > Actions > General。

在 Workflow permissions 底下：

1. 選取 Read and write permissions。
2. 啟用 Allow GitHub Actions to create and approve pull requests。
3. 儲存設定。

第 3 步：加入工作流程

建立 .github/workflows/co-op-translator.yml:

name: Co-op Translator

on:
  push:
    branches:
      - main

jobs:
  co-op-translator:
    runs-on: ubuntu-latest

    permissions:
      contents: write
      pull-requests: write

    steps:
      - name: Checkout repository
        uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - name: Set up Python
        uses: actions/setup-python@v4
        with:
          python-version: "3.10"

      - name: Install Co-op Translator
        run: |
          python -m pip install --upgrade pip
          pip install co-op-translator

      - name: Run Co-op Translator
        env:
          PYTHONIOENCODING: utf-8
          AZURE_AI_SERVICE_API_KEY: ${{ secrets.AZURE_AI_SERVICE_API_KEY }}
          AZURE_AI_SERVICE_ENDPOINT: ${{ secrets.AZURE_AI_SERVICE_ENDPOINT }}
          AZURE_OPENAI_API_KEY: ${{ secrets.AZURE_OPENAI_API_KEY }}
          AZURE_OPENAI_ENDPOINT: ${{ secrets.AZURE_OPENAI_ENDPOINT }}
          AZURE_OPENAI_MODEL_NAME: ${{ secrets.AZURE_OPENAI_MODEL_NAME }}
          AZURE_OPENAI_CHAT_DEPLOYMENT_NAME: ${{ secrets.AZURE_OPENAI_CHAT_DEPLOYMENT_NAME }}
          AZURE_OPENAI_API_VERSION: ${{ secrets.AZURE_OPENAI_API_VERSION }}
          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
          OPENAI_ORG_ID: ${{ secrets.OPENAI_ORG_ID }}
          OPENAI_CHAT_MODEL_ID: ${{ secrets.OPENAI_CHAT_MODEL_ID }}
          OPENAI_BASE_URL: ${{ secrets.OPENAI_BASE_URL }}
        run: |
          translate -l "es fr de" -y

      - name: Create Pull Request with translations
        uses: peter-evans/create-pull-request@v5
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
          commit-message: "Update translations via Co-op Translator"
          title: "Update translations via Co-op Translator"
          body: |
            This PR updates translations for recent changes to the main branch.

            Generated by Co-op Translator.
          branch: update-translations
          base: main
          labels: translation, automated-pr
          delete-branch: true
          add-paths: |
            translations/
            translated_images/

Change translate -l "es fr de" -y to the target languages and content flags your project needs. For large repositories, add a paths: filter under on: so the workflow only runs when documentation changes.

GitHub App 設定

當 GITHUB_TOKEN 無法在你的組織中建立提交或拉取請求時，請使用此設定。

第 1 步：建立或安裝 GitHub App

建立一個對 Contents 與 Pull requests 具有讀寫存取權的 GitHub App，或在組織已有提供的應用程式時安裝該應用程式。

記錄：

• 應用程式 ID
• 私鑰內容

將它們儲存為倉庫祕密：

• GH_APP_ID
• GH_APP_PRIVATE_KEY

第 2 步：產生應用程式權杖

使用與標準設定相同的工作流程，但在拉取請求步驟之前加入一個 app-token 步驟：

      - name: Authenticate GitHub App
        id: generate_token
        uses: tibdex/github-app-token@v1
        with:
          app_id: ${{ secrets.GH_APP_ID }}
          private_key: ${{ secrets.GH_APP_PRIVATE_KEY }}

      - name: Create Pull Request with translations
        uses: peter-evans/create-pull-request@v5
        with:
          token: ${{ steps.generate_token.outputs.token }}
          commit-message: "Update translations via Co-op Translator"
          title: "Update translations via Co-op Translator"
          branch: update-translations
          base: main
          delete-branch: true
          add-paths: |
            translations/
            translated_images/

執行者限制

GitHub 託管的 runner 有最大工作執行時間。大型倉庫或多個目標語言可能會超過該限制。

對於大量的翻譯工作負載：

• 每次執行翻譯較少的語言。
• 使用內容旗標，例如 -md、-nb 或 -img。
• 當倉庫大小或模型延遲使託管 runner 不可靠時，使用自我託管的 runner。

在 CI 中審閱

當需要在拉取請求中驗證產生的翻譯而不呼叫 LLM 或 Vision 提供者時，使用 co-op-review。

      - name: Review translated outputs
        run: |
          co-op-review --changed-from "origin/${{ github.base_ref }}" --format github

co-op-review 是一個測試版的確定性審查指令。其檢查和輸出結構可能會演進，但它被設計為對 CI 安全，因為它不會寫入檔案或呼叫模型提供者。