Конфигурация · Переводчик ресурсов

Переопределите путь с помощью configPath входа, если нужна нестандартная локация.

Схема

# .github/resource-translator.yml
sourceLocale: en

# Provider config can be nested. Keep secrets in workflow inputs; use repo
# config for non-secret defaults like region, model, formality, or category.
provider:
  azure:
    categoryId: my-custom-translator-category
    apiVersion: "3.0"
    allowFallback: true

toLocales:
  - fr
  - de
  - es
include:
  - "src/**/*.en.json"
  - "apps/**/*.en.resx"
exclude:
  - "**/__tests__/**"
glossary:
  Acme: Contoso
  Octocat: Octocat   # keep brand names verbatim

# Translator request shape — most users can ignore these.
textType: plain                  # plain | html
profanityAction: NoAction        # NoAction | Marked | Deleted
profanityMarker: Asterisk        # Asterisk | Tag (only when profanityAction == Marked)

# Resilience — Translator returns 429 under load. Defaults are usually
# fine; tune only if your runs are large enough to hit them.
maxRetries: 5
retryBackoffMs: 30000             # cap on any single backoff sleep (ms)

# Placeholder protection. ON by default — wraps tokens like {{name}},
# {0}, %s, ${var} into sentinels before translation and restores them
# on the way back. Set false only when source intentionally contains
# placeholder-shaped literals.
protectPlaceholders: true
customPlaceholderPatterns:
  - "<<.+?>>"                     # any extra token syntax you use

# Per-key opt-out. Keys matching any glob are dropped from the request
# and pass through with the source value preserved.
noTranslatePatterns:
  - "errors.code.*"
  - "brands.*"

Полевые ссылки

provider

Тип: "azure" | "aws" | "google" | provider block

Either a provider string or a nested provider block (provider.azure, provider.aws, or provider.google). Prefer nested blocks for provider-specific settings; keep secrets in workflow inputs rather than committed config.

sourceLocale

Тип: string

Если не настроено, возвращается к sourceLocale входу. Также пересылается в Translator как from=<locale>, чтобы короткие строки не определялись автоматически.

toLocales

Тип: string[]

Либо массив, либо строка, разделённая запятой.

include / exclude

Тип: string[]

Шаровые паттерны оценивались по абсолютным и относительным к рабочему пространству траекториям.

glossary

Тип: map<string,string>

Отмены терминов после перевода. Осознание границ слов (обрабатывает C++, .NET).

categoryId

Тип: string

Azure Custom Translator категория — ваш регулятор отрасли/домена (юридический, медицинский, маркетинговый тон и т.д.). Отправлен как ?category=....

textType

Тип: "plain" | "html"

По умолчанию plain. Используйте html только если ваши значения ресурсов содержат реальные HTML-фрагменты.

profanityAction

Тип: "NoAction" | "Marked" | "Deleted"

Как обращаться с нецензурными выражениями в переводе.

profanityMarker

Тип: "Asterisk" | "Tag"

Это имеет смысл только тогда, когда profanityAction "Marked".

allowFallback

Тип: boolean

Установите false для неудачи перевода, когда у вашего categoryId нет развертывания для целевого локаля, вместо того чтобы возвращаться к общей модели.

apiVersion

Тип: string

Версия REST API для транслятора. По умолчанию 3.0.

awsFormality

Тип: "FORMAL" | "INFORMAL"

AWS Translate formality setting for supported target languages.

awsBrevity

Тип: boolean

Set to true to enable AWS Translate brevity mode for supported language pairs.

awsTerminologyNames / awsParallelDataNames

Тип: string[]

AWS Translate custom terminology and parallel data resource names. Either an array or comma-separated string.

googleModel

Тип: string

Google Cloud Translation model, e.g. nmt or base.

googleApiEndpoint

Тип: string

Optional Google Cloud Translation API endpoint override.

googleAutoRetry

Тип: boolean

Optional Google Cloud Translation automatic retry toggle. Leave unset to use the Google client default.

maxRetries

Тип: integer

Максимальные попытки повторных попыток временных HTTP-ответов (408, 425, 429, 500, 502, 503, 504). По умолчанию 5. Общее количество HTTP-вызовов на запрос составляет 1 + maxRetries.

retryBackoffMs

Тип: integer

Лимит (ms) на любой единственный отступной сон. По умолчанию 30000. Заголовок Azure Retry-After отмечен именно тогда, когда он присутствует; в противном случае используется экспоненциальное откат, ограниченное этим значением.

protectPlaceholders

Тип: boolean

По умолчанию true. При включении токены, такие как {{name}}, ${var}, {0}, {0:N2}, %s, %1$s и HTML-сущности, заменяются на токены Sentinel до перевода и восстанавливаются после. Отключить только если исходный код намеренно содержит временные литералы.

customPlaceholderPatterns

Тип: string[]

Дополнительные шаблоны regex (без разделителей) добавлены в стандартный набор заполнений, например, <<.+?>> для синтаксиса пользовательских токенов. Некорректные регулярные выражения игнорируются.

noTranslatePatterns

Тип: string[]

Шаблоны Glob совпадали с ключами уровня парсера (JSON пунктирный путь, RESX name, PO msgid, XLIFF блок id, ключ INI/restext). Соответствующие ключи удаляются из запроса и проходят с сохранением исходного значения.

changeDetection

Тип: "smart" | "disabled"

Defaults to smart. Uses the committed state manifest to translate only changed or missing parser keys. Set to disabled or false to preserve the legacy always-translate behavior.

statePath

Тип: string

Path to the deterministic smart change-detection state manifest. Defaults to .github/resource-translator-state.json.

Порядок загрузки

Действие считывает явные вводные данные из рабочего процесса.
Он загружает конфигурацию YAML из configPath.
Для каждого общего поля побеждает вход; в противном случае используется значение YAML.
Объединённые значения валидируются. Недействительные enums (например, profanityAction: Mask) приводят к быстрому провалу действия при чётком сообщении.

Тон и индустрия, если говорить простыми словами

API Azure AI Translator v3 не имеет одной ручки тонального сигнала. Два режима объединяются, чтобы получить почти одинаковый элемент управления:

Отрасль / домен: Используйте categoryId, чтобы указать на категорию Azure Custom Translator, обученную на вашем собственном корпусе — юридических, технических, медицинских, маркетинговых или любых других областях. Это самый сильный рычаг для тона, брендового голоса и словарного запаса.
Поверхностный текст: Используйте Глоссарий, чтобы дословно зафиксировать бренды и термины продуктов, а также используйте profanityAction для удаления нецензурных терминов при таргетировании локализации для молодой аудитории.

Выбирайте свой язык

Конфигурация репозитория

Схема

Полевые ссылки

Порядок загрузки

Тон и индустрия, если говорить простыми словами