Jenkins Cheat Sheet

Updated 2026-04-28

Next Topic: Monitoring & Logging Cheat Sheet

🧠Study flashcards on this topic183 cards · spaced repetition→

Jenkins is an open-source automation server that orchestrates continuous integration and continuous delivery (CI/CD) workflows through pipelines defined as code. Originally forked from Hudson in 2011, Jenkins powers CI/CD pipelines across millions of projects by executing builds, running tests, and deploying applications through a distributed architecture of controllers (formerly masters) and agents (formerly slaves). Its plugin ecosystem of 2000+ plugins — combined with Pipeline-as-Code via Jenkinsfiles stored in source control — enables teams to automate every stage from commit to production. A key mental model: Jenkins itself does almost nothing; all real work is delegated to agents, orchestrated by the controller, and expressed as code in a Jenkinsfile.

What This Cheat Sheet Covers

This topic spans 28 focused tables and 266 indexed concepts, 183 flashcards. Below is a complete table-by-table outline of this topic, spanning foundational concepts through advanced details.

Table 1: Pipeline TypesTable 2: Jenkinsfile Core DirectivesTable 3: Common Pipeline StepsTable 4: Agent ConfigurationTable 5: Kubernetes Pod AgentsTable 6: When ConditionsTable 7: Build ParametersTable 8: TriggersTable 9: Post ConditionsTable 10: Options DirectiveTable 11: Credentials ManagementTable 12: Environment VariablesTable 13: Docker IntegrationTable 14: Parallel ExecutionTable 15: Error HandlingTable 16: Pipeline Testing & Quality GatesTable 17: Job TypesTable 18: SCM IntegrationTable 19: Workspace ManagementTable 20: Testing and ReportingTable 21: NotificationsTable 22: Build Tools IntegrationTable 23: Essential PluginsTable 24: Security and Access ControlTable 25: REST API UsageTable 26: Configuration as Code (JCasC)Table 27: Performance and OptimizationTable 28: Observability and Monitoring

Quick IndexSubscribe to unlock

A jump-to index of every table row in this cheat sheet.

Mind MapSubscribe to unlock

An interactive map of every table and concept in this topic.

Table 1: Pipeline Types

The first decision on any new Jenkins setup is how you express a pipeline. Declarative and Scripted are the two ways to write a single Jenkinsfile, while Multibranch, Organization Folder, and Shared Library are scaling patterns layered on top — auto-discovering branches, whole orgs, or factoring common logic into a reusable repo.

Type	Example	Description
Declarative Pipeline	`pipeline {` `agent any` `stages {` `stage('Build') {` `steps { sh 'make' }` `}` `}` `}`	• Structured syntax with predefined sections (`pipeline`, `agent`, `stages`, `steps`) • enforces best practices and provides clear validation errors; preferred for new pipelines.
Scripted Pipeline	`node {` `stage('Build') {` `sh 'make'` `}` `}`	• Groovy-based imperative syntax offering maximum flexibility for complex logic • uses `node` blocks; reserve for cases Declarative cannot handle.
Multibranch Pipeline	Automatically scans repository for branches with `Jenkinsfile`	• Auto-discovers branches and PRs and creates sub-pipelines for each • single job definition manages unlimited branches.
Organization Folder	Scans entire GitHub/Bitbucket/GitLab org	• Discovers all repositories in an organization and creates multibranch jobs automatically • preferred over multibranch for enterprise scale.
Shared Library	`@Library('my-lib') _` `buildApp('java')`	• Reusable pipeline code stored in a separate Git repo; loaded with `@Library` • eliminates duplication across projects; structure: `vars/`, `src/`, `resources/`.

Table 2: Jenkinsfile Core Directives

These are the building blocks of every Declarative Jenkinsfile. pipeline, agent, stages, stage, and steps form the required skeleton; the rest — post, environment, options, when, parallel, matrix and friends — bolt on the behavior that turns a basic build into a real CI/CD workflow. Knowing which directive lives at which nesting level is half the battle when writing pipelines from scratch.

Directive	Example	Description
pipeline	`pipeline { ... }`	• Top-level wrapper for Declarative Pipelines • must enclose all other directives.

The rest of this section is part of the full cheat sheet

Table 3: Common Pipeline Steps

Steps are the verbs of a pipeline — the actual commands that run inside a steps block. This is the working vocabulary you reach for daily: shell and batch execution, SCM checkout, credential injection, artifact archiving, file manipulation, flow control like retry and timeout, and notifications. Most pipelines are just a handful of these composed together.

Step	Example	Description
sh	`sh 'mvn clean install'`	• Executes shell commands on Unix/Linux agents • returns exit code • non-zero exit fails the build.

The rest of this section is part of the full cheat sheet

Table 4: Agent Configuration

The agent directive answers where the work actually executes. The options range from "anywhere available" to label-targeted nodes, ephemeral Docker containers, on-demand Kubernetes pods, and static SSH machines — and the choice drives reproducibility, isolation, and how much your build farm costs to keep running.

Type	Example	Description
any	`agent any`	• Runs on any available agent • Jenkins selects based on availability and labels.

The rest of this section is part of the full cheat sheet

Table 1: Pipeline Types

Type	Example	Description
Declarative Pipeline	`pipeline {` `agent any` `stages {` `stage('Build') {` `steps { sh 'make' }` `}` `}` `}`	• Structured syntax with predefined sections (`pipeline`, `agent`, `stages`, `steps`) • enforces best practices and provides clear validation errors; preferred for new pipelines.
Scripted Pipeline	`node {` `stage('Build') {` `sh 'make'` `}` `}`	• Groovy-based imperative syntax offering maximum flexibility for complex logic • uses `node` blocks; reserve for cases Declarative cannot handle.
Multibranch Pipeline	Automatically scans repository for branches with `Jenkinsfile`	• Auto-discovers branches and PRs and creates sub-pipelines for each • single job definition manages unlimited branches.
Organization Folder	Scans entire GitHub/Bitbucket/GitLab org	• Discovers all repositories in an organization and creates multibranch jobs automatically • preferred over multibranch for enterprise scale.
Shared Library	`@Library('my-lib') _` `buildApp('java')`	• Reusable pipeline code stored in a separate Git repo; loaded with `@Library` • eliminates duplication across projects; structure: `vars/`, `src/`, `resources/`.

Table 2: Jenkinsfile Core Directives

Directive	Example	Description
pipeline	`pipeline { ... }`	• Top-level wrapper for Declarative Pipelines • must enclose all other directives.

Table 3: Common Pipeline Steps

Step	Example	Description
sh	`sh 'mvn clean install'`	• Executes shell commands on Unix/Linux agents • returns exit code • non-zero exit fails the build.

Table 4: Agent Configuration

Type	Example	Description
any	`agent any`	• Runs on any available agent • Jenkins selects based on availability and labels.