Astuce
Pour plus d'informations sur l'intégration GitHub dans Phrase TMS, reportez-vous à GitHub (TMS).
Phrase Strings s'intègre aux référentiels GitHub pour synchroniser les fichiers de localisation entre Phrase et GitHub.
Par défaut, les référentiels sont connectés à l'aide d'une application GitHub OAuth. Les jetons d'accès personnels sont également pris en charge et sont principalement destinés aux instances auto-hébergées ou aux environnements où l'installation d'une application OAuth n'est pas possible.
Prérequis
-
Le fichier de configuration
.phrase.ymldoit être présent à la racine de la branche à surveiller. Le fichier définit les fichiers à importer (pull) ou exporter (push) depuis le référentiel. -
Les droits de lecture et d'écriture sur le référentiel sont requis.
-
Des fichiers de configuration mal définis peuvent entraîner des erreurs. Assurez-vous que le fichier contient au moins une cible push et une cible pull, des formats de fichiers corrects et le bon réglage du paramètre
update_translations. -
-
L'application GitHub OAuth doit être installée dans l'organisation ou le compte GitHub qui possède le référentiel.
-
Le référentiel doit être inclus dans l'installation de l'application OAuth.
-
Des autorisations pour installer ou autoriser les applications GitHub sont requises dans l'organisation ou le compte cible.
-
-
-
Jetons classiques
Nécessite la portée repo (
public_repoen cas de synchronisation avec un référentiel public) -
Jetons affinés
Nécessite les autorisations suivantes :
-
Contenu : Lecture et écriture
-
Demandes de tirage : Lecture et écriture
-
-
Assurez-vous que les paramètres du référentiel ne nécessitent pas de validations signées.
-
-
Si SSO est activé dans GitHub, il doit également l’être pour le jeton d'accès.
-
La branche phrase_translations ne peut pas être protégée.
Note
En raison des améliorations continues, l'interface utilisateur peut ne pas être exactement la même que celle présentée dans la vidéo.
Une fois le fichier de configuration en place, pour connecter un référentiel, suivez ces étapes :
-
Depuis la page , faites défiler vers le bas jusqu'à et cliquez sur Configure.
La page s'ouvre.
-
Cliquez sur Add Sync/GitHub.
La fenêtre des paramètres s'ouvre.
-
Sélectionner un projet dans la liste déroulante.
-
Sélectionner la méthode d'authentification :
-
Si l'application GitHub n'est pas encore installée, cliquez sur Authenticate. L'authentification est effectuée une fois et peut être réutilisée pour plusieurs synchronisations de référentiel.
Si l'application GitHub est déjà installée, cliquez sur Manage installation pour Terminer l'installation de l'application pour l'organisation ou le compte cible. L'accès au référentiel est géré au niveau de l'organisation ou du compte et n'est pas lié à un utilisateur GitHub individuel.
-
Fournissez un personnel avec une portée API.
Lors de l'utilisation d'un jeton d'accès personnel, l'accès au référentiel dépend de l'utilisateur GitHub qui a créé le jeton.
-
Fournissez le auto-hébergé de GitHub et un personnel avec une portée API.
-
-
Sélectionner un dans la liste déroulante.
-
Sélectionner une dans la liste déroulante pour importer (push) et exporter (pull). Il s'agit généralement de la branche master.
-
Optionnellement, fournissez un nom de branche pour la demande de tirage (pull request). Si laissé vide, une branche sera créée avec la valeur par défaut .
-
Cliquez sur Validate Configuration pour vous assurer que les paramètres d'authentification et le fichier de configuration sont corrects.
-
Sélectionnez éventuellement une option pour déterminer quand les fichiers nouveaux ou mis à jour sont automatiquement importés dans le projet.
-
Cliquez sur Enregistrer.
Le projet est maintenant connecté au référentiel GitHub sélectionné et ajouté à la liste.
-
(Facultatif) Cliquez sur l'icône crayon pour renommer l'intégration.
Assurez-vous que les commandes push sont correctement configurées dans le fichier de configuration .phrase.yml. Les options de push sont les mêmes que pour le point de terminaison de l'API téléchargements.
Pour importer des fichiers :
-
Depuis la page , sélectionnez un projet et cliquez sur importer
.
Les fichiers de langue (définis comme entrées de source push dans le fichier de configuration) sont importés dans le projet.
Un paramètre linguistique par défaut doit être présent.
Remarque
En cas de problème lors de l'importation, utilisez le client CLI pour tester le fichier de configuration
.phrase.ymllocalement et vérifier s'il y a des messages d'erreur.Si nécessaire, contactez le support technique de Phrase et joignez le fichier de configuration
.phrase.ymlà la demande d'assistance.
Assurez-vous que les commandes push sont correctement configurées dans le fichier de configuration .phrase.yml. Les options de pull (par ex. le paramètre include_empty_translations) sont les mêmes que pour le point de terminaison de l'API téléchargement de paramètres linguistiques.
Pour exporter des fichiers :
-
Depuis la page , sélectionnez un projet et cliquez sur Exporter
.
La fenêtre s'affiche.
-
Indiquez la branche cible dans le champ .
Les fichiers les plus récents du référentiel seront exportés sous forme de nouvelle demande de tirage (pull request) vers la branche souhaitée.
-
Une fois les fichiers exportés, la demande de tirage peut être fusionnée ou fermée dans le référentiel et la branche peut être supprimée.
Note
En cas de problème lors de l'exportation, utiliser le client CLI pour tester le fichier de configuration .phrase.yml localement et vérifier les éventuels messages d'erreur.
Si nécessaire, contactez le support technique de Phrase et joignez le fichier de configuration .phrase.yml à la demande d'assistance.
Les synchronisations de référentiel conservent un historique des derniers imports et exports pour chaque projet Phrase Strings.
Pour afficher l'historique :