Entrées et sorties · Relais de ressources

Voir Configuration pour le schéma YAML et l’ordre de chargement.

Entrées requises

sourceLocale

Localisation source (par exemple en) utilisée pour trouver des fichiers de ressources tels que **/*.en.resx. Également transmis au prestataire en tant que from=<locale>.

Choix du fournisseur et accréditations

Choisissez un fournisseur par course avec provider. Fournissez uniquement les identifiants du fournisseur sélectionné — consultez le guide Entrées et sorties pour la configuration complète.

provider

Par défaut: azure

Fournisseur de traduction : azure (par défaut), aws ou google. Un seul fournisseur est utilisé par appel d’action.

subscriptionKey

Par défaut: aucun

Clé d’abonnement Azure AI Translator. Obligatoire pour azure. Passe par secrets.

endpoint

Par défaut: aucun

URL de terminaison Azure Translator, par exemple https://api.cognitive.microsofttranslator.com/. Obligatoire pour azure.

awsAccessKeyId

Par défaut: aucun

ID clé d’accès AWS. Optionnel — omettre (avec awsSecretAccessKey) d’utiliser la chaîne d’identifiants par défaut AWS / OIDC. Passe par secrets.

awsSecretAccessKey

Par défaut: aucun

Clé d’accès secrète AWS. Doit être fourni avec awsAccessKeyId. Passe par secrets.

awsSessionToken

Par défaut: aucun

Token de session AWS optionnel pour les identifiants temporaires. Passe par secrets.

awsRegion

Par défaut: aucun

AWS pour le service Translate (par exemple us-east-1). Obligatoire pour aws sauf AWS_REGION est situé dans l’environnement.

awsFormality

Par défaut: aucun

AWS Translate formality setting: FORMAL or INFORMAL.

awsBrevity

Par défaut: aucun

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

awsTerminologyNames

Par défaut: aucun

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

awsParallelDataNames

Par défaut: aucun

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

googleApiKey

Par défaut: aucun

Clé API Google Cloud. Fournissez ce googleCredentials de bloc opératoire pour google. Passe par secrets.

googleCredentials

Par défaut: aucun

Clé de compte de service Google Cloud en chaîne JSON. Fournissez ce googleApiKey de bloc opératoire pour google. Passe par secrets.

googleProjectId

Par défaut: aucun

ID de projet Google Cloud optionnel. Généralement déduit de l’accréditation du compte de service.

googleModel

Par défaut: aucun

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

googleApiEndpoint

Par défaut: aucun

Optional Google Cloud Translation API endpoint override.

googleAutoRetry

Par défaut: aucun

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

Entrées optionnelles courantes

region

Par défaut: aucun

Région de ressources traductrices (omettre les ressources globales).

toLocales

Par défaut: tous supportés

Des lieux où se traduire. Accepte un tableau JSON (["fr","de"]) ou des valeurs séparées par virgules.

include

Par défaut: aucun

Motifs de globules séparés par la ligne newline ; seuls les fichiers correspondants sont traduits.

exclude

Par défaut: aucun

Motifs de globules séparés par la ligne newline ; Les fichiers correspondants sont ignorés (appliqués après inclusion).

configPath

Par défaut: .github/resource-translator.yml

Chemin vers le fichier de configuration YAML (par rapport à la racine de l’espace de travail).

changeDetection

Par défaut: 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

Par défaut: .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

Par défaut: 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

Par défaut: false

Lorsque true, exécutez des traductions et émettez des résumés mais n’écrivez pas de fichiers.

failOnError

Par défaut: true

Lorsqu’true, des erreurs inattendues font échouer l’action ; Quand false, les erreurs sont des avertissements.

Entrées de requête Azure Translator

Ces éléments correspondent directement aux paramètres de requête Azure AI Translator v3 et s’appliquent au fournisseur Azure. textType et profanityAction sont également mappés sur AWS/Google où un équivalent existe (voir le guide des fournisseurs) ; les autres sont uniquement Azure. Chacune est optionnelle ; les paramètres par défaut du traducteur s’appliquent lorsqu’ils sont désactivés.

categoryId

Par défaut: general

Azure Custom Translator catégorie — le bouton industrie/domaine/tonalité. Transmis comme ?category=....

textType

Par défaut: plain

plain ou html. Utilisez html uniquement lorsque vos valeurs de ressources sont de vrais fragments HTML.

profanityAction

Par défaut: NoAction

NoAction, Marked ou Deleted. Contrôle la manière dont les termes profanes sont émis dans les traductions.

profanityMarker

Par défaut: Asterisk

Asterisk ou Tag. Que profanityAction est significatif quand c’est Marked.

allowFallback

Par défaut: true (par défaut du traducteur)

Quand false, le traducteur renvoie une erreur au lieu de revenir au système général si votre categoryId n’a pas de déploiement pour un lieu cible.

apiVersion

Par défaut: 3.0

Version de l’API REST du traducteur.

Résilience et protection provisoire

Ces entrées contrôlent le comportement de l’action lorsque Traducteur limite votre requête et comment il protège des jetons provisoires comme {{name}} ou {0} contre la déformation lors de la traduction.

maxRetries

Par défaut: 5

Tentatives maximales sur les réponses HTTP transitoires (408, 425, 429, 500, 502, 503, 504). Le nombre total d’appels HTTP par requête est 1 + maxRetries.

retryBackoffMs

Par défaut: 30000

Limitez (en millisecondes) à chaque sommeil de recul. L’action honore l’en-tête de réponse Retry-After d’Azure exactement lorsqu’il est présent ; sinon, elle utilise un backoff exponentiel gigoté plafonné à cette valeur.

protectPlaceholders

Par défaut: true

Lorsque true (par défaut), les espaces réservés tels que {{name}}, ${var}, {0}, {0:N2}, %s, %1$s et HTML sont remplacés par des jetons sentinelle avant la traduction et restaurés ensuite. Désactivez seulement lorsque votre source contient intentionnellement un texte en forme de substitut qui doit être traduit.

customPlaceholderPatterns

Par défaut: aucun

Des régex séparés par une nouvelle ligne (sans délimiteurs) ajoutés à l’ensemble de substituts par défaut, par exemple <<.+?>> pour une syntaxe personnalisée des jetons.

noTranslatePatterns

Par défaut: aucun

Les motifs de globules séparés par nouvelle ligne correspondaient aux clés de niveau analyseur (chemin pointillé JSON, name RESX, msgid PO, unité XLIFF id, clé INI/restext). Les clés correspondantes sont supprimées de la requête Traducteur et passent en conservant leur valeur source.

Sorties

summary-title

Résumé bref adapté aux titres de relations publiques, par exemple Machine-translated 320 files, a total of 5,418 translations.

summary-details

Résumé à prix réduit adapté à un organisme de relations publiques ou un résumé de poste.

has-new-translations

'true' lorsqu’une ou plusieurs nouvelles traductions étaient générées.