Intégrations
    1. Phrase
    2. Phrase Strings
    3. Intégrations

    GitHub (Strings)

    Le contenu est traduit de l’anglais par Phrase Language AI.

    Astuce

    Pour plus d'informations sur l'intégration de GitHub dans Phrase TMS, consultez GitHub (TMS).

    Phrase Strings s'intègre aux dépôts GitHub pour synchroniser les fichiers de localisation entre Phrase et GitHub.

    Par défaut, les dépôts 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 .phrase.yml configuration doit ê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.

    • Application GitHub OAuth :

      • L'application GitHub OAuth doit être installée dans l'organisation ou le compte GitHub qui possède le dépôt.

      • Le dépôt 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.

      • Prend en charge la connexion d'un compte Strings à plusieurs organisations GitHub. Sélectionnez l'organisation GitHub à synchroniser dans la configuration de l'intégration. Il n'y a pas de limite stricte quant au nombre d'organisations pouvant être connectées.

    • Jeton d'accès GitHub :

      • Jetons classiques

        Nécessite la portée repo (public_repo en cas de synchronisation avec un dépôt 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.

    Connecter des dépôts

    Une fois le fichier de configuration en place, pour connecter un dépôt, suivez ces étapes :

    1. Dans la navigation principale, cliquez sur Automations, puis sur Repo Syncs.

      Alternativement, depuis la page Integrations, faites défiler jusqu'à Repo Sync et cliquez sur Configure.

      La page Repo Syncs s'ouvre. La liste Repo Syncs affiche uniquement les projets auxquels l'utilisateur qui consulte a accès.

    2. Cliquez sur Add Sync/GitHub.

      La fenêtre des paramètres GitHub sync s'ouvre.

    3. Sélectionnez un projet dans la liste déroulante.

    4. Sélectionnez la méthode d'authentification :

      • Github App (recommandé)

        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 dépôts.

        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 dépôt est géré au niveau de l'organisation ou du compte et n'est pas lié à un utilisateur GitHub individuel.

      • Jeton d'accès personnel

        Fournissez un Repo access token personnel avec une portée API.

        Lors de l'utilisation d'un jeton d'accès personnel, l'accès au dépôt dépend de l'utilisateur GitHub qui a créé le jeton.

      • Instance auto-hébergée

        Fournissez le API endpoint auto-hébergé de GitHub et un Repo access token personnel avec une portée API.

      Si le dépôt cible nécessite des commits vérifiés (signés), la méthode d'authentification par application GitHub doit être utilisée. Les commits poussés à l'aide d'un jeton d'accès personnel ne sont pas signés, la synchronisation échoue donc avec l'erreur suivante : « Le dépôt exige des commits vérifiés (signés). »

    5. Si l'application GitHub est utilisée, sélectionnez Connected GitHub organization dans la liste déroulante. La liste des dépôts se charge en fonction de cette sélection.

    6. Sélectionnez un GitHub repository dans la liste déroulante.

    7. Sélectionnez une Repository branch dans la liste déroulante pour importer (push) et exporter (pull) à partir de celle-ci. Il s'agit généralement de la branche master.

    8. Indiquez éventuellement un nom de branche pour la pull request. Si vous laissez ce champ vide, une branche sera créée avec la valeur par défaut phrase-translations.

    9. Indiquez éventuellement un Commit title personnalisé pour la pull request, jusqu'à 72 caractères.

      Laisser le champ vide conserve le message par défaut, Updated translations from Phrase. Une fois défini, le titre personnalisé remplace le message de commit et le titre de la pull request par défaut à chaque exportation.

    10. Cliquez sur Validate Configuration pour vous assurer que les paramètres d'authentification et le fichier de configuration sont corrects.

    11. Sélectionnez éventuellement une option Import behavior pour déterminer quand les fichiers nouveaux ou mis à jour sont automatiquement importés dans le projet.

    12. Cliquez sur Enregistrer.

      Le projet est maintenant connecté au dépôt GitHub sélectionné et ajouté à la liste.

    13. (Facultatif) Cliquez sur pencil icon pour renommer l'intégration.

    L'application GitHub de Phrase ne prend actuellement pas en charge la liste d'autorisation IP. Si une organisation GitHub a une liste d'autorisation IP activée avec le paramètre « Enable IP allow list configuration for installed GitHub Apps » activé, GitHub bloque l'application GitHub de Phrase, ce qui entraîne une liste déroulante de dépôts vide et des échecs d'exportation. Comme solution de contournement, ajoutez les adresses IP de sortie de Phrase à la liste d'autorisation de l'organisation. Consultez l'article Phrase Servers IP Addresses pour obtenir la liste actuelle des adresses à ajouter à la liste d'autorisation.

    Importer des fichiers

    Assurez-vous que les commandes push sont correctement configurées dans le fichier .phrase.yml configuration. Les options de push sont les mêmes que pour le point de terminaison d'API uploads.

    Pour importer des fichiers :

    • Depuis la page Repo Syncs, sélectionnez un projet et cliquez sur Import Sync Import.

      Les fichiers de langue (définis comme entrées de source push dans le fichier de configuration) sont importés dans le projet.

      Une locale par défaut doit être présente.

      Remarque

      En cas de problème lors de l'importation, utilisez le client CLI pour tester localement le fichier de configuration .phrase.yml 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 de support.

    Exporter des fichiers

    Assurez-vous que les commandes pull sont correctement configurées dans le fichier .phrase.yml configuration. Les options de pull (par ex. le paramètre include_empty_translations) sont les mêmes que pour le point de terminaison d'API locales download.

    Pour exporter des fichiers :

    1. Depuis la page Repo Syncs, sélectionnez un projet et cliquez sur Export Sync Export.

      La fenêtre Export s'affiche.

    2. Indiquez la branche cible dans le champ PR branch.

      Les fichiers les plus récents du dépôt seront exportés sous forme de nouvelle demande de tirage (pull request) vers la branche souhaitée.

    3. Une fois les fichiers exportés, la demande de tirage peut être fusionnée ou fermée dans le dépôt et la branche peut être supprimée.

    Note

    En cas de problème lors de l'exportation, utilisez le client CLI pour tester localement le fichier de configuration .phrase.yml 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 de support.

    Historique

    Les synchronisations de dépôt conservent un historique des dernières importations et exportations pour chaque projet Phrase Strings.

    Pour afficher l'historique :

    • Depuis la page Repo Syncs, sélectionnez un projet et cliquez sur History Sync History.

      L'historique d'importation et d'exportation du projet est présenté. Les entrées d'exportation dans l'historique incluent un lien vers la demande de fusion correspondante.

    Cet article vous a-t-il été utile ?
    ★ ★ ★ ★ ★

    Sorry about that! In what way was it not helpful?

    The article didn’t address my problem.
    I couldn’t understand the article.
    The feature doesn’t do what I need.
    Other reason.

    Note that feedback is provided anonymously so we aren't able to reply to questions.
    If you'd like to ask a question, submit a request to our Support team.
    Thank you for your feedback.