Ein- und Ausgänge · Ressourcenübersetzer

Siehe Konfiguration für das YAML-Schema und die Ladereihenfolge.

Erforderliche Eingaben

sourceLocale

Quellstandort (z. B. en), der verwendet wird, um Ressourcendateien wie **/*.en.resx zu finden. Auch an den Anbieter weitergeleitet als from=<locale>.

Anbieterauswahl und Qualifikationen

Wählen Sie pro Durchlauf mit provider einen Anbieter. Geben Sie nur die Zugangsdaten des ausgewählten Anbieters an – siehe die Ein- und Ausgänge-Anleitung für die vollständige Einrichtung.

provider

Default: azure

Übersetzungsanbieter: azure (Standard), aws oder google. Pro Aktionsaufruf wird nur ein Anbieter verwendet.

subscriptionKey

Default: Keine

Azure AI Translator Subscription Key. Erforderlich für azure. Fahren Sie über secrets.

endpoint

Default: Keine

Azure Translator Endpunkt URL, z. B. https://api.cognitive.microsofttranslator.com/. Erforderlich für azure.

awsAccessKeyId

Default: Keine

AWS-Zugangsschlüssel-ID. Optional – verzichte (mit awsSecretAccessKey) auf die AWS-Standard-Zugangsdatenkette / OIDC. Fahren Sie über secrets.

awsSecretAccessKey

Default: Keine

AWS-Geheimzugangsschlüssel. Muss zusammen mit awsAccessKeyId geliefert werden. Fahren Sie über secrets.

awsSessionToken

Default: Keine

Optionaler AWS-Sitzungstoken für temporäre Zugangsdaten. Fahren Sie über secrets.

awsRegion

Default: Keine

AWS-Region für den Translate-Dienst (z. B. us-east-1). Für aws erforderlich, es sei denn, AWS_REGION befindet sich in der Umgebung.

awsFormality

Default: Keine

AWS Translate formality setting: FORMAL or INFORMAL.

awsBrevity

Default: Keine

When true, enables AWS Translate brevity mode for supported language pairs.

awsTerminologyNames

Default: Keine

AWS Translate custom terminology resource names. Accepts a JSON array or comma-separated values.

awsParallelDataNames

Default: Keine

AWS Translate parallel data resource names. Accepts a JSON array or comma-separated values.

googleApiKey

Default: Keine

Google Cloud API-Schlüssel. Stellen Sie diesen OR googleCredentials für google bereit. Fahren Sie über secrets.

googleCredentials

Default: Keine

Google Cloud Service-Account Key als JSON-String. Stellen Sie diesen OR googleApiKey für google bereit. Fahren Sie über secrets.

googleProjectId

Default: Keine

Optionale Google Cloud Projekt-ID. Das wird meist aus dem Service-Account-Zugang abgeleitet.

googleModel

Default: Keine

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

googleApiEndpoint

Default: Keine

Optional Google Cloud Translation API endpoint override.

googleAutoRetry

Default: Keine

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

Gängige optionale Eingänge

region

Default: Keine

Übersetzer-Ressourcenregion (für globale Ressourcen weggelassen).

toLocales

Default: alle unterstützten

Orte zum Übersetzen. Akzeptiert ein JSON-Array (["fr","de"]) oder kommagetrennte Werte.

include

Default: Keine

Newline-separierte Glob-Muster; nur passende Dateien werden übersetzt.

exclude

Default: Keine

Newline-separierte Glob-Muster; Matching-Dateien werden übersprungen (nach Include angewendet).

configPath

Default: .github/resource-translator.yml

Pfad zur YAML-Konfigurationsdatei (relativ zum Workspace-Root).

changeDetection

Default: smart

Smart change detection mode. smart translates only keys whose source value, target presence, state entry, or translation-affecting settings require it. Use disabled or false to send every eligible key on every run.

statePath

Default: .github/resource-translator-state.json

Path to the compact deterministic smart change-detection state manifest. Defaults to .github/resource-translator-state.json; commit it so future runs can audit and reuse unchanged translations.

snapshotOnly

Default: false

When true, create/update the smart change-detection manifest from existing source and target files without calling a translation provider or writing target resource files. Useful when bootstrapping statePath while a provider is unavailable.

dryRun

Default: false

Wenn true, führen Sie Übersetzungen aus und senden Sie Zusammenfassungen, aber schreiben Sie keine Dateien.

failOnError

Default: true

Wenn true, scheitern unerwartete Fehler an der Aktion; Wenn false, sind Fehler Warnungen.

Azure Translator request inputs

Diese werden direkt auf Azure AI Translator v3 Abfrageparameter abgebildet und gelten für den Azure-Provider. textType und ProfanityAction werden ebenfalls auf AWS/Google abgebildet, wo ein entsprechendes Pendant existiert (siehe den Anbieter-Leitfaden); der Rest ist nur für Azure verfügbar. Jede einzelne ist optional; die Übersetzer-Standardeinstellungen gelten, wenn sie nicht gesetzt werden.

categoryId

Default: general

Azure Custom Translator Kategorie – der Industrie-/Domänen-/Ton-Knopf. Weitergeleitet wie ?category=....

textType

Default: plain

plain oder html. Verwenden Sie html nur, wenn Ihre Ressourcenwerte echte HTML-Fragmente sind.

profanityAction

Default: NoAction

NoAction, Marked oder Deleted. Kontrolliert, wie vulgäre Begriffe in Übersetzungen verwendet werden.

profanityMarker

Default: Asterisk

Asterisk oder Tag. Nur dann sinnvoll, wenn profanityAction Marked ist.

allowFallback

Default: true (Übersetzer-Standard)

Wenn false, gibt der Übersetzer einen Fehler zurück, anstatt auf das allgemeine System zurückzugreifen, falls Ihr categoryId keine Bereitstellung für einen Zielort hat.

apiVersion

Default: 3.0

Übersetzer REST API-Version.

Resilienz und Platzhalterschutz

Diese Eingaben steuern, wie sich die Aktion verhält, wenn der Übersetzer deine Anfrage drosselt, und wie sie Platzhalter-Token wie {{name}} oder {0} davor schützt, während der Übersetzung beschädigt zu werden.

maxRetries

Default: 5

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

retryBackoffMs

Default: 30000

Begrenzt (in Millisekunden) für jeden einzelnen Backoff-Schlaf. Die Aktion respektiert Azures Retry-After Response-Header genau, wenn er vorhanden ist; ansonsten verwendet es gejitterte, exponentielle Backoff-Effekte, begrenzt auf diesen Wert.

protectPlaceholders

Default: true

Wenn true (Standard), werden Platzhalter wie {{name}}, ${var}, {0}, {0:N2}, %s, %1$s und HTML-Entitäten vor der Übersetzung durch Sentinel-Tokens ersetzt und danach wiederhergestellt. Deaktiviere nur, wenn deine Quelle absichtlich wörtlich platzhalterförmigen Text enthält, der übersetzt werden sollte.

customPlaceholderPatterns

Default: Keine

Zeilen-getrennte Regexes (ohne Trennzeichen), die zum Standard-Platzhaltersatz hinzugefügt wurden, z. B. <<.+?>> für benutzerdefinierte Token-Syntax.

noTranslatePatterns

Default: Keine

Newline-getrennte Glob-Muster, die mit Parser-Level-Schlüsseln abgeglichen werden (JSON-Punktpfad, RESX name, PO msgid, XLIFF-Einheit id, INI/Restext-Tast). Passende Schlüssel werden aus der Übersetzeranfrage entfernt und mit erhaltenem Quellwert weitergeleitet.

Ausgaben

summary-title

Kurze, PR-titelfreundliche Zusammenfassung, z. B. Machine-translated 320 files, a total of 5,418 translations.

summary-details

Markdown-Zusammenfassung, geeignet für einen PR-Gremium oder eine Jobübersicht.

has-new-translations

'true', wenn eine oder mehrere neue Übersetzungen erstellt wurden.