Créer des dépôts à partir de GitHub

Les déclencheurs GitHub vous permettent de compiler automatiquement sur des requêtes Git de type push et pull, et d'afficher les résultats des compilations sur GitHub et dans Cloud Console. En outre, les déclencheurs d'application GitHub sont compatibles avec les même fonctionnalités que les déclencheurs GitHub existants et utilisent l'application Cloud Build GitHub pour configurer GitHub et s'authentifier.

Cette page explique comment créer des déclencheurs GitHub et compiler sur GitHub à l'aide de l'application Cloud Build GitHub.

Avant de commencer

  • Activez l'API Cloud Build.

    Activer l'API

  • Préparez votre code source dans un dépôt GitHub.
  • Vous devez disposer d'un fichier de configuration Dockerfile ou Cloud Build dans votre dépôt source GitHub.
  • Si vous connectez initialement votre dépôt à Cloud Build, assurez-vous de disposer d'autorisations de niveau administrateur sur votre dépôt. Pour en savoir plus sur les autorisations associées aux dépôts GitHub, consultez la section Niveaux d'autorisation des dépôts pour une organisation.
  • Pour utiliser les commandes gcloud sur cette page, installez le SDK Cloud.

Installer l'application Cloud Build

Pour installer l'application Cloud Build et connecter votre dépôt GitHub à votre projet Cloud, procédez comme suit :

  1. Ouvrez la page Déclencheurs dans Google Cloud Console.

    Ouvrir la page Déclencheurs

  2. Dans le sélecteur de projet de la barre supérieure, sélectionnez votre projet Cloud.

  3. Cliquez sur Connecter un dépôt.

  4. Sélectionnez GitHub (application GitHub Cloud Build), cochez la case d'autorisation, puis cliquez sur Continuer.

  5. (Facultatif) Si vous ne vous êtes pas encore connecté à GitHub, faites-le maintenant.

    La page d'autorisation s'affiche et vous invite à autoriser l'application Google Cloud Build à se connecter à Google Cloud.

    Capture d'écran du bouton d'autorisation

    Cliquez sur Autoriser Google Cloud Build par GoogleCloudBuild.

  6. Cliquez sur Installer Google Cloud Build.

  7. Dans la fenêtre pop-up qui s'affiche, sélectionnez votre nom d'utilisateur ou votre organisation GitHub.

  8. Sélectionnez l'une des options suivantes en fonction des besoins de votre entreprise :

    • Tous les dépôts : permet d'activer tous les dépôts GitHub actuels et futurs pour y accéder via l'application Cloud Build.

    • Sélectionner uniquement les dépôts : utilisez la liste déroulante Sélectionner des dépôts pour n'autoriser l'accès qu'à certains dépôts via l'application Cloud Build. Vous pouvez activer d'autres dépôts supplémentaires ultérieurement.

  9. Cliquez sur Installer pour installer l'application Cloud Build.

    La fenêtre pop-up se ferme et vous êtes redirigé vers la page de sélection du projet dans Cloud Build. Sur cette page, vous pouvez sélectionner un projet Cloud existant ou en créer un.

    Si un projet existant n'est pas répertorié sur cette page, cliquez sur Sélectionner un projet pour afficher une liste de tous les projets existants.

  10. Une fois que vous avez sélectionné un projet ou en avez créé un, le panneau Connecter un dépôt s'affiche.

  11. Dans la section Sélectionner un dépôt, sélectionnez les champs suivants :

    • Compte GitHub : compte GitHub utilisé pour installer l'application GitHub Cloud Build. Ce champ peut être présélectionné.

    • Dépôt : dépôts que vous souhaitez connecter à Cloud Build.

      Si vous ne voyez pas un ou plusieurs de vos dépôts cibles, cliquez sur Modifier les dépôts sur GitHub et répétez les étapes ci-dessus pour activer d'autres dépôts dans l'application GitHub Cloud Build.

  12. Une fois que vous avez sélectionné votre compte et vos dépôts GitHub, lisez la clause de non-responsabilité et cochez la case à côté de celle-ci pour indiquer que vous acceptez les conditions d'utilisation.

  13. Cliquez sur Se connecter.

  14. (Facultatif) Dans la section Créer un déclencheur, sélectionnez les dépôts pour lesquels vous souhaitez créer un déclencheur dans le champ Créer un exemple de déclencheur pour ces dépôts. Une fois que vous avez sélectionné vos dépôts, cliquez sur Créer un déclencheur.

  15. Cliquez sur OK.

Vous avez maintenant connecté un ou plusieurs dépôts GitHub à votre projet Cloud. Vous êtes redirigé vers la page Déclencheurs de Cloud Console.

(Facultatif) Mettre à jour le compte GitHub authentifié

Si vous devez mettre à jour le compte GitHub associé à votre compte Google, vous pouvez accéder à la page S'authentifier avec GitHub. Vous devrez peut-être effectuer cette opération si vous remarquez que la page Connecter un dépôt à Cloud Build indique que l'application GitHub n'est installée sur aucun dépôt après l'installation de l'application Cloud Build sur GitHub.

Créer des déclencheurs GitHub

Console

Pour créer des déclencheurs GitHub à l'aide de Google Cloud Console, procédez comme suit :

  1. Ouvrez la page Déclencheurs dans Google Cloud Console.

    Ouvrir la page Déclencheurs

  2. Sélectionnez votre projet dans le menu déroulant du sélecteur de projet, en haut de la page.

  3. Cliquez sur Ouvrir.

  4. Cliquez sur Créer un déclencheur.

  5. Entrez les paramètres de déclencheur suivants :

    • Nom : saisissez le nom de votre déclencheur.

    • Description (facultative) : saisissez une description du déclencheur.

    • Événement : sélectionnez l'événement lié au dépôt qui appelle votre déclencheur.

      • Déployer sur une branche : configurez votre déclencheur pour lancer une compilation sur les commits réalisés dans une branche spécifique.

      • Transférer le nouveau tag : configurez votre déclencheur pour lancer une compilation sur des commits contenant un tag particulier.

      • Demande d'extraction (Cloud Source Repositories non disponible): définissez votre déclencheur pour qu'il lance une compilation sur des commits pour une demande d'extraction.

    • Source : sélectionnez le dépôt et la branche ou le tag correspondants pour surveiller les événements.

      • Dépôt : sélectionnez le dépôt de votre choix dans la liste des dépôts disponibles. Pour connecter un nouveau dépôt, consultez la section Connecter des dépôts supplémentaires.

      • Branche ou tag : spécifiez une expression régulière à laquelle faire correspondre la valeur de la branche ou du tag. Pour en savoir plus sur la syntaxe des expressions régulières acceptables, consultez la page Syntaxe RE2.

      • Contrôle des commentaires : si vous avez sélectionné Demande d'extraction (application GitHub uniquement) comme événement, choisissez l'une des options suivantes pour contrôler si une compilation doit être exécutée automatiquement par le déclencheur :

      • Obligatoire, sauf pour les propriétaires et les collaborateurs : lorsqu'une demande d'extraction est créée ou mise à jour par un propriétaire ou un collaborateur du dépôt, les compilations sont automatiquement exécutées par le déclencheur. Si un contributeur externe lance l'action, les compilations ne seront exécutées qu'après que le propriétaire ou le collaborateur a ajouté /gcbrun à la demande d'extraction.

      • Obligatoire : lorsqu'une demande d'extraction est créée ou mise à jour par un contributeur, les compilations ne sont exécutées qu'après que le propriétaire ou le collaborateur a ajouté /gcbrun à la demande d'extraction.

      • Non requis : lorsqu'une demande d'extraction est créée ou mise à jour par un contributeur, les compilations sont automatiquement exécutées par des déclencheurs.

    • Fichiers inclus (facultatif) : les modifications affectant au moins l'un de ces fichiers déclencheront une compilation.

    • Fichiers ignorés (facultatif) : les modifications affectant uniquement des fichiers ignorés ne déclencheront pas de compilation.

    • Configuration : sélectionnez le fichier de configuration de compilation situé dans votre dépôt distant ou créez un fichier de configuration de compilation intégré à utiliser pour votre compilation.

      • Type: sélectionnez le type de configuration à utiliser pour votre compilation.
        • Fichier de configuration Cloud Build (yaml or json) : utilisez un fichier de configuration de compilation pour votre configuration.
        • Dockerfile : utilisez un fichier Dockerfile pour votre configuration.
      • Emplacement : spécifiez l'emplacement de votre configuration.

        • Dépôt : si votre fichier de configuration se trouve dans votre dépôt distant, indiquez l'emplacement de votre fichier de configuration de compilation ou le répertoire Dockerfile et un nom pour l'image obtenue. Si votre configuration est un Dockerfile, vous pouvez éventuellement fournir un délai d'expiration pour votre compilation. Une fois le fichier Dockerfile et le nom de l'image fournis, vous obtenez un aperçu de la commande docker build que votre compilation va exécuter.
        • Intégré : si vous avez sélectionné Fichier de configuration Cloud Build (yaml ou json) comme option de configuration, vous pouvez spécifier votre configuration de compilation de manière intégrée. Cliquez sur Ouvrir l'éditeur pour écrire votre fichier de configuration de compilation dans Google Cloud Console à l'aide d'une syntaxe YAML ou JSON. Cliquez sur OK pour enregistrer la configuration de compilation.
  6. Cliquez sur Créer pour enregistrer le déclencheur de compilation.

Pour créer des déclencheurs GitHub à l'aide des commandes gcloud, consultez les commandes gcloud de la page Créer un déclencheur de compilation.

gcloud

Pour créer des déclencheurs GitHub à l'aide des commandes gcloud, exécutez la commande suivante :

    gcloud beta builds triggers create github \
        --repo=REPO_NAME \
        --branch-pattern=BRANCH_PATTERN \ # or --tag-pattern=TAG_PATTERN
        --build-config=BUILD_CONFIG_FILE

Où :

  • REPO_NAME est le nom du dépôt.
  • BRANCH_PATTERN est le nom de la branche de votre dépôt sur lequel appeler la compilation.
  • TAG_PATTERN est le nom du tag de votre dépôt sur lequel appeler la compilation.
  • BUILD_CONFIG_FILE correspond au chemin d'accès à votre fichier de configuration de compilation.

Compiler et afficher vos modifications

Pour compiler à l'aide de déclencheurs GitHub, vous devez envoyer et valider des modifications dans votre dépôt source connecté, ou configurer votre compilation sur des demandes d'extraction. Une fois vos modifications validées, Cloud Build compile votre code.

Pour afficher vos modifications de compilation sur GitHub, accédez à l'onglet Vérifications de votre dépôt.

Capture d'écran de l'onglet de conversation

Cloud Build a compilé vos modifications. D'autres informations s'affichent également, telles que le temps nécessaire à la compilation du code, l'ID de la compilation, etc.

Pour afficher les modifications de votre compilation dans Cloud Build, cliquez sur Afficher plus de détails sur Google Cloud Build. La page Informations sur la compilation de Cloud Console s'ouvre. Vous pouvez y voir des informations sur la compilation, comme l'état, les journaux et les étapes.

Différents types de déclencheurs basés sur GitHub

Si votre code source est dans GitHub, Cloud Build fournit deux méthodes pour exécuter automatiquement vos compilations. Vous trouverez dans cette section la description des deux déclencheurs basés sur GitHub ainsi qu'un comparatif de leurs fonctionnalités.

  • Anciens déclencheurs GitHub : lorsque vous créez un ancien déclencheur GitHub, Cloud Build met en miroir votre dépôt GitHub dans Cloud Source Repositories et utilise le dépôt en miroir pour toutes ses opérations. Vous pouvez créer et gérer des déclencheurs GitHub à l'aide de Cloud Console.

  • Déclencheurs GitHub : ce type de déclencheur utilise l'application GitHub Cloud Build pour configurer GitHub et s'authentifier auprès de ce service. Les déclencheurs GitHub vous permettent d'appeler automatiquement les compilations sur les requêtes Git de type push et pull, et d'afficher les résultats des compilations sur GitHub et dans Cloud Console. Vous pouvez créer et gérer des déclencheurs GitHub à l'aide de Cloud Console ou de l'API Cloud Build.

  • Déclencheurs GitHub Enterprise : ce type de déclencheur vous permet d'appeler des compilations en réponse à des commits ou des demandes d'extraction sur une instance GitHub Enterprise. Vous pouvez créer et gérer des déclencheurs GitHub Enterprise à l'aide de Cloud Console ou de l'API Cloud Build.

Le tableau suivant compare les anciens déclencheurs GitHub, les déclencheurs GitHub et les déclencheurs GitHub Enterprise :

Caractéristique Anciens déclencheurs GitHub Déclencheurs GitHub Déclencheurs GitHub Enterprise
Exécution des compilations basée sur les opérations de publication de code source (push) Oui Oui Oui
Exécuter des compilations sur des demandes d'extraction Non Oui Oui
Création d'un déclencheur à l'aide de Cloud Console Oui Oui Oui
Création d'un déclencheur à l'aide de l'API Cloud Build Non Oui Oui
Création d'un déclencheur à l'aide de l'application Cloud Build GitHub Non Oui Oui
Affichage de l'état de la compilation sur Cloud Console Oui Oui Oui
Affichage de l'état de la compilation sur GitHub Non Oui Oui

Partage des données

Les déclencheurs GitHub envoient des données à l'application GitHub Cloud Build. Les données envoyées à l'application vous permettent d'identifier les déclencheurs par nom et d'afficher les résultats de compilation sur GitHub.

Les données suivantes sont actuellement partagées entre Google Cloud et l'application GitHub:

  • Nom du déclencheur

Si vous avez créé des déclencheurs avant le mois d'août 2020, le partage des données peut ne pas être activé pour votre projet. Vous pouvez activer le partage des données pour tous les déclencheurs GitHub de votre projet en cliquant sur Activer dans l'onglet de partage des données Cloud Build.

Si les vérifications d'état requises sont activées pour un dépôt GitHub, l'activation du partage des données peut interrompre temporairement les vérifications d'état. Vous pouvez ajuster les configurations de la vérification d'état pour rechercher le nom de votre déclencheur en procédant comme suit:

  • Désactiver les vérifications requises spécifiques à Cloud Build dans le dépôt GitHub
  • S'assurer que le partage des données est activé dans Cloud Build
  • Exécuter une nouvelle compilation dans Cloud Build qui publie des états dans votre dépôt
  • Réactivation des vérifications d'état requises en sélectionnant le nom du déclencheur

Étape suivante