See Configuration for the YAML schema and loading order.
Ibikoresho bikenewe
| Izina | Ibisobanuro |
|---|---|
sourceLocale | Source locale (e.g. en) used to find resource files such as **/*.en.resx. Yararungitswe kandi n'umuhinduzi nk'from=<locale>. |
subscriptionKey | Azure AI Translator subscription key. Pass via secrets. |
endpoint | URL y'iherezo ry'umuhinduzi, nk'akarorero https://api.cognitive.microsofttranslator.com/. |
Common optional inputs
| Izina | Default | Ibisobanuro |
|---|---|---|
region | Nta n'umwe | Translator resource region (omit for global resources). |
toLocales | Bose barashigikiye | Traduzione Yamagishi Yemera urupapuro rwa JSON (["fr","de"]) canke inyuguti zitandukanywa na koma. |
include | Nta n'umwe | Newline-separated glob patterns; Ibiharuro bihuza gusa ni vyo bihindurwa. |
exclude | Nta n'umwe | Newline-separated glob patterns; matching files are skipped (applied after include). |
configPath | .github/resource-translator.yml | Inzira ya YAML config file (ijanye n'umuzi w'akazi). |
dryRun | false | Mu gihe true, nuce uhindura ivyiyumviro vyawe n'ivyiyumviro vyawe, ariko ntuze wandike amadosiye. |
failOnError | true | Mu gihe true amakosa atari yitezwe; Mu gihe false, amakosa aba ari ingabisho. |
Translator request inputs
These map directly into Azure AI Translator v3 query parameters. Umwe wese ni we yihitiyemwo; the Translator defaults apply when unset.
| Izina | Default | Ibisobanuro |
|---|---|---|
categoryId | general | Azure Custom Translator category — the industry/domain/tone knob. Yoherejwe nk'uko ?category=.... |
textType | plain | plain canke html. Use html only when your resource values are real HTML fragments. |
profanityAction | NoAction | NoAction, Marked canke Deleted. Raba ingene amajambo y'urukozasoni akoreshwa mu majambo y'ubuhinduzi. |
profanityMarker | Asterisk | Asterisk canke Tag. Ni ikintu gihambaye gusa igihe profanityAction Marked. |
allowFallback | true (Translator default) | Mu gihe false, umuhinduzi asubiza ikosa aho gusubira muri sisitemu rusangi mu gihe categoryId yawe idafise ikibanza c'ihangiro. |
apiVersion | 3.0 | Translator REST API version. |
Resilience & placeholder protection
Ivyo vyinjizwa bigenzura ingene igikorwa gikora igihe Umuhinduzi ahagarika ubusabe bwawe n'ingene akingira ibimenyetso vy'ikibanza nka {{name}} canke {0} kugira ngo ntibibe mu gihe c'ubuhinduzi.
| Izina | Default | Ibisobanuro |
|---|---|---|
maxRetries | 5 | Maximum retry attempts on transient HTTP responses (408, 425, 429, 500, 502, 503, 504). Igitigiri c'abahamagara HTTP kuri buri musaba ni 1 + maxRetries. |
retryBackoffMs | 30000 | Cap (in milliseconds) on any single backoff sleep. Ico gikorwa giha icubahiro umutwe w'inyishu ya Retry-After wa Azure mu gihe kiriho; otherwise it uses jittered exponential backoff capped at this value. |
protectPlaceholders | true | Mu gihe true (default), placeholders nka {{name}}, ${var}, {0}, {0:N2}, %s, %1$s na HTML zisubirizwa n'ibimenyetso vya sentinel imbere yo guhindurwa hanyuma bigasubizwa nyuma. Disable only when your source intentionally contains literal placeholder-shaped text that should be translated. |
customPlaceholderPatterns | Nta n'umwe | Newline-separated regexes (without delimiters) yongerewe kuri placeholder set, nk'akarorero <<.+?>> ya syntaxe y'ibimenyetso bisanzwe. |
noTranslatePatterns | Nta n'umwe | Newline-separated glob patterns matched against parser-level keys (JSON dotted path, RESX name, PO msgid, XLIFF unit id, INI / restext key). Imfunguzo zihuza zikurwa ku busabe bw'umusemuzi hanyuma zigaca hamwe n'agaciro kazo k'inkomoko zibikwa. |
Ivyavuyemwo
| Izina | Ibisobanuro |
|---|---|
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' igihe hasohotse imwe canke nyinshi muri Bibiliya nshasha? |