Gérer les dépendances de compilation

Cette page explique comment spécifier les dépendances de compilation. Cloud Build vous permet de gérer les dépendances du code source séparément du processus de compilation.

Dans votre fichier de configuration de compilation, vous pouvez lister un ou plusieurs dépôts Git à cloner pour votre compilation, ainsi que l'ordre dans lequel les extraire. Spécifier les dépendances de cette manière permet de séparer la récupération des dépendances du processus de compilation lui-même.

Si vous n'incluez aucune dépendance dans votre fichier de configuration de compilation, Cloud Build clone le dépôt de code source qui contient votre fichier de configuration de compilation (pour les compilations déclenchées) ou le dépôt qui contient votre code source (pour les compilations que vous appelez à partir de la ligne de commande). Si vous incluez des dépendances dans votre fichier de configuration de compilation, Cloud Build ne clone aucun dépôt qui n'est pas spécifié dans le champ dependencies.

Tout dépôt de code source que vous spécifiez dans le champ dependencies doit être connecté à Cloud Build à l'aide de Developer Connect, ou être un dépôt public.

Les dépendances sont clonées dans l'ordre dans lequel vous les spécifiez dans cette configuration. De plus, la récupération des dépendances a lieu avant l'exécution de toute logique spécifiée par l'utilisateur. L'extraction des dépendances est donc fiable.

Les dépendances sont affichées dans l'onglet Dépendances de compilation de la page Informations sur la compilation.

Avant de commencer

Les instructions de cette page supposent que vous disposez d'un ou de plusieurs dépôts Git publics ou associés à l'aide de Developer Connect.

Pour obtenir les autorisations nécessaires pour ajouter un dépôt Developer Connect en tant que dépendance, demandez à votre administrateur de vous accorder le rôle IAM Accesseur de jetons de lecture Developer Connect (developerconnect.readTokenAccessor) sur votre compte de service. Pour en savoir plus sur l'attribution de rôles, consultez la page Gérer l'accès aux projets, aux dossiers et aux organisations.

Vous pouvez également obtenir les autorisations requises avec des rôles personnalisés ou d'autres rôles prédéfinis.

Spécifier des dépendances

Vous spécifiez des dépendances en ajoutant un stanza dependencies à votre fichier de configuration de compilation. dependencies est une propriété de premier niveau dans la configuration de compilation, mais vous pouvez la placer n'importe où dans le fichier.

Voici la syntaxe de la strophe dependencies :

YAML 

 dependencies:
 - gitSource:
     repository:
       url: 'URL'
       developerConnect: 'RESOURCE_PATH'
     revision: 'REVISION'
     recurseSubmodules: 'true|false'
     depth: DEPTH'
     destPath: 'DEST_PATH'

JSON 

 {
     "dependencies": {
         "gitSource": {
             "repository": {
                 "url": "URL"
                 "developerConnect": "RESOURCE_PATH"
             },
             "revision": "REVISION",
             "recurseSubmodules": true|false,
             "depth": "DEPTH",
             "destPath": "DEST_PATH",
         },
     },
 }

Remplacez les valeurs suivantes :

  • URL : facultatif. URL HTTPS du dépôt à récupérer. Vous devez spécifier une URL ou un chemin d'accès à une ressource Developer Connect.

  • RESOURCE_PATH : facultatif. Chemin d'accès à la ressource Google Cloud pour ce dépôt Developer Connect. Exemple : projects/my-project/locations/us-central1/connections/my-connection/gitRepositoryLinks/my-repo. Vous devez spécifier une URL ou un chemin d'accès à une ressource Developer Connect. Spécifiez ce champ si le dépôt à extraire est connecté à Cloud Build à l'aide de Developer Connect.

  • REVISION : valeur obligatoire. Version, hachage de commit, tag ou nom de branche à extraire du dépôt.

  • recurseSubmodules : "true|false" : indique s'il faut récupérer les sous-modules.

  • DEPTH : facultatif, profondeur de l'historique du dépôt à récupérer. Si aucune valeur n'est spécifiée, le dernier commit est récupéré.

    • 1 : dernier commit
    • 2 : les deux derniers commits
    • 3 : les trois derniers commits
    • -1 : tous les commits

  • DEST_PATH : valeur obligatoire. Chemin d'accès au répertoire dans lequel le dépôt est cloné. Exemple :my/repo

    Lorsque vous définissez dest_path, le dépôt est récupéré dans /workspace/<dest_path>. La valeur dest_path doit être un chemin d'accès relatif au répertoire de travail de la compilation.

Spécifier un dépôt Developer Connect comme dépendance

  • Si vous spécifiez un dépôt Developer Connect comme dépendance, vous devez attribuer le rôle Developer Connect Read Token Accessor au compte de service Cloud Build. Pour en savoir plus, consultez Accorder à Cloud Build l'accès à un dépôt Developer Connect.

  • Votre build doit se trouver dans la même région que la connexion Developer Connect.

Étapes suivantes