Maîtrisez Jenkins pour l'intégration continue. Commandes CLI, configuration des pipelines et automatisation du déploiement.
java -jar jenkins-cli.jar
Utilitaire CLI pour interagir avec Jenkins
-s--url-auth--username--password-i--identity-p--port-noCertificateCheck-noKeyAuth-http-ssh-remoting
java -jar jenkins-cli.jar help
Affiche l'aide des commandes CLI Jenkins
java -jar jenkins-cli.jar list-jobs
Liste tous les jobs Jenkins
--name-n--filter-f
java -jar jenkins-cli.jar build
Déclenche un build Jenkins
-s--parameter-p-v--verbose-f--follow
java -jar jenkins-cli.jar console
Affiche la sortie console d'un build
-f--follow-n--lines
java -jar jenkins-cli.jar get-job
Récupère la configuration XML d'un job
-o--output
java -jar jenkins-cli.jar create-job
Crée un nouveau job depuis un fichier XML
java -jar jenkins-cli.jar update-job
Met à jour la configuration d'un job
java -jar jenkins-cli.jar delete-job
Supprime un job Jenkins
java -jar jenkins-cli.jar enable-job
Active un job Jenkins
java -jar jenkins-cli.jar disable-job
Désactive un job Jenkins
java -jar jenkins-cli.jar restart
Redémarre Jenkins
-f--force--safe
java -jar jenkins-cli.jar safe-restart
Redémarre Jenkins en mode safe
java -jar jenkins-cli.jar shutdown
Arrête Jenkins
java -jar jenkins-cli.jar safe-shutdown
Arrête Jenkins en mode safe
java -jar jenkins-cli.jar quiet-down
Met Jenkins en mode maintenance
java -jar jenkins-cli.jar cancel-quiet-down
Annule le mode maintenance
java -jar jenkins-cli.jar version
Affiche la version de Jenkins
java -jar jenkins-cli.jar who-am-i
Affiche l'utilisateur courant
java -jar jenkins-cli.jar list-plugins
Liste les plugins installés
--name-n--filter-f--version
java -jar jenkins-cli.jar install-plugin
Installe un plugin
-deploy-restart-name-version
java -jar jenkins-cli.jar groovy
Exécute un script Groovy
java -jar jenkins-cli.jar groovysh
Lance le shell Groovy interactif
java -jar jenkins-cli.jar reload-configuration
Recharge la configuration depuis le disque
java -jar jenkins-cli.jar set-build-description
Définit la description d'un build
java -jar jenkins-cli.jar set-build-display-name
Définit le nom d'affichage d'un build
java -jar jenkins-cli.jar delete-builds
Supprime des builds
--range--keep
java -jar jenkins-cli.jar keep-build
Marque un build comme à conserver
java -jar jenkins-cli.jar wipe-out-workspace
Nettoie le workspace d'un job
java -jar jenkins-cli.jar replay-pipeline
Rejoue un pipeline
java -jar jenkins-cli.jar stop-builds
Arrête tous les builds en cours
java -jar jenkins-cli.jar term-builds
Termine tous les builds en cours
java -jar jenkins-cli.jar mail
Lit les mails Jenkins
java -jar jenkins-cli.jar clear-queue
Vide la file d'attente des builds
java -jar jenkins-cli.jar wait-node-online
Attend qu'un nœud soit en ligne
-w--wait
java -jar jenkins-cli.jar offline-node
Met un nœud hors ligne
-m--message
java -jar jenkins-cli.jar online-node
Met un nœud en ligne
java -jar jenkins-cli.jar disconnect-node
Déconnecte un agent
-m--message
java -jar jenkins-cli.jar connect-node
Connecte un agent
-f--force
java -jar jenkins-cli.jar list-credentials
Liste les credentials
--system--domain--store
java -jar jenkins-cli.jar create-credentials-by-xml
Crée des credentials depuis XML
java -jar jenkins-cli.jar update-credentials-by-xml
Met à jour des credentials depuis XML
java -jar jenkins-cli.jar delete-credentials
Supprime des credentials
systemctl start jenkins
Démarre le service Jenkins (Linux systemd)
systemctl stop jenkins
Arrête le service Jenkins (Linux systemd)
systemctl restart jenkins
Redémarre le service Jenkins (Linux systemd)
systemctl status jenkins
Affiche le statut du service Jenkins
systemctl enable jenkins
Active Jenkins au démarrage
journalctl -u jenkins
Affiche les logs du service Jenkins
-f--follow-n--lines--since--until
service jenkins start
Démarre Jenkins (SysVinit)
service jenkins stop
Arrête Jenkins (SysVinit)
service jenkins restart
Redémarre Jenkins (SysVinit)
docker run -p 8080:8080 -p 50000:50000 jenkins/jenkins:lts
Lance Jenkins avec Docker
-d--detach-v--volume-e--env--name--restart
docker exec jenkins cat /var/jenkins_home/secrets/initialAdminPassword
Affiche le mot de passe initial Jenkins (Docker)
wget http://localhost:8080/jnlpJars/jenkins-cli.jar
Télécharge le client CLI Jenkins
-O--output-document
curl -X POST http://localhost:8080/job/MON_JOB/build
Déclenche un build via API REST
--user-u--data-d--header-H
curl http://localhost:8080/job/MON_JOB/lastBuild/api/json
Récupère les infos du dernier build en JSON
--user-u--silent-s
curl -X POST http://localhost:8080/job/MON_JOB/doDelete
Supprime un job via API REST
--user-u
curl -X POST http://localhost:8080/job/MON_JOB/disable
Désactive un job via API REST
--user-u
curl -X POST http://localhost:8080/job/MON_JOB/enable
Active un job via API REST
--user-u
curl http://localhost:8080/api/json
Récupère les informations du serveur Jenkins
--user-u
curl http://localhost:8080/queue/api/json
Affiche la file d'attente Jenkins
--user-u
curl http://localhost:8080/computer/api/json
Liste les nœuds Jenkins
--user-u
curl -X POST http://localhost:8080/safeRestart
Redémarre Jenkins en mode safe via API
--user-u
curl -X POST http://localhost:8080/quietDown
Met Jenkins en mode maintenance via API
--user-u
curl -X POST http://localhost:8080/cancelQuietDown
Annule le mode maintenance via API
--user-u
pipeline
Mot-clé déclaratif pour définir un Pipeline Jenkins
agentstagesstagestepsenvironmenttoolsoptionsparameterstriggerswhenpostparallelmatrixlibrariestools
node
Alloue un exécuteur et exécute le code dans un workspace (Scripted Pipeline)
agent
Spécifie où le Pipeline ou stage doit s'exécuter
anynonelabelnodedockerdockerfilekubernetes
stages
Conteneur pour une séquence d'étapes (stages)
stage
Définit une étape du Pipeline
name
steps
Définit une série d'étapes à exécuter dans un stage
sh
Exécute une commande shell (Unix/Linux)
scriptreturnStdoutreturnStatusencodinglabel
bat
Exécute une commande batch (Windows)
scriptreturnStdoutreturnStatusencodinglabel
powershell
Exécute un script PowerShell
scriptreturnStdoutreturnStatusencodinglabel
echo
Affiche un message dans la console
message
checkout
Récupère le code source depuis un SCM
scmpollchangelog
git
Étape pour cloner un dépôt Git
urlbranchchangelogcredentialsIdpoll
environment
Définit des variables d'environnement
tools
Définit les outils à installer automatiquement
mavenjdkgradlenodejsgopython
options
Configure des options spécifiques au Pipeline
buildDiscarderdisableConcurrentBuildsoverrideIndexTriggersskipDefaultCheckoutskipStagesAfterUnstablecheckoutToSubdirectorynewContainerPerStagetimeoutretrytimestampsansiColorwithCredentialslock
parameters
Définit les paramètres du build
stringtextbooleanParamchoicepasswordfilerun
triggers
Définit les déclencheurs du Pipeline
cronpollSCMupstream
when
Exécute un stage conditionnellement
branchbuildingTagchangelogchangesetchangeRequestenvironmentequalsexpressiontagnotallOfanyOftriggeredBy
post
Exécute des actions après la fin du Pipeline ou d'un stage
alwayschangedfixedregressionabortedfailuresuccessunstableunsuccessfulcleanup
parallel
Exécute des stages en parallèle
failFast
matrix
Exécute des combinaisons de stages
axesstagesexcludes
input
Pause le Pipeline et attend une interaction humaine
idmessageoksubmittersubmitterParameterparameters
timeout
Limite le temps d'exécution d'un bloc
timeunitactivity
retry
Réessaie un bloc en cas d'échec
countconditions
waitUntil
Attend qu'une condition soit vraie
initialDelayquiet
catchError
Capture les erreurs et définit le résultat du build
messagestageResultbuildResultcatchInterruptions
dir
Change de répertoire courant pour un bloc
path
fileExists
Vérifie si un fichier existe dans le workspace
file
findFiles
Trouve des fichiers correspondant à un pattern
globexcludes
isUnix
Retourne true si le nœud est Unix/Linux
pwd
Affiche le répertoire courant
tmp
writeFile
Écrit du contenu dans un fichier
filetextencoding
readFile
Lit le contenu d'un fichier
fileencoding
readJSON
Lit un fichier JSON et retourne un objet
filetextpath
writeJSON
Écrit un objet au format JSON
filejsonpretty
readYaml
Lit un fichier YAML et retourne un objet
filetext
writeYaml
Écrit un objet au format YAML
filedatacharset
readMavenPom
Lit un fichier pom.xml Maven
file
readManifest
Lit un fichier MANIFEST.MF
filejarfile
readProperties
Lit un fichier de propriétés
filetextinterpolate
writeMavenPom
Écrit un fichier pom.xml Maven
modelfile
archiveArtifacts
Archive les artefacts de build
artifactsallowEmptyArchivecaseSensitivedefaultExcludesexcludesfingerprintonlyIfSuccessful
fingerprint
Enregistre les empreintes de fichiers
targetsfiles
stash
Sauvegarde des fichiers pour les réutiliser plus tard
nameincludesexcludesallowEmptyuseDefaultExcludes
unstash
Restaure des fichiers précédemment sauvegardés
name
deleteDir
Supprime le répertoire courant
cleanWs
Nettoie le workspace
cleanWhenAbortedcleanWhenFailurecleanWhenNotBuiltcleanWhenSuccesscleanWhenUnstabledeleteDirsdisableDeferredWipeoutexternalDeletenotFailBuildpatterns
junit
Archive et analyse les résultats de tests JUnit
testResultsallowEmptyResultschecksNamehealthScaleFactorkeepLongStdioskipMarkingBuildUnstableskipPublishingChecks
jacoco
Publie le rapport de couverture JaCoCo
execPatternclassPatternsourcePatterninclusionPatternexclusionPatternminimumBranchCoverageminimumClassCoverageminimumComplexityCoverageminimumInstructionCoverageminimumLineCoverageminimumMethodCoveragechangeBuildStatusrunAlways
cobertura
Publie le rapport de couverture Cobertura
coberturaReportFileonlyStablefailUnhealthyfailUnstableautoUpdateHealthautoUpdateStabilityzoomCoverageChartrunAlwayssourceEncodingmaximumNumberOfBuilds
checkstyle
Publie les résultats Checkstyle
patterncanRunOnFailedshouldDetectModuleshealthyunHealthythresholdLimitdefaultEncoding
pmd
Publie les résultats PMD
patterncanRunOnFailedshouldDetectModuleshealthyunHealthythresholdLimitdefaultEncoding
findbugs
Publie les résultats FindBugs
patterncanRunOnFailedshouldDetectModuleshealthyunHealthythresholdLimitdefaultEncodingisRankActivated
spotbugs
Publie les résultats SpotBugs
patterncanRunOnFailedshouldDetectModuleshealthyunHealthythresholdLimitdefaultEncodinguseRank
dependencyCheckPublisher
Publie le rapport OWASP Dependency-Check
patternfailedTotalCriticalfailedTotalHighfailedTotalMediumfailedTotalLow
publishHTML
Publie un rapport HTML
reportDirreportFilesreportNameallowMissingalwaysLinkToLastBuildkeepAllincludes
emailext
Envoie un email étendu
subjectbodytofromreplyToccbccrecipientProvidersattachmentsPatternattachLogcompressLogmimeTypepostsendScriptpresendScript
mail
Envoie un email simple
tofromsubjectbodybcccharsetmimeTypereplyTo
slackSend
Envoie un message Slack
channelcolormessagetokenbotUsericonEmojiusernameattachmentsbaseUrlteamDomain
build
Déclenche un autre job Jenkins
jobparameterspropagatequietPeriodwait
build job
Syntaxe alternative pour déclencher un job
copyArtifacts
Copie les artefacts d'un autre build
projectNamefilterexcludesselectorparametersflattenoptionaltargetfingerprintArtifactsresultVariableSuffix
milestone
Ordonne l'exécution des builds
labelordinal
lock
Verrouille une ressource
resourceinversePrecedencequantityskipIfLockedvariable
library
Charge une bibliothèque partagée
identifierretrieverchangelog
libraryResource
Lit une ressource depuis une bibliothèque partagée
resourceencoding
properties
Définit les propriétés du job
disableConcurrentBuilds
Empêche l'exécution concurrente d'un job
abortPrevious
disableResume
Désactive la reprise du Pipeline après redémarrage
newContainerPerStage
Crée un nouveau conteneur Docker par stage
preserveStashes
Préserve les stashes pour les builds relancés
quietPeriod
Définit une période d'attente avant build
retry
Réessaie l'exécution du job
script
Exécute un script Groovy dans le Pipeline
skipDefaultCheckout
Désactive le checkout par défaut
skipStagesAfterUnstable
Ignore les stages suivants si le build est instable
timeout
Définit un timeout global pour le job
timestamps
Ajoute des horodatages dans la console
waitForBuild
Attend la fin d'un build déclenché
warnError
Capture les erreurs et marque le build comme instable
withChecks
Publie des checks GitHub
withContext
Définit un contexte pour les étapes
withCredentials
Lie des credentials à un bloc
bindings
withEnv
Définit des variables d'environnement pour un bloc