From 77a7c46d3fb5a98fcd5309decb7724a29807ccca Mon Sep 17 00:00:00 2001 From: William Petit Date: Mon, 17 Oct 2022 16:35:03 +0200 Subject: [PATCH] doc(container): add buildAndPublishImage parameters documentation --- vars/container.groovy | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/vars/container.groovy b/vars/container.groovy index 457597b..da1ecb6 100644 --- a/vars/container.groovy +++ b/vars/container.groovy @@ -1,3 +1,18 @@ +/** +* Construit, valide et publie (optionnellement) une image Docker sur le registre Cadoles (par défaut) +* +* Options disponibles: +* +* - dockerfile - String - Chemin vers le fichier Dockerfile à utiliser pour construire l'image, par défaut "./Dockerfile" +* - contextDir - String - Répertoire servant de "contexte" pour la construction de l'image, par défault "./" +* - imageName - String - Nom de l'image à construire, par défaut "" +* - imageTag - String - Tag apposé sur l'image après construction, par défaut résultat de la commande `git describe --always` +* - gitCredentialsId - String - Identifiant des "credentials" Jenkins utilisés pour cloner le dépôt Git, par défaut "forge-jenkins" +* - dockerRepository - String - Nom d'hôte du registre Docker sur lequel publier l'image, par défaut "reg.cadoles.com" +* - dockerRepositoryCredentialsId - String - Identifiant des "credentials" Jenkins utilisés pour déployer l'image sur le registre Docker, par défault "reg.cadoles.com-jenkins" +* - dryRun - Boolean - Désactiver/activer la publication de l'image sur le registre Docker, par défaut "true" +* - skipVerifications - Boolean - Désactiver/activer les étapes de vérifications de qualité/sécurité de l'image Docker, par défaut "false" +*/ String buildAndPublishImage(Map options = [:]) { String dockerfile = options.get('dockerfile', './Dockerfile') String contextDir = options.get('contextDir', '.')