Überschreiben Sie den Pfad mit dem configPath-Eingang, wenn Sie einen nicht standardmäßigen Standort benötigen.
Schema
# .github/resource-translator.ymlsourceLocale: entoLocales: - fr - de - esinclude: - "src/**/*.en.json" - "apps/**/*.en.resx"exclude: - "**/__tests__/**"glossary: Acme: Contoso Octocat: Octocat # keep brand names verbatim
# Domain / industry — uses an Azure Custom Translator category trained on# your tone and vocabulary. Leave unset for the general model.categoryId: my-custom-translator-category
# Translator request shape — most users can ignore these.textType: plain # plain | htmlprofanityAction: NoAction # NoAction | Marked | DeletedprofanityMarker: Asterisk # Asterisk | Tag (only when profanityAction == Marked)allowFallback: true # false fails when the categoryId has no deployment
apiVersion: "3.0"
# Resilience — Translator returns 429 under load. Defaults are usually# fine; tune only if your runs are large enough to hit them.maxRetries: 5retryBackoffMs: 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: truecustomPlaceholderPatterns: - "<<.+?>>" # 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
| Spielfeld | Typ | Anmerkungen |
|---|---|---|
sourceLocale | 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 | string[] | Entweder ein Array oder ein komma-getrennter String. |
include / exclude | string[] | Glob-Muster, bewertet anhand absoluter und workspace-relativer Pfade. |
glossary | map<string,string> | Überschreibungen nach der Übersetzung. Wortgrenzenbewusst (verwaltet C++, .NET). |
categoryId | string | Azure Custom Translator Kategorie – dein Branchen-/Domain-Regler (Recht, Medizin, Marketington usw.). Gesendet wie ?category=.... |
textType | "plain" | "html" | Standardmäßig plain. Verwenden Sie html nur, wenn Ihre Ressourcenwerte echte HTML-Fragmente enthalten. |
profanityAction | "NoAction" | "Marked" | "Deleted" | Wie man mit vulgären Begriffen in übersetzten Ausgaben umgeht. |
profanityMarker | "Asterisk" | "Tag" | Nur dann sinnvoll, wenn profanityAction "Marked" ist. |
allowFallback | 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 | string | Übersetzer REST API-Version. Standardmäßig 3.0. |
maxRetries | 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 | integer | Begrenzung (MS) für jeden einzelnen Backoff-Schlaf. Standardmäßig 30000. Azures Retry-After Header wird genau dann geehrt, wenn er vorhanden ist; ansonsten wird ein jitterer exponentieller Backoff verwendet, der auf diesen Wert begrenzt ist. |
protectPlaceholders | 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 | 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 | 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. |
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 Tonfall, 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.