repository·master·Indexed 42 days ago
https://github.com/3ru/gpt-translateA GitHub Action for automating the translation of Markdown (.md), MDX (.mdx), and JSON (.json) files into multiple languages. It is triggered via issue or pull request comments using /gpt-translate or /gt commands and supports various AI providers including OpenAI, Anthropic, Google Gemini, Azure, Perplexity, Groq, Fireworks AI, Mistral AI, and Cohere. Version 1.2.2.
The translation capabilities of gpt-translate are determined by the underlying LLM used (GPT-3.5 or GPT-4).
GPT-3.5 or GPT-4 can be translated.The action currently only supports translating the following file types:
.md).mdx).json)You can translate into any language that can be interpreted by GPT-4 or GPT-3.5.
gpt-translate is free to run, the translation process relies on the OpenAI API, which is a paid service. Users are responsible for any costs incurred via their OpenAI account based on OpenAI API Pricing.gpt-translate is free to run, you must pay for the usage of the OpenAI API used to perform the translations. You can check the current rates at the OpenAI API pricing page.The bot supports any language that can be interpreted by GPT-4 or GPT-3.5.
While the default configuration often uses OpenAI, the project supports multiple providers including:
When translating large Markdown files, avoid extremely long sentences or blocks of text without line breaks.
If a text block contains approximately 80,000 consecutive characters without line breaks (specifically when using gpt-3.5), it may cause errors during the splitting process. To ensure successful translation, use frequent line breaks to separate paragraphs or sections.
You can measure the token count of your text using the official OpenAI tokenizer.
# Friendly format (Recommended)
This is a sample novel.
Once upon a time...The prompt argument allows you to define a custom instruction for the AI model to follow during translation. You can use dynamic variables within curly braces {} to inject context into your prompt:
{targetLanguage}: The desired language for translation.{targetFileExt}: The desired file extension (e.g., .md).Example configuration using a custom prompt:
with:
apikey: ${{ secrets.OPENAI_API_KEY }}
prompt: 'Please translate the given text into naturalistic {targetLanguage} and output it in {targetFileExt} format.'with:
apikey: ${{ secrets.OPENAI_API_KEY }}
prompt: 'Please translate the given text into naturalistic {targetLanguage}.'To use GPT Translate, you must configure your repository permissions and secrets to allow the action to write files and access AI models.
Navigate to Settings > Actions > General and enable:
Read and write permissionsAllow GitHub Actions to create and approve pull requestsNavigate to Settings > Secrets and variables > Actions and add your AI provider's API key as a secret named OPENAI_API_KEY (or the relevant key for your provider).
Create a workflow file (e.g., .github/workflows/gpt-translate.yml). It is highly recommended to trigger the action only when a specific comment is made to save runtime costs.
Minimum Workflow Example:
# .github/workflows/gpt-translate.yml
name: GPT Translate
on:
issue_comment:
types: [ created ]
jobs:
gpt_translate:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Run GPT Translate
if: |
contains(github.event.comment.body, '/gpt-translate') ||
contains(github.event.comment.body, '/gt')
uses: 3ru/gpt-translate@master
with:
apikey: ${{ secrets.OPENAI_API_KEY }}The bot requires an OpenAI API key to perform translations. You must add this key as a repository secret so the GitHub Action can access it.
Settings > Secrets and variables > Actions in your repository.OPENAI_API_KEY.To use GPT Translate, you must configure your repository permissions and secrets, then create a workflow file.
Settings > Actions > General and enable Read and write permissions. Also, enable Allow GitHub Actions to create and approve pull requests.Settings > Secrets and variables > Actions and add your AI provider's API key as a secret named OPENAI_API_KEY (or the relevant key for your provider).Create a workflow file (e.g., .github/workflows/gpt-translate.yml). The workflow must:
actions/checkout@v4 (or similar) to check out the repository.issue_comment with types: [ created ].apikey input.It is recommended to use a conditional if check so the action only runs when a specific command is mentioned in the comment to save execution time.
# .github/workflows/gpt-translate.yml
name: GPT Translate
on:
issue_comment:
types: [ created ]
jobs:
gpt_translate:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Run GPT Translate
if: |
contains(github.event.comment.body, '/gpt-translate') ||
contains(github.event.comment.body, '/gt')
uses: 3ru/gpt-translate@master
with:
apikey: ${{ secrets.OPENAI_API_KEY }}To enable command-based translation, create a GitHub Actions workflow file (e.g., .github/workflows/gpt-translate.yml) with the following configuration.
Important Requirements:
actions/checkout@v3 before the translation step so the action has access to the files in your repository.if statement to ensure the action only runs when /gpt-translate or /gt is detected in the comment body.OPENAI_API_KEY).name: GPT翻译
on:
issue_comment:
types: [created]
jobs:
gpt_translate:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: 运行GPT翻译
if: |
contains(github.event.comment.body, '/gpt-translate') ||
contains(github.event.comment.body, '/gt')
uses: 3ru/gpt-translate@master
with:
apikey: ${{ secrets.OPENAI_API_KEY }}