Konfiguration · Ressourcenübersetzer

Überschreiben Sie den Pfad mit dem configPath-Eingang, wenn Sie einen nicht standardmäßigen Standort benötigen.

Schema

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

Feldreferenz

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

Fällt auf den sourceLocale Eingang zurück, wenn er nicht eingestellt ist. Außerdem wird es als from=<locale> an den Übersetzer weitergeleitet, damit kurze Zeichenketten nicht automatisch erkannt werden.

toLocales

Typ: string[]

Entweder ein Array oder ein komma-getrennter String.

include / exclude

Typ: string[]

Glob-Muster, bewertet anhand absoluter und workspace-relativer Pfade.

glossary

Typ: map<string,string>

Überschreibungen nach der Übersetzung. Wortgrenzenbewusst (verwaltet C++, .NET).

categoryId

Typ: string

Azure Custom Translator Kategorie – dein Branchen-/Domain-Regler (Recht, Medizin, Marketington usw.). Gesendet wie ?category=....

textType

Typ: "plain" | "html"

Standardmäßig plain. Verwenden Sie html nur, wenn Ihre Ressourcenwerte echte HTML-Fragmente enthalten.

profanityAction

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

Wie man mit vulgären Begriffen in übersetzten Ausgaben umgeht.

profanityMarker

Typ: "Asterisk" | "Tag"

Nur dann sinnvoll, wenn profanityAction "Marked" ist.

allowFallback

Typ: boolean

Stelle false ein, dass die Übersetzung fehlschlägt, wenn dein categoryId keine Bereitstellung für ein Zielgebiet hat, anstatt auf das allgemeine Modell zurückzufallen.

apiVersion

Typ: string

Übersetzer REST API-Version. Standardmäßig 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

Maximale Wiederholungsversuche bei transienten HTTP-Antworten (408, 425, 429, 500, 502, 503, 504). Standardmäßig 5. Die Gesamtzahl der HTTP-Anrufe pro Anfrage beträgt 1 + maxRetries.

retryBackoffMs

Typ: integer

Begrenzung (MS) für jeden einzelnen Backoff-Schlaf. Standardmäßig 30000. Azures Retry-After Header wird genau dann geachtet, wenn er vorhanden ist; ansonsten wird ein jitterer exponentieller Backoff verwendet, der auf diesen Wert begrenzt ist.

protectPlaceholders

Typ: boolean

Standardmäßig true. Wenn sie aktiviert sind, werden Token wie {{name}}, ${var}, {0}, {0:N2}, %s, %1$s und HTML-Entitäten vor der Übersetzung durch Sentinel-Tokens ersetzt und danach wiederhergestellt. Deaktivieren Sie nur, wenn der Quellcode absichtlich platzhalterförmige Literals enthält.

customPlaceholderPatterns

Typ: string[]

Zusätzliche Regex-Muster (ohne Trennzeichen), die dem Standard-Platzhaltersatz hinzugefügt wurden, z. B. <<.+?>> für benutzerdefinierte Token-Syntax. Ungültige Regexes werden ignoriert.

noTranslatePatterns

Typ: string[]

Glob-Muster wurden mit Parser-Level-Tasten abgeglichener (JSON-Punktpfad, RESX name, PO msgid, XLIFF-Einheit id, INI/Restext-Tast). Übereinstimmende Schlüssel werden aus der Anfrage entfernt und mit erhaltenem Quellwert weitergegeben.

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.

Ladereihenfolge

Die Aktion liest explizite Eingaben aus dem Workflow aus.
Es lädt die YAML-Konfiguration von configPath.
Für jedes geteilte Feld gewinnt die Eingabe; ansonsten wird der YAML-Wert verwendet.
Die zusammengeführten Werte werden validiert. Ungültige Enums (z. B. profanityAction: Mask) führen dazu, dass die Aktion schnell mit einer klaren Nachricht fehlschlägt.

Ton und Branche, ganz klar

Die Azure AI Translator v3 API besitzt keinen einzigen Tonknopf. Zwei Einstellungen vereinen sich, sodass man größtenteils die gleiche Kontrolle hat:

Branche / Bereich: Nutzen Sie categoryId, um auf eine Azure Custom Translator Kategorie zu verweisen, die auf Ihrem eigenen Korpus trainiert ist – rechtlich, technisch, medizinisch, Marketing oder sonst etwas. Das ist der stärkste Hebel für Ton, Markenstimme und Wortschatz.
Oberflächentext: Nutzen Sie das Glossar, um Markennamen und Produktbegriffe wortwörtlich zu versperren, und verwenden Sie profanityAction, um vulane Begriffe zu entfernen, wenn Sie auf Lokalisierungen für jüngere Zielgruppen abzielen.

Wähle deine Sprache

Repository-Konfiguration

Schema

Feldreferenz

Ladereihenfolge

Ton und Branche, ganz klar