Skip to content

chore: update pr trans sync workflow #22576

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
qiancai wants to merge 2 commits into
base: master
Choose a base branch
from
Open

chore: update pr trans sync workflow #22576

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
605228d
make the workflow more stable
qiancai Mar 18, 2026
495385a
support openai
qiancai Mar 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 46 additions & 7 deletions .github/workflows/sync-doc-pr-zh-to-en.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,12 @@ on:
options:
- deepseek
- gemini
default: 'gemini'
- openai
default: 'openai'

permissions:
contents: write
pull-requests: write

jobs:
sync-docs:
Expand Down Expand Up @@ -67,6 +72,13 @@ jobs:
TARGET_OWNER=$(echo "$TARGET_URL" | cut -d'/' -f4)
TARGET_REPO=$(echo "$TARGET_URL" | cut -d'/' -f5)
TARGET_PR=$(echo "$TARGET_URL" | cut -d'/' -f7)

if [[ "$SOURCE_OWNER/$SOURCE_REPO" != "pingcap/docs-cn" ]]; then
echo "❌ Unsupported source repository: only pingcap/docs-cn is supported"; exit 1
fi
if [[ "$TARGET_OWNER/$TARGET_REPO" != "pingcap/docs" ]]; then
echo "❌ Unsupported target repository: only pingcap/docs is supported"; exit 1
fi

{
echo "source_owner<<EOF"; echo "$SOURCE_OWNER"; echo "EOF"
Expand Down Expand Up @@ -109,10 +121,12 @@ jobs:

- name: Run sync script
id: sync_script
continue-on-error: true
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
DEEPSEEK_API_TOKEN: ${{ secrets.DEEPSEEK_API_TOKEN }}
GEMINI_API_TOKEN: ${{ secrets.GEMINI_API_TOKEN }}
OPENAI_API_TOKEN: ${{ secrets.OPENAI_API_TOKEN }}
SOURCE_PR_URL: ${{ github.event.inputs.source_pr_url }}
TARGET_PR_URL: ${{ github.event.inputs.target_pr_url }}
AI_PROVIDER: ${{ github.event.inputs.ai_provider }}
Expand Down Expand Up @@ -156,17 +170,19 @@ jobs:
TARGET_REPO: ${{ steps.extract_info.outputs.target_repo }}
TARGET_PR: ${{ steps.extract_info.outputs.target_pr }}
run: |
BODY=$(printf '%s\n\n%s\n%s\n%s\n\n%s' "**Auto-sync completed successfully**" \
"**Source PR**: ${SOURCE_PR_URL}" "**Target PR**: ${TARGET_PR_URL}" \
"English documentation has been updated based on Chinese documentation changes." )
BODY=$(printf '%s\n\n%s\n%s\n\n%s' \
"**Auto-sync completed successfully**" \
"**Source PR**: ${SOURCE_PR_URL}" \
"**Target PR**: ${TARGET_PR_URL}" \
"English documentation has been updated based on Chinese documentation changes.")
PAYLOAD=$(jq -n --arg body "$BODY" '{body: $body}')
curl -X POST -H "Authorization: token ${GITHUB_TOKEN}" \
-H "Accept: application/vnd.github.v3+json" \
"https://api.github.com/repos/${TARGET_OWNER}/${TARGET_REPO}/issues/${TARGET_PR}/comments" \
-d "$PAYLOAD"

- name: Add failure comment to target PR
if: steps.sync_script.outputs.sync_success == 'false'
if: always() && steps.sync_script.outputs.sync_success == 'false'
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
SOURCE_PR_URL: ${{ github.event.inputs.source_pr_url }}
Expand All @@ -175,11 +191,34 @@ jobs:
TARGET_REPO: ${{ steps.extract_info.outputs.target_repo }}
TARGET_PR: ${{ steps.extract_info.outputs.target_pr }}
run: |
BODY=$(printf '%s\n\n%s\n%s\n%s\n\n%s' "**Auto-sync failed**" \
"**Source PR**: ${SOURCE_PR_URL}" "**Target PR**: ${TARGET_PR_URL}" \
BODY=$(printf '%s\n\n%s\n%s\n\n%s' \
"**Auto-sync failed**" \
"**Source PR**: ${SOURCE_PR_URL}" \
"**Target PR**: ${TARGET_PR_URL}" \
"The sync process encountered an error. Please check the workflow logs for details.")
PAYLOAD=$(jq -n --arg body "$BODY" '{body: $body}')
curl -X POST -H "Authorization: token ${GITHUB_TOKEN}" \
-H "Accept: application/vnd.github.v3+json" \
"https://api.github.com/repos/${TARGET_OWNER}/${TARGET_REPO}/issues/${TARGET_PR}/comments" \
-d "$PAYLOAD"

- name: Add failure comment on early step failure
if: failure() && steps.extract_info.outputs.target_owner != ''
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
SOURCE_PR_URL: ${{ github.event.inputs.source_pr_url }}
TARGET_PR_URL: ${{ github.event.inputs.target_pr_url }}
TARGET_OWNER: ${{ steps.extract_info.outputs.target_owner }}
TARGET_REPO: ${{ steps.extract_info.outputs.target_repo }}
TARGET_PR: ${{ steps.extract_info.outputs.target_pr }}
run: |
BODY=$(printf '%s\n\n%s\n%s\n\n%s' \
"**Auto-sync failed (early step failure)**" \
"**Source PR**: ${SOURCE_PR_URL}" \
"**Target PR**: ${TARGET_PR_URL}" \
"A step before the sync script failed. Please check the workflow logs for details.")
PAYLOAD=$(jq -n --arg body "$BODY" '{body: $body}')
curl -X POST -H "Authorization: token ${GITHUB_TOKEN}" \
-H "Accept: application/vnd.github.v3+json" \
"https://api.github.com/repos/${TARGET_OWNER}/${TARGET_REPO}/issues/${TARGET_PR}/comments" \
-d "$PAYLOAD"
Loading