Cette page explique comment créer des déclencheurs manuels pour compiler du code dans les dépôts sources. Les déclencheurs manuels peuvent être utilisés pour appeler des compilations manuellement, avec la possibilité de remplacer les valeurs des variables de substitution définies au moment de l'appel, avant l'exécution d'une compilation. Vous pouvez aussi programmer la mise à jour manuelle s'exécutent automatiquement à un moment précis.
Pour apprendre à démarrer des compilations manuellement à l'aide de la gcloud CLI ou l'API Cloud Build, consultez Démarrer les compilations manuellement
Avant de commencer
-
Activez l'API Cloud Build
- Préparez votre code source.
Déclencheurs manuels
Les déclencheurs manuels vous permettent de configurer des compilations qui ne sont exécutées que lorsque vous appelez votre déclencheur sur des dépôts connectés. Supposons que vous créez un pipeline pour le déploiement de votre code source dans un environnement de préproduction ou de production. Vous souhaitez peut-être automatiser votre workflow, mais vous souhaitez uniquement exécuter des compilations manuellement. Pour ce faire, vous pouvez définir des déclencheurs manuels.
Les déclencheurs manuels vous permettent d'appeler manuellement des compilations en :
- extrayant le code source depuis un dépôt hébergé avec une branche ou un tag spécifiques ;
- configurant votre compilation avec des substitutions qui n'ont pas besoin d'être transmises manuellement chaque fois que vous exécutez une compilation ;
- remplaçant les valeurs de variable de substitution définies au moment de l'appel avant d'appeler une compilation.
Si vous souhaitez exécuter des compilations à partir de votre répertoire de travail local au lieu d'un dépôt hébergé
ou si vous souhaitez envoyer des builds sans créer de déclencheur, vous pouvez exécuter la commande
gcloud
dans votre répertoire de travail:
gcloud builds submit --config BUILD_CONFIG SOURCE_CODE
Où :
- BUILD_CONFIG est le chemin d'accès du fichier de configuration de compilation
- SOURCE_CODE est le code source du chemin d'accès ou de l'URL
Pour découvrir comment démarrer des compilations manuellement dans votre répertoire local à l'aide de la commande gcloud
, consultez la section Démarrer des compilations manuellement.
Créer des déclencheurs manuels
Console
Pour créer un déclencheur manuel, procédez comme suit :
Ouvrez la page Déclencheurs :
Sélectionnez votre projet en haut de la page, puis cliquez sur Ouvrir.
Cliquez sur Créer un déclencheur.
Entrez les paramètres de déclencheur suivants :
- Nom : nom de votre déclencheur.
Région: sélectionnez la région de votre déclencheur.
- Si vous sélectionnez global comme région, Cloud Build utilise la version par défaut pour exécuter votre build.
- Si vous sélectionnez une région non mondiale et que fichier de configuration de compilation associé au déclencheur spécifie un pool privé, Cloud Build utilise le pool privé pour exécuter votre build. Dans ce cas, la région que vous spécifiez dans votre déclencheur doit correspondre à celle dans laquelle vous avez créé le pool privé.
- Si vous sélectionnez une région non mondiale et que fichier de configuration de compilation associé au déclencheur ne spécifie pas de pool privé, Cloud Build utilise la version par défaut pour exécuter votre build dans la même région comme déclencheur.
Description (facultatif) : description de votre déclencheur.
Événement: sélectionnez Appel manuel pour configurer votre déclencheur afin que la compilation ne s'exécutera que lorsque le déclencheur est appelé manuellement.
Source : sélectionnez le dépôt à compiler lorsque le déclencheur manuel est exécuté. Vous pouvez spécifiez 1re génération ou 2e génération comme source.
Révision: sélectionnez la branche ou le tag à compiler lorsque le déclencheur manuel est utilisé. s'exécute.
Branche : définissez un déclencheur pour démarrer une compilation sur cette branche. Vous devez spécifier une valeur littérale. Les expressions régulières ne sont pas acceptées pour le moment.
Tag : définissez un déclencheur pour démarrer une compilation sur ce tag. Vous devez spécifier une valeur littérale. Les expressions régulières ne sont pas acceptées pour le moment.
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
dans un dépôt distant, indiquez l'emplacement
fichier de configuration de compilation, le
Dockerfile
ou le répertoire "buildpacks". Si votre type de configuration de compilation est un fichierDockerfile
ou un pack de création, vous devez attribuer un nom à l'image obtenue et, éventuellement, un délai avant expiration pour la compilation. Une fois le nom de l'imageDockerfile
ou du pack de création fourni, vous obtenez un aperçu de la commandedocker build
oupack
que votre compilation va exécuter. - Intégré: si vous avez sélectionné fichier de configuration Cloud Build (yaml ou json), vous pouvez spécifier votre configuration de compilation de façon intégrée. Cliquez sur Ouvrir l'éditeur pour écrire votre fichier de configuration de compilation dans la console Google Cloud à l'aide de la syntaxe YAML ou JSON. Cliquez sur OK pour enregistrer votre configuration de compilation.
- Dépôt: si votre fichier de configuration se trouve dans votre
dans un dépôt distant, indiquez l'emplacement
fichier de configuration de compilation, le
- Type: sélectionnez le type de configuration à utiliser pour votre compilation.
Cliquez sur Créer pour créer votre déclencheur manuel.
gcloud
Pour obtenir la liste complète des options, consultez la documentation de référence sur gcloud
pour savoir comment créer des déclencheurs manuels.
Exécuter des déclencheurs manuels
Console
Pour exécuter un déclencheur manuel à l'aide de la console Google Cloud:
Ouvrez la page Déclencheurs dans la console Google Cloud.
Identifiez votre déclencheur dans la liste.
Cliquez sur Exécuter le déclencheur.
Après avoir cliqué sur Exécuter le déclencheur, le volet Exécuter le déclencheur apparaît à droite. Si vous avez spécifié des champs tels qu'un nom de branche, un nom de tag ou des variables de substitution, vous pouvez remplacer ces champs au moment de l'appel.
Si vous avez spécifié de nouvelles valeurs de variables pour votre substitution, cliquez sur Exécuter le déclencheur pour exécuter la compilation.
Pour exécuter des déclencheurs manuels selon un calendrier, consultez la section Planifier des compilations.
gcloud
Pour exécuter un déclencheur manuel à l'aide de l'outil de ligne de commande gcloud
, exécutez la commande suivante :
:
gcloud builds triggers run TRIGGER_NAME \
--region=REGION \
--branch=BRANCH_NAME \
--substitutions=SUBSTITUTION_VAR=SUBSTITUTION_VALUE
Où :
TRIGGER_NAME
correspond au nom de votre déclencheur.REGION
est la région de votre déclencheur.BRANCH_NAME
est le nom de votre branche. Vous pouvez spécifiez également un tag à l'aide de--tag
ou un ID de commit à l'aide de--sha
.- [Facultatif]
SUBSTITUTION_VAR
est le nom de la variable pour votre valeur de substitution. - [Facultatif]
SUBSTITUTION_VALUE
est la valeur associée à votre substitution. .
Pour exécuter des déclencheurs manuels selon la programmation, consultez Planifier des compilations.
Étapes suivantes
- Découvrez comment démarrer des compilations manuellement à l'aide des commandes
gcloud
ou de l'API Cloud Build. - Découvrez comment planifier des compilations.
- Découvrez comment créer et gérer des déclencheurs.
- Découvrez comment afficher les résultats de la compilation.
- Découvrez comment résoudre les erreurs de compilation.