See Enteekateeka for the YAML schema and loading order.
Ebikozesebwa ebyetaagisa
| Erinnya | Okunnyonnyola |
|---|---|
sourceLocale | Source locale (e.g. en) used to find resource files such as **/*.en.resx. Era yasindikibwa eri omuvvuunuzi nga from=<locale>. |
subscriptionKey | Azure AI Translator subscription key. Pass through secrets. |
endpoint | Translator endpoint URL, e.g. https://api.cognitive.microsofttranslator.com/. |
Common optional inputs
| Erinnya | Default | Okunnyonnyola |
|---|---|---|
region | Tewali | Translator resource region (omit for global resources). |
toLocales | Bonna bawagira | Ebifo by'okuvvuunula Mu ngeri y'emu, kiwandikawo ennamba ya JSON (["fr","de"]) oba emiwendo egy'enjawulo egy'enjawulo. |
include | Tewali | Newline-separated glob patterns; Ebiwandiiko ebikwatagana byokka bye bivvuunulwa. |
exclude | Tewali | Newline-separated glob patterns; matching files are skipped (applied after include). |
configPath | .github/resource-translator.yml | Mu ngeri y'emu, ekifaananyi ky' |
dryRun | false | Bw'true okuvvuunula n'okuvvuunula ebiwandiiko naye towandiika biwandiiko. |
failOnError | true | When true, unexpected errors fail the action; Bwe false, ensobi ziba kulabula. |
Translator request inputs
These map directly on Azure AI Translator v3 query parameters. Buli kimu kiba kya kusalawo; the Translator defaults apply when unset.
| Erinnya | Default | Okunnyonnyola |
|---|---|---|
categoryId | general | Azure Custom Translator category — the industry/domain/tone knob. Mu ngeri y'emu n'atuuka ku ntikko ng'?category=.... |
textType | plain | plain oba html. Use html only when your resource values are real HTML fragments. |
profanityAction | NoAction | NoAction, Marked, oba Deleted. Mu ngeri y'emu, Bayibuli eraga engeri ebigambo ebivvuunulwa gye bikozesebwa mu kuvvuunula. |
profanityMarker | Asterisk | Asterisk oba Tag. Kitegeeza nga profanityAction Marked. |
allowFallback | true (Translator default) | When false, Translator returns an error instead of falling back to the general system if your categoryId has no deployment for a target locale. |
apiVersion | 3.0 | Translator REST API version. |
Obugumiikiriza n'obukuumi bw'ebifo
These inputs control how the action behaves when Translator throttles your request and how it shields placeholder tokens like {{name}} or {0} from being mangled during translation.
| Erinnya | Default | Okunnyonnyola |
|---|---|---|
maxRetries | 5 | Maximum retry attempts on transient HTTP responses (408, 425, 429, 500, 502, 503, 504). Omuwendo gw'essimu za HTTP buli kusaba guli 1 + maxRetries. |
retryBackoffMs | 30000 | Cap (in milliseconds) on any single backoff sleep. Ekikolwa kino kiwa ekitiibwa omutwe gwa Azure's Retry-After response kyennyini nga kiriwo; otherwise it uses jittered exponential backoff capped at this value. |
protectPlaceholders | true | When true (default), placeholders such as {{name}}, ${var}, {0}, {0:N2}, %s, %1$s and HTML entities are replaced with sentinel tokens before translation and restored later. Disable only when your source intentionally contains literal placeholder-shaped text that should be translated. |
customPlaceholderPatterns | Tewali | Newline-separated regexes (without delimiters) added to the default placeholder set, e.g. <<.+?>> for custom token syntax. |
noTranslatePatterns | Tewali | Newline-divided glob patterns matched against parser-level keys (JSON dotted path, RESX name, PO msgid, XLIFF unit id, INI/restext key). Matching keys are dropped from the Translator request and pass through with their source value preserved. |
Ebivaamu
| Erinnya | Okunnyonnyola |
|---|---|
summary-title | Short PR-title-friendly summary, e.g. Machine-translated 320 files, a total of 5,418 translations. |
summary-details | Markdown summary suitable for a PR body or job summary. |
has-new-translations | 'true' lwe baafulumizibwa enkyusa emu oba okusingawo empya. |