Configurer les paramètres de contrôle des versions d'un projet

Cette page explique comment configurer des éléments de votre projet afin de les intégrer à Git pour le contrôle des versions.

Paramètres du projet

Vous devez être un administrateur Looker pour modifier les options sur la page Paramètres du projet. Les développeurs Looker qui ne sont pas administrateurs peuvent consulter la page Paramètres du projet, mais ne peuvent pas y modifier les options.

La page Paramètres du projet contient des options de configuration pour votre projet. Pour afficher cette page, ouvrez votre projet et sélectionnez l'icône Paramètres dans le menu des icônes situé à gauche.

Vous pouvez alors accéder à trois sections:

Configuration

Dans l'onglet Configuration de la page Paramètres des projets, vous pouvez configurer les paramètres suivants:

  • Nom: nom de votre projet. Vous pouvez renommer votre projet en modifiant le texte et en cliquant sur le bouton Enregistrer la configuration du projet. Pour en savoir plus, consultez la page de documentation Accéder aux informations d'un projet et les modifier.

  • Git Production Branch Name (Nom de la branche de production Git) : spécifiez le nom de la branche Git à utiliser comme cible de fusion pour les branches de développement de votre projet. La branche Git doit exister dans votre dépôt Git. Pour en savoir plus, consultez la section Nom de la branche de production Git sur cette page.

  • Qualité du code: détermine si les développeurs doivent exécuter correctement l'outil de validation LookML sur le projet avant de valider des modifications dans celui-ci. La qualité du code offre les options suivantes:

    • Exiger la correction des erreurs et des avertissements avant la validation: les développeurs Looker ne peuvent valider les modifications qu'après avoir exécuté correctement le validateur LookML et résolu toutes les erreurs et tous les avertissements. Il s'agit de la configuration recommandée.
    • Exiger la correction des erreurs uniquement avant la validation: les développeurs Looker ne peuvent valider les modifications qu'après avoir exécuté correctement le validateur LookML et résolu toutes les erreurs. Les développeurs peuvent valider les modifications lorsque des avertissements s'affichent. Bien qu'elle ne soit pas recommandée, cette option peut s'avérer utile, par exemple, si de nouveaux avertissements sont introduits pour le fonctionnement de LookML après une mise à jour de Looker.
    • Autoriser la validation du code cassé: les développeurs Looker peuvent valider des modifications sans exécuter l'outil de validation LookML, et ce, qu'il existe ou non des erreurs ou des avertissements dans le code LookML. Cette option n'est pas recommandée, car elle peut entraîner un dysfonctionnement de LookML ou des résultats erronés.

  • Exiger la réussite des tests de données avant de déployer ce projet en production: si le projet LookML comporte un ou plusieurs paramètres test, cette option oblige les développeurs à exécuter les tests de données avant de déployer toute modification. Si les tests de données réussissent, l'IDE permettra au développeur de déployer les modifications en production. Consultez la page de documentation du paramètre test pour en savoir plus sur la configuration de tests de données dans votre projet LookML. Consultez la page de documentation Utiliser le contrôle des versions et le déploiement pour en savoir plus sur l'exécution de tests de données dans votre projet. Par défaut, l'option Exiger la réussite des tests de données avant de déployer ce projet en production est activée pour les nouveaux projets LookML.

  • Git Integration (Intégration Git) : spécifie les niveaux d'intégration avec votre fournisseur Git. Pour en savoir plus, consultez les options d'intégration Git.

  • Activer le mode Déploiement avancé: paramètre qui, s'il est activé, permet aux utilisateurs de déployer n'importe quel SHA, tag ou branche en production. Consultez la page de documentation Mode de déploiement avancé pour en savoir plus sur l'utilisation du contrôle des versions avec le mode de déploiement avancé activé.

  • Webhook Deploy Secret: configure l'authentification pour le déploiement des modifications en production sur votre instance Looker. Pour en savoir plus, consultez la page de documentation Configurer le secret de déploiement du webhook.

  • Réinitialiser la connexion Git: ce bouton ouvre la fenêtre Configurer Git, dans laquelle vous pouvez mettre à jour les paramètres de connexion de votre dépôt Git.

    La réinitialisation de votre connexion Git préserve l'historique Git pour la branche principale. Il conservera également l'historique de la branche personnelle de chaque développeur Looker une fois qu'il aura synchronisé son mode développeur. Pour conserver l'historique de toutes les branches, consultez la page des bonnes pratiques Migrer vers un nouveau dépôt Git.

  • Supprimer le projet: ce bouton supprime le projet. Cela supprime tout le code LookML du projet dans tous les environnements de développement et de production de votre instance Looker.

  • Récapitulatif Git: cette section présente la configuration Git du projet et les informations relatives à la branche Git de l'utilisateur actuel.

Nom de la branche de production Git

Avec l'intégration Git par défaut, tous les développeurs Looker fusionnent leurs modifications dans une branche appelée master. Vous pouvez utiliser le champ Git Production Branch Name (Nom de la branche de production Git) pour spécifier la branche de votre dépôt Git que Looker doit utiliser comme branche cible dans laquelle les branches de vos développeurs Looker seront fusionnées. Consultez la page de documentation Utiliser le contrôle des versions et le déploiement pour connaître le workflow Git par défaut et les autres options d'implémentation avancée de Git.

Pour les projets existants, pensez à procéder comme suit avant de modifier le nom de la branche de production Git:

  • Demandez à tous les développeurs du projet Looker de valider leurs modifications et de fusionner leurs branches avec la branche de production existante, puis de mettre leur travail en pause jusqu'à ce que le nom de la branche de production Git soit mis à jour et enregistré dans la configuration du projet Looker.
  • Si votre projet utilise des demandes d'extraction intégrées, finalisez et fusionnez toutes les demandes d'extraction ouvertes, le cas échéant.
  • Effectuez toutes les préparations nécessaires du côté du fournisseur Git. Par exemple, créez une nouvelle branche dans votre dépôt, renommez la branche Git par défaut existante ou effectuez toute autre action nécessaire pour préparer la branche afin que Looker puisse l'utiliser comme branche cible pour la fusion. Au minimum, vous devez vérifier que la branche que vous souhaitez utiliser est une branche existante de votre dépôt Git.

Pour modifier la branche Git utilisée par votre projet comme cible de fusion pour les branches de développement, procédez comme suit:

  1. Sélectionnez l'icône Settings (Paramètres) dans le menu des icônes situé à gauche pour afficher la page Project Settings (Paramètres du projet). L'onglet Configuration s'ouvre par défaut.
  2. Dans le champ Git Production Branch Name (Nom de la branche de production Git), saisissez le nom de la branche Git que vous souhaitez utiliser comme branche de production pour votre projet Looker.
  3. Faites défiler la page vers le bas et cliquez sur le bouton Save Project Configuration (Enregistrer la configuration du projet) pour enregistrer vos modifications.

Importer des identifiants

La section Importer des identifiants vous permet de gérer les identifiants d'authentification pour les dépôts distants privés. Pour en savoir plus, consultez la page de documentation Importer des fichiers à partir d'autres projets .

Gestion des branches

Dans l'onglet Branch Management (Gestion des branches) de la page Projects Settings (Paramètres des projets), vous pouvez voir toutes les branches Git associées au projet. Pour en savoir plus, consultez la page de documentation Utiliser le contrôle des versions et le déploiement.

Options d'intégration de Git

Une fois que vous avez configuré votre connexion Git, Looker utilise votre fournisseur Git pour gérer vos fichiers sources LookML, comme décrit sur la page de documentation Utiliser le contrôle des versions et le déploiement.

Si vous êtes un administrateur Looker, vous pouvez configurer des options supplémentaires pour l'intégration de Looker à Git à l'aide des options Git Integration (Intégration Git) dans l'onglet Configuration de la page Paramètres du projet:

  • Désactivé: Looker n'affiche aucun lien externe vers l'interface de votre fournisseur Git.
  • Afficher les liens: Looker fournit des liens externes vers l'interface de votre fournisseur Git afin que vos développeurs puissent afficher le projet dans l'interface de votre fournisseur Git. Looker fournira également des liens pour chaque fichier de projet afin que vos développeurs puissent consulter l'historique du fichier et les informations sur les reproches Git dans l'interface de votre fournisseur Git. Pour en savoir plus sur ces liens, consultez la section Intégrer des liens externes vers votre fournisseur Git.
  • Demandes d'extraction recommandées: en plus de fournir des liens externes vers l'interface de votre fournisseur Git, Looker permet aux développeurs d'envoyer une demande d'extraction#39;extraction afin qu'un autre développeur puisse approuver les modifications avant de les ajouter au projet. Pour en savoir plus sur la configuration de cette fonctionnalité, consultez la section Intégrer des demandes d'extraction pour votre projet.
  • Demandes d'extraction requises: cette option est identique à Demandes d'extraction recommandées, si ce n'est que vos développeurs LookML sont tenus d'ouvrir une demande d'extraction'extraction pour envoyer des modifications au projet. Pour en savoir plus sur la configuration de cette fonctionnalité, consultez la section Intégrer des demandes d'extraction pour votre projet.

Pour enregistrer vos paramètres d'intégration Git, faites défiler la page vers le bas et cliquez sur Save Project Configuration (Enregistrer la configuration du projet) sous la section Deployment (Déploiement).

Si vous avez activé l'une des options d'intégration Git supplémentaires (Afficher les liens, Demandes d'extraction recommandées ou Demandes d'extraction requises), Looker fournit des liens externes vers l'interface de votre fournisseur Git. Ces liens externes ouvrent un nouvel onglet de navigateur sur le site de votre fournisseur Git.

Pour afficher ces liens externes, vos développeurs doivent disposer d'un compte auprès de votre fournisseur Git et avoir accès au dépôt Git du projet.

Dans le menu à trois points File Options (Options de fichier) de chacun de vos fichiers LookML, Looker fournit des liens vers le site de votre fournisseur Git pour afficher le fichier, afficher les informations de reproche Git pour le fichier et afficher l'historique des commits du fichier.

Dans le panneau Actions Git, vous pouvez également utiliser l'option Afficher le projet sur <Git provider> pour ouvrir les fichiers de votre projet sur le site de votre fournisseur Git.

Intégrer des demandes d'extraction pour votre projet

Avec l'intégration Git par défaut dans Looker, les développeurs Looker valident leurs modifications dans leur branche de développement, puis fusionnent leur branche de développement dans la branche de production. Ensuite, lorsque vous déployez dans l'environnement Looker, Looker utilise le dernier commit de la branche de production. Consultez la page de documentation Utiliser le contrôle des versions et le déploiement pour connaître le workflow Git par défaut et les autres options d'implémentation avancée de Git.

Au lieu d'autoriser les développeurs Looker à fusionner leur branche de développement avec la branche de production de Looker, vous pouvez configurer votre projet avec l'option Demandes d'extraction recommandées ou Demandes d'extraction requises:

  • Demandes d'extraction recommandées: Lorsqu'un développeur a validé les modifications dans sa branche de développement, le bouton Git dans l'IDE Looker l'invite à ouvrir une demande d'extraction'extraction pour fusionner sa branche de développement dans la branche de production. Le développeur peut alors ouvrir une demande d'extraction d'extraction pour que d'autres développeurs Looker l'examinent et l'approuvent depuis l'interface Web du fournisseur Git. À la place, le développeur peut utiliser l'option Deploy to Production (Déployer en production) du panneau "Git Actions" (Actions Git) pour éviter de créer une demande d'extraction;extraction et de déployer ses modifications en production. (L'option Déployer en production n'est pas disponible si le projet est activé en mode de déploiement avancé.)
  • Demandes d'extraction requises: lorsqu'un développeur a validé les modifications dans sa branche de développement, le bouton Git dans l'IDE Looker l'invite à ouvrir une demande d'extraction'extraction. Le développeur doit ouvrir une demande d'extraction pour fusionner sa branche de développement dans la branche de production. Ensuite, d'autres développeurs Looker peuvent examiner et approuver la demande d'extraction à partir de l'interface Web du fournisseur Git.

Looker prend en charge l'intégration de demande d'extraction d'extraction pour les fournisseurs Git suivants:

  • GitHub
  • GitLab
  • Bitbucket Cloud
  • Bitbucket Server (anciennement "Stash")

Voici quelques remarques supplémentaires sur l'utilisation des demandes d'extraction avec Looker:

  • Pour ouvrir des demandes d'extraction, vos développeurs doivent posséder un compte auprès de votre fournisseur Git et avoir accès au dépôt Git du projet.

  • Si la fonctionnalité Liste d'autorisation d'adresses IP est activée sur votre instance, vous devez ajouter à la liste d'autorisation la plage d'adresses IP à partir de laquelle votre fournisseur Git effectue des requêtes sortantes pour intégrer les demandes d'extraction dans les projets LookML. Par exemple, les adresses IP GitHub actuelles sont répertoriées dans le journal des modifications GitHub. Les adresses IP sont susceptibles d'être modifiées et différentes pour les autres fournisseurs Git.

  • Si vous avez activé le mode de déploiement avancé, il n'est pas nécessaire de configurer un webhook dans la section Configurer votre projet avec des demandes d'extraction intégrées, car le mode de déploiement avancé sépare les fonctions de fusion et de déploiement.

  • Si un développeur Looker a émis une demande d'extraction que vous souhaitez annuler, consultez le post de la communauté Comment annuler des demandes d'extraction Looker via GitHub pour en savoir plus.

  • Les requêtes d'extraction Git permettent d'utiliser une instance de préproduction pour Looker. Vous pouvez ainsi disposer d'une instance de préproduction et d'une instance de production, avec les demandes d'extraction activées sur l'instance de préproduction. L'ensemble du développement et de l'examen du code peuvent être effectués dans l'environnement de préproduction. Le code examiné peut ensuite être déployé sur l'instance de production comme vous le souhaitez. Pour savoir comment configurer cette fonctionnalité, consultez le post de la communauté Workflow Git avec un dépôt dans plusieurs instances – Développement, préproduction et production.

  • Looker fusionne les modifications d'une branche de développeur Looker dans la branche de production en utilisant la méthode de fusion commit de fusion. Lorsque vous utilisez l'interface de votre fournisseur Git, assurez-vous que vos développeurs n'utilisent pas la fusion avec squash ni la rebase. Consultez la section Options de fusion dans l'interface du fournisseur Git pour en savoir plus.

Configurer votre projet avec des demandes d'extraction intégrées

Pour configurer votre projet Looker avec des demandes d'extraction Git:

  1. Dans votre projet, sélectionnez Project Settings (Paramètres du projet) dans le menu des icônes sur la gauche.
  2. Dans la section Git Integration (Intégration Git) de l'onglet Configuration, sélectionnez Pull Orders Recommended (Demandes d'extraction recommandées) ou Pull Orders Required (Demandes d'extraction requises).
  3. Si vous souhaitez configurer un webhook de déploiement automatique dans l'interface de votre fournisseur Git, copiez les informations du webhook et collez-les dans un fichier texte. Si votre projet est configuré pour utiliser le mode de déploiement avancé, vous pouvez ignorer cette étape. Vous pouvez également décider plus tard et revenir aux paramètres du projet pour obtenir les informations du webhook.
  4. Vous pouvez éventuellement configurer un secret de déploiement de webhook pour authentifier un webhook de déploiement automatique provenant de votre fournisseur Git ou un webhook en mode de déploiement avancé. Pour créer un secret de webhook, cliquez sur Définir le secret du webhook. Copiez le secret de déploiement et collez-le dans un fichier texte. Il sera utilisé lorsque vous ajouterez le webhook à l'interface de votre fournisseur Git. Vous pouvez également décider plus tard et revenir aux paramètres du projet pour ajouter un secret de déploiement. Pour en savoir plus, consultez la page de documentation Configurer le code secret de déploiement du webhook.
  5. Cliquez sur Save Project Configuration (Enregistrer la configuration du projet).

Désormais, lorsqu'un développeur Looker valide des modifications dans votre projet, l'IDE Looker affiche le bouton Open Pull Request (Ouvrir la demande d'extraction). Ce bouton ouvre un nouvel onglet de navigateur qui redirige directement vers la nouvelle page de demande d'extraction d'extraction sur le site Web de votre fournisseur Git.

Une fois que vous avez configuré votre projet Looker pour utiliser les demandes d'extraction, effectuez l'une des opérations suivantes pour configurer le déploiement des commits dans votre environnement de production:

  • Pour déployer automatiquement les derniers commits fusionnés avec votre branche de production, utilisez l'interface de votre fournisseur Git pour ajouter un webhook, comme décrit dans la section suivante de cette page.
  • Pour spécifier manuellement les branches ou les commits à déployer, activez le mode de déploiement avancé. Consultez la page de documentation Mode de déploiement avancé pour en savoir plus sur l'activation et la gestion du mode de déploiement avancé.

Ajouter un webhook à votre fournisseur Git

Pour les projets Looker activés pour les requêtes d'extraction, vous pouvez configurer un webhook de déploiement sur l'interface de votre fournisseur Git. Ce webhook déclenche le déploiement du dernier commit de la branche de production par Looker, chaque fois que vous fusionnez une demande d'extraction d'extraction dans l'interface du fournisseur Git.

Dans la plupart des cas, il n'est pas souhaitable de configurer un webhook de déploiement automatique si votre projet est configuré pour utiliser le mode de déploiement avancé. Le mode de déploiement avancé vous permet de sélectionner le commit et la branche que vous souhaitez déployer. Dans la plupart des cas, la configuration d'un webhook de déploiement automatique annule les fonctionnalités du mode de déploiement avancé.

Pour ajouter un webhook de déploiement automatique à l'interface de votre fournisseur Git, accédez d'abord aux paramètres de votre projet dans Looker en cliquant sur l'icône Paramètres dans le menu de l'icône à gauche du projet. Copiez ensuite le webhook à partir de la section Git Integration (Intégration de Git).

Le webhook se présente sous la forme <instance_url>/webhooks/projects/<project_name>/deploy.

Remplacez <instance_url> par l'URL de votre instance Looker. Par exemple, si l'URL de votre instance Looker est example.looker.com et que le nom de votre projet est e_faa, le webhook ressemblera à ceci:

https://example.looker.com/webhooks/projects/e_faa/deploy

Dans les paramètres du projet Looker, vous pouvez également obtenir un secret de déploiement d'un webhook pour authentifier les intégrations Git de votre projet auprès de votre fournisseur Git. Pour en savoir plus, consultez la page de documentation Configurer le code secret de déploiement du webhook.

Une fois que vous disposez de l'URL et du code secret du webhook de déploiement, vous pouvez les saisir dans l'interface de votre fournisseur Git. Si votre fournisseur Git est GitHub, procédez comme suit:

  1. Accédez aux paramètres de dépôt de votre projet dans votre dépôt GitHub.
  2. Dans les paramètres de votre dépôt, cliquez sur Webhooks. Cliquez sur Ajouter un webhook pour ouvrir la fenêtre Ajouter un webhook.
  3. Dans la zone de texte Payload URL (URL de charge utile), collez les informations du webhook que vous avez copiées à partir de la section Git Integration (Intégration Git) dans Looker.
  4. Vous pouvez éventuellement ajouter un secret de déploiement de webhook qui authentifie les intégrations Git de votre projet auprès de votre fournisseur Git. Copiez le secret de déploiement à partir des paramètres de votre projet LookML et collez-le dans la zone de texte Secret (Code secret) de l'interface du fournisseur Git. Pour en savoir plus, consultez la page de documentation Configurer le code secret de déploiement du webhook.
  5. Sélectionnez l'option Uniquement l'événement push dans le champ Quels événements souhaitez-vous déclencher ce webhook ?.
  6. Cliquez sur Add webhook (Ajouter un Webhook).

Utiliser un webhook de déploiement pour extraire des données d'un dépôt Git distant

Lorsque les demandes d'extraction sont activées pour votre projet LookML et que le déploiement des webhooks n'est pas automatisé, il peut arriver que le code LookML affiché en mode Production de Looker ne corresponde pas au code LookML de la branche principale de votre dépôt Git. Cela peut se produire dans les situations suivantes:

  • Lorsque les demandes d'extraction sont activées pour le dépôt
  • Lorsque le code LookML a été modifié en dehors de l'environnement de développement de Looker, par exemple :
    • Dans le dépôt Git
    • Sur une autre instance Looker, telle qu'une instance de préproduction

Vous pouvez synchroniser la branche de production de Looker avec la branche principale du dépôt à l'aide d'un webhook de déploiement:

  1. Ouvrez un nouvel onglet de navigateur et saisissez l'URL suivante, en remplaçant <instance_url> par l'URL de votre instance Looker et <project_name> par le nom de votre projet LookML:

    <instance_url>/webhooks/projects/<project name>/deploy

  2. Une fois que vous avez exécuté l'URL du webhook de déploiement, une page Web vide affiche un message de réussite semblable à celui-ci:

    {"operations":[{"error":false,"error_code":0,"command":"Checkout Branch #\u003cLooker::GitBranch:0x5798672b\u003e","node_id":728,"results":["Success"]},{"error":false,"error_code":0,"command":"jgit revert_repo","node_id":728,"results":["Success"]}],"new_head":"05f772af48709fc2799fefe408e3fdd895a63284","old_head":"77412cad9fd7ed3eed1627afa201fdf7dcb97dd1"}

Votre mode de production a été mis à jour dans Looker pour refléter votre branche principale Git distante. Votre branche de développeur personnel et vos branches partagées ne sont pas affectées.

Extraire des données d'un dépôt Git distant pour les webhooks avec déploiement de secrets

Si votre projet LookML nécessite également un secret de déploiement de webhook pour transférer les modifications de votre branche principale vers votre branche de production, vous recevrez l'une des erreurs suivantes lorsque vous synchroniserez la branche de production avec la branche principale du dépôt à l'aide de la méthode décrite dans la section précédente, Utiliser un webhook de déploiement pour extraire des données d'un dépôt Git distant:

{"error":"Uh oh! Something went wrong."}

ou

{"error":"Not found."}

Au lieu d'utiliser le webhook de déploiement, vous pouvez exécuter la commande cURL suivante dans votre terminal avec le code secret du webhook. Veillez à remplacer les champs suivants:

  • Remplacez <instance_URL> par l'URL de votre instance Looker.
  • Remplacez <deploy_secret> par le secret de déploiement de votre projet.
  • Remplacez <project_name> par le nom de votre projet LookML.
curl -i -X POST -H "X-Looker-Deploy-Secret:<deploy_secret>" https://<instance_url>/webhooks/projects/<project_name>/deploy

Par exemple, si vous synchronisez une branche de production pour le projet ecommerce_project sur l'instance Brettcase avec la branche principale du dépôt:

curl -i -X POST -H "X-Looker-Deploy-Secret:123123123secretgoeshere123123123" https://brettcase.looker.com/webhooks/projects/ecommerce_project/deploy

Options de fusion dans l'interface du fournisseur Git

Si votre projet Looker est intégré aux demandes d'extraction, vos développeurs utilisent l'interface de votre fournisseur Git pour envoyer des demandes d'extraction et fusionner les modifications dans la branche de production.

Looker est compatible avec la méthode de validation de la fusion, qui permet de fusionner les modifications d'une branche de développement dans votre branche de production. Cependant, l'interface de votre fournisseur Git peut afficher d'autres options de fusion, telles que Squash and merge (Écraser et fusionner) ou Rebase and merge (Redéfinir et fusionner).

Looker n'est pas compatible avec la fusion avec squash ni avec la rebase. Vos développeurs doivent donc éviter d'utiliser ces options. Si possible, il est recommandé de désactiver ces options pour votre dépôt. Pour désactiver ces options dans un dépôt GitHub, procédez comme suit:

  1. Accédez à l'onglet Settings (Paramètres) pour accéder aux paramètres du dépôt de votre projet sur GitHub.

    ASTUCE: Pour les projets configurés avec l'intégration Git, vous pouvez utiliser l'option View Project on Git (Afficher le projet sur Git) dans le menu Git du projet dans Looker.

  2. Dans les paramètres de votre dépôt, cliquez sur Options dans le menu de navigation de gauche.

  3. Faites défiler la page jusqu'à la section Bouton "Fusionner" et ne cochez que l'option Autoriser la fusion des commits. Décochez les options Allow squash Merge (Autoriser la fusion de squash) et Allow rebase Merge (Autoriser la fusion de rebases).

Si vous décochez ces options, elles ne seront plus disponibles lorsqu'un utilisateur fusionnera une branche dans le dépôt.

Configurer et tester une connexion Git

Configurer le secret de déploiement du webhook