Connecteur GitHub

Aperçu

Cette page illustre comment le connecteur GitHub est capable de surveiller et de créer des projets en fonction des modifications qui se produisent dans un ensemble de référentiels GitHub.

But général

Le connecteur GitHub surveille des fichiers spécifiques dans les référentiels GitHub, compte tenu d’un certain intervalle de temps. Habituellement dans les projets de localisation, les fichiers communs sont JSON, YML, XLIFF, XML, STRINGS ou tout autre format structuré et prévisible. En comparant le hachage de fichier à un référentiel de traductions précédemment exécutées pour ce même fichier, si une modification est détectée, un nouveau projet sera créé et les projets de traduction démarrent.

Stratégies de surveillance

Nous pouvons surveiller les référentiels GitHub à l’aide de son API REST. Pour ce faire, nos clients doivent autoriser un compte à créer un jeton dans Bureau Works pour accéder à l’API. Ces informations d’identification sont cryptées avec AES 256 et stockées dans le profil du Client.

Il existe deux stratégies de surveillance : les branches et les demandes de traction.

Branches

Le connecteur surveillera constamment une ou plusieurs succursales dans un ou plusieurs référentiels, et une fois que les fichiers observés sont modifiés, il créera un projet dans Bureau Works et en informera notre équipe. Dans les projets de localisation continue, toutes les chaînes précédemment traduites sont pleinement prises en compte.

Une fois qu’un projet est livré, le connecteur GitHub créera une demande de retrait pour une branche de correctif contenant le(s) fichier(s) une fois la traduction terminée. Nous pouvons personnaliser le chemin d’accès de sortie et les stratégies de nommage des fichiers de sortie. Cela crée un mécanisme de livraison non intrusif et très élégant quand une équipe a tendance à utiliser une ou quelques branches pour le développement.

Tirer les demandes

Tout comme la stratégie Branch, nous pouvons également surveiller les demandes de traction, pour les équipes utilisant Gitflow ou des flux de travail similaires. Le connecteur peut surveiller toutes les demandes de traction, pour toutes les branches, pour les mêmes fichiers configurés. Encore une fois, une fois qu’une différence est trouvée en fonction du hachage du fichier, un projet sera créé.

La grande différence avec cette stratégie est le mécanisme de livraison. Étant donné que les demandes de traction se réfèrent à une branche, une fois qu’un projet est livré, le connecteur crée un engagement dans la même branche que la demande d’extraction. Une fois que la demande de traction est acceptée et fusionnée, elle transportera le ou les fichiers traduits sur la ou les branches cibles, c’est-à-dire le maître, le développement, etc.

Autoriser les travaux de bureau

Pour configurer le connecteur GitHub, la première chose que vous devez faire est d’autoriser Bureau Works à accéder à vos référentiels. En tant que couche supplémentaire de sécurité, nous vous recommandons de créer un utilisateur qui aura un accès exclusif aux référentiels d’intérêt au sein de votre organisation.

Si vous ne pouvez pas voir le flux de travail d’autorisation GitHub, il se peut que les rôles appropriés ne soient pas appliqués à votre compte. S’il vous plaît contacter votre contact de l’organisation, ou si cette personne est vous, s’il vous plaît envoyez-nous un e-mail à [email protected].

1. Ouvrez mon compte dans le coin supérieur droit de votre vue Bureau Works.

2. Dans la barre supérieure, sélectionnez Connecter GitHub

3. Connectez-vous à GitHub à l’aide du compte que vous souhaitez connecter à Bureau Works.

4. GitHub vous renvoie à Bureau Works et affiche un message si l’authentification est réussie.

Fournir des voies de surveillance et de livraison

Une fois que vous avez autorisé Bureau Works, vous devez nous fournir des chemins de fichiers et de référentiels qui doivent être surveillés. Par exemple, dans les projets iOS, il est courant d’avoir un fichier appelé Localizable.strings déployé dans chaque dossier de langue, par exemple :

fr.lproj/Localizable.strings # Source
pt-BR.lproj/Localizable.strings # Target A
de.lproj/Localizable.strings # Target B
...

Nous devons déterminer lequel est le fichier source, et quelles sont les voies souhaitées pour livrer les traductions. Chaque livraison effectuée par le connecteur GitHub, selon la stratégie sélectionnée, placera les fichiers dans la structure de dossier correcte dans le référentiel GitHub.

Cette étape est réalisée par notre équipe, et est gérée par notre soutien à [email protected].

Sécurité et confidentialité

Chaque instance GitHub Connector est exclusive au client, elle s’exécute dans un conteneur distinct et ne peut accéder au jeton GitHub lié au profil du client dans Bureau Works. Une fois qu’un jeton est créé, il accordera bureau travaux acce/zooss aux dépôts publics et privés au sein de cette organisation, afin de créer correctement des demandes d’attraction et des engagements.

Notre équipe n’a pas accès au jeton chiffré et, par conséquent, nous ne pouvons pas accéder aux référentiels via API. Nous fournissons une piste d’audit détaillée pour l’utilisation, si nécessaire, et le système GitHub garde également une trace de l’utilisation du jeton.