Konfiguracja · Translator zasobów

Nadpisz ścieżkę za pomocą configPath wejściowego, jeśli potrzebujesz lokalizacji niedomyślnej.

Schemat

# .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.*"

Odniesienie terenowe

provider

Typ: "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

Typ: string

Jeśli nie jest ustawione, wraca do sourceLocale wejścia. Również przekierowano to do Translatora jako from=<locale>, żeby krótkie ciągi znaków nie były automatycznie wykrywane.

toLocales

Typ: string[]

Albo tablica, albo ciąg rozdzielony przecinkami.

include / exclude

Typ: string[]

Wzorce globów oceniane względem ścieżek absolutnych i względnych do przestrzeni roboczej.

glossary

Typ: map<string,string>

Terminy po tłumaczeniu. Świadomy granic słów (obsługuje C++, .NET).

categoryId

Typ: string

Azure Custom Translator kategoria — twoja branża/domena (prawna, medyczna, marketingowa itd.). Wysłane jako ?category=....

textType

Typ: "plain" | "html"

Domyślnie ustawia się na plain. Używaj html tylko wtedy, gdy wartości zasobów zawierają prawdziwe fragmenty HTML.

profanityAction

Typ: "NoAction" | "Marked" | "Deleted"

Jak traktować wulgarne terminy w tłumaczeniu.

profanityMarker

Typ: "Asterisk" | "Tag"

Ma sens tylko wtedy, gdy profanityAction jest "Marked".

allowFallback

Typ: boolean

Ustaw false niepowodzenie tłumaczenia, gdy twój categoryId nie ma wdrożenia dla docelowej lokalizacji, zamiast wracać do ogólnego modelu.

apiVersion

Typ: string

Translator REST API w wersji Domyślnie ustawia się na 3.0.

awsFormality

Typ: "FORMAL" | "INFORMAL"

AWS Translate formality setting for supported target languages.

awsBrevity

Typ: boolean

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

awsTerminologyNames / awsParallelDataNames

Typ: string[]

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

googleModel

Typ: string

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

googleApiEndpoint

Typ: string

Optional Google Cloud Translation API endpoint override.

googleAutoRetry

Typ: boolean

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

maxRetries

Typ: integer

Maksymalna liczba prób powtórek na przejściowych odpowiedziach HTTP (408, 425, 429, 500, 502, 503, 504). Domyślnie ustawia się na 5. Łączna liczba wywołań HTTP na jedno żądanie wynosi 1 + maxRetries.

retryBackoffMs

Typ: integer

Limit (ms) na każdym pojedynczym odchyleniu snu. Domyślnie ustawia się na 30000. Nagłówek Retry-After Azure jest honorowany dokładnie wtedy, gdy jest obecny; w przeciwnym razie stosuje się drgający się odrzut wykładniczy, ograniczony do tej wartości.

protectPlaceholders

Typ: boolean

Domyślnie ustawia się na true. Po włączeniu tokeny takie jak {{name}}, ${var}, {0}, {0:N2}, %s, %1$s oraz jednostki HTML są zastępowane tokenami sentinel przed tłumaczeniem i przywracane po tłumaczeniu. Wyłącz tylko wtedy, gdy źródło celowo zawiera literale w kształcie zastępczych.

customPlaceholderPatterns

Typ: string[]

Dodatkowe wzorce regex (bez ograniczników) dodane do domyślnego zestawu zastępczych, np. <<.+?>> dla własnej składni tokenów. Nieprawidłowe regexy są ignorowane.

noTranslatePatterns

Typ: string[]

Wzorce glob dopasowane do kluczy na poziomie parsera (JSON ścieżka kropkowana, RESX name, PO msgid, jednostka XLIFF id, klucz INI/restext). Pasujące klucze są usuwane z żądania i przekazywane z zachowaną wartością źródłową.

changeDetection

Typ: "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

Typ: string

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

Kolejność załadunku

Akcja odczytuje jawne dane z przepływu pracy.
Konfiguracja YAML ładuje się z configPath.
Dla każdego wspólnego pola wygrywa wejście; w przeciwnym razie używa się wartości YAML.
Scalone wartości są weryfikowane. Nieprawidłowe enumy (np. profanityAction: Mask) powodują, że akcja szybko się nie powiodła z wyraźnym komunikatem.

Ton i przemysł, w prostych słowach

API Azure AI Translator v3 nie posiada pojedynczego pokrętła tonowego. Dwa ustawienia łączą się, dając większość tej samej kontroli:

Branża / dziedzina: Użyj categoryId, aby wskazać kategorię Azure Custom Translator wytrenowaną na twoim własnym korpusie — prawnym, technicznym, medycznym, marketingowym lub czymkolwiek innym. To najsilniejszy dźwignia dla brzmienia, stylu marki i słownictwa.
Tekst powierzchowny: Używaj Słowniczek do zablokowania nazw marek i terminów produktów dosłownie, a profanityAction do usuwania wulgarnych określeń przy lokalizacji dla młodszych odbiorców.

Wybierz swój język

Konfiguracja repozytorium

Schemat

Odniesienie terenowe

Kolejność załadunku

Ton i przemysł, w prostych słowach