대상 독자: 이 가이드는 표준 GitHub Actions 권한이 충분한 대부분의 공개 또는 비공개 저장소의 사용자를 대상으로 합니다. 내장된 GITHUB_TOKEN
을 사용합니다.
Co-op Translator GitHub Action을 사용하여 저장소의 문서를 자동으로 번역하세요. 이 가이드는 소스 Markdown 파일이나 이미지가 변경될 때마다 업데이트된 번역으로 자동으로 풀 리퀘스트를 생성하는 방법을 안내합니다.
[!IMPORTANT]
올바른 가이드 선택:
이 가이드는 표준
GITHUB_TOKEN
을 사용하는 간단한 설정을 설명합니다. 민감한 GitHub App Private Keys를 관리할 필요가 없기 때문에 대부분의 사용자에게 권장되는 방법입니다.
GitHub Action을 구성하기 전에 필요한 AI 서비스 자격 증명을 준비하세요.
1. 필수: AI 언어 모델 자격 증명 지원되는 언어 모델 중 최소 하나의 자격 증명이 필요합니다:
2. 선택 사항: AI 비전 자격 증명 (이미지 번역용)
표준 GITHUB_TOKEN
을 사용하여 저장소에 Co-op Translator GitHub Action을 구성하는 단계를 따르세요.
GITHUB_TOKEN
사용)이 워크플로우는 GitHub Actions에서 제공하는 내장 GITHUB_TOKEN
을 사용합니다. 이 토큰은 3단계에서 구성된 설정에 따라 저장소와 상호작용할 수 있는 권한을 워크플로우에 자동으로 부여합니다.
저장소 설정에서 암호화된 비밀로 AI 서비스 자격 증명만 추가하면 됩니다.
Repository secrets 아래에서, 아래 나열된 각 필수 AI 서비스 비밀에 대해 New repository secret을 클릭합니다.
(이미지 참조: 비밀을 추가하는 위치를 보여줌)
필수 AI 서비스 비밀 (사전 준비 사항에 따라 적용되는 모든 항목 추가):
비밀 이름 | 설명 | 값 출처 |
---|---|---|
AZURE_SUBSCRIPTION_KEY |
Azure AI 서비스 (컴퓨터 비전) 키 | Azure AI Foundry |
AZURE_AI_SERVICE_ENDPOINT |
Azure AI 서비스 (컴퓨터 비전) 엔드포인트 | Azure AI Foundry |
AZURE_OPENAI_API_KEY |
Azure OpenAI 서비스 키 | Azure AI Foundry |
AZURE_OPENAI_ENDPOINT |
Azure OpenAI 서비스 엔드포인트 | Azure AI Foundry |
AZURE_OPENAI_MODEL_NAME |
Azure OpenAI 모델 이름 | Azure AI Foundry |
AZURE_OPENAI_CHAT_DEPLOYMENT_NAME |
Azure OpenAI 배포 이름 | Azure AI Foundry |
AZURE_OPENAI_API_VERSION |
Azure OpenAI API 버전 | Azure AI Foundry |
OPENAI_API_KEY |
OpenAI API 키 | OpenAI Platform |
OPENAI_ORG_ID |
OpenAI 조직 ID (선택 사항) | OpenAI Platform |
OPENAI_CHAT_MODEL_ID |
특정 OpenAI 모델 ID (선택 사항) | OpenAI Platform |
OPENAI_BASE_URL |
사용자 정의 OpenAI API 기본 URL (선택 사항) | OpenAI Platform |
GitHub Action은 GITHUB_TOKEN
을 통해 코드 체크아웃 및 풀 리퀘스트 생성을 위한 권한이 필요합니다.
contents: write
및 pull-requests: write
권한을 GITHUB_TOKEN
에 부여합니다.마지막으로, GITHUB_TOKEN
을 사용하여 자동화된 워크플로우를 정의하는 YAML 파일을 생성합니다.
.github/workflows/
디렉토리를 생성합니다 (존재하지 않는 경우)..github/workflows/
안에 co-op-translator.yml
이라는 파일을 생성합니다.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
# === AI Service Credentials ===
AZURE_SUBSCRIPTION_KEY: $
AZURE_AI_SERVICE_ENDPOINT: $
AZURE_OPENAI_API_KEY: $
AZURE_OPENAI_ENDPOINT: $
AZURE_OPENAI_MODEL_NAME: $
AZURE_OPENAI_CHAT_DEPLOYMENT_NAME: $
AZURE_OPENAI_API_VERSION: $
OPENAI_API_KEY: $
OPENAI_ORG_ID: $
OPENAI_CHAT_MODEL_ID: $
OPENAI_BASE_URL: $
run: |
# =====================================================================
# IMPORTANT: Set your target languages here (REQUIRED CONFIGURATION)
# =====================================================================
# Example: Translate to Spanish, French, German. Add -y to auto-confirm.
translate -l "es fr de" -y # <--- MODIFY THIS LINE with your desired languages
- name: Create Pull Request with translations
uses: peter-evans/create-pull-request@v5
with:
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.
### 📋 Changes included
- Translated contents are available in the `translations/` directory
- Translated images are available in the `translated_images/` directory
---
🌐 Automatically generated by the [Co-op Translator](https://github.com/Azure/co-op-translator) GitHub Action.
branch: update-translations
base: main
labels: translation, automated-pr
delete-branch: true
add-paths: |
translations/
translated_images/
Run Co-op Translator
단계에서 translate -l "..." -y
명령어 내의 언어 코드 목록을 검토하고 프로젝트 요구 사항에 맞게 수정해야 합니다. 예제 목록 (ar de es...
)은 교체하거나 조정해야 합니다.on:
): 현재 트리거는 main
에 대한 모든 푸시에서 실행됩니다. 대규모 저장소의 경우, 관련 파일(예: 소스 문서)이 변경될 때만 워크플로우가 실행되도록 paths:
필터를 추가하는 것을 고려하세요. 이는 실행 시간을 절약할 수 있습니다.Create Pull Request
단계에서 commit-message
, title
, body
, branch
이름 및 labels
를 사용자 정의하세요.면책 조항:
이 문서는 AI 번역 서비스 Co-op Translator를 사용하여 번역되었습니다. 정확성을 위해 노력하고 있지만, 자동 번역에는 오류나 부정확성이 있을 수 있음을 유의하시기 바랍니다. 원본 문서는 해당 언어로 작성된 것이 권위 있는 출처로 간주되어야 합니다. 중요한 정보의 경우, 전문적인 인간 번역을 권장합니다. 이 번역 사용으로 인해 발생하는 오해나 잘못된 해석에 대해 책임을 지지 않습니다.