Git plugin configuration in Jenkins - Step-by-Step Execution

Process Flow - Git plugin configuration

Start Jenkins Job Configuration

↓

Select Git Plugin as SCM

↓

Enter Repository URL

↓

Set Credentials (if needed)

↓

Configure Branches to Build

↓

Optional: Add Additional Behaviors

↓

Save Configuration

↓

Trigger Build -> Git Plugin Clones Repo

↓

Build Uses Cloned Code

↓

End

This flow shows how Jenkins uses the Git plugin to connect to a repository, configure branches, and prepare code for building.

Execution Sample

Jenkins

pipeline {
  agent any
  stages {
    stage('Checkout') {
      steps {
        git url: 'https://github.com/example/repo.git', branch: 'main'
      }
    }
  }
}

This Jenkins pipeline script uses the Git plugin to clone the 'main' branch from the specified GitHub repository.

Process Table

Step	Action	Input/Config	Result
1	Start Jenkins Job Configuration	N/A	Job configuration page opens
2	Select Git Plugin as SCM	Git selected	Git plugin UI appears
3	Enter Repository URL	https://github.com/example/repo.git	URL saved
4	Set Credentials	None (public repo)	No credentials needed
5	Configure Branches to Build	Branch: main	Branch set to main
6	Optional: Add Additional Behaviors	None	Default behaviors used
7	Save Configuration	Click Save	Configuration saved
8	Trigger Build	Start build manually or via trigger	Build starts
9	Git Plugin Clones Repo	Cloning https://github.com/example/repo.git branch main	Repository cloned locally
10	Build Uses Cloned Code	Run build steps	Build executes with latest code
11	End	Build completes	Job finishes successfully

💡 Build completes successfully or fails based on build steps after Git clone

Status Tracker

Variable	Start	After Step 3	After Step 5	After Step 9	Final
Repository URL	empty	https://github.com/example/repo.git	https://github.com/example/repo.git	https://github.com/example/repo.git	https://github.com/example/repo.git
Credentials	none	none	none	none	none
Branch	empty	empty	main	main	main
Local Repo State	none	none	none	cloned main branch	cloned main branch

Key Moments - 3 Insights

Why do we need to specify the branch in the Git plugin configuration?

Specifying the branch (see Step 5 in execution_table) tells Jenkins which branch to clone and build. Without it, Jenkins may default to the wrong branch or fail to find code.

What happens if credentials are not set for a private repository?

If credentials are missing for a private repo, the clone step (Step 9) will fail because Jenkins cannot authenticate. This is why credentials must be configured when needed.

Does the Git plugin clone the repository before or after the build starts?

The Git plugin clones the repository during the build process (Step 9), after the build is triggered (Step 8), so the build uses the latest code.

Visual Quiz - 3 Questions

Look at the execution_table, at which step is the branch to build configured?

A Step 3

B Step 7

C Step 5

D Step 9

💡 Hint

Check the 'Configure Branches to Build' action in the execution_table rows.

According to variable_tracker, what is the value of 'Local Repo State' after Step 9?

A empty

B cloned main branch

C none

D branch not set

💡 Hint

Look at the 'Local Repo State' row under 'After Step 9' column.

If the repository URL is incorrect, at which step will the build most likely fail?

A Step 9

B Step 3

C Step 7

D Step 11

💡 Hint

Refer to the 'Git Plugin Clones Repo' step in the execution_table where cloning happens.

Concept Snapshot

Git Plugin Configuration in Jenkins:
- Select Git as SCM in job config
- Enter repository URL
- Set credentials if private repo
- Specify branch to build
- Save config and trigger build
- Git plugin clones repo during build
- Build uses cloned code for execution

Full Transcript

This visual execution shows how to configure the Git plugin in Jenkins. First, you open the job configuration and select Git as the source control. Then you enter the repository URL and set credentials if needed. Next, you specify which branch Jenkins should build. After saving, when the build triggers, the Git plugin clones the repository locally. The build then runs using this cloned code. Variables like repository URL, branch, and local repo state change step-by-step as shown. Key points include the importance of setting the branch and credentials. The build fails at cloning if the URL or credentials are wrong.

Practice

1. What is the primary purpose of the Git plugin in Jenkins?

easy

A. To connect Jenkins jobs to Git repositories and fetch code

B. To build Docker images automatically

C. To deploy applications to cloud servers

D. To monitor server health and performance

Solution

1. Step 1: Understand Jenkins Git plugin role

   The Git plugin is designed to link Jenkins jobs with Git repositories so Jenkins can get the source code.

2. Step 2: Compare options with plugin purpose

   Only To connect Jenkins jobs to Git repositories and fetch code describes fetching code from Git repositories, which is the plugin's main job.

3. Final Answer:

   To connect Jenkins jobs to Git repositories and fetch code -> Option A

4. Quick Check:

   Git plugin = Connect and fetch code [OK]

Hint: Git plugin = connect Jenkins to Git repos [OK]

Common Mistakes:

• Confusing Git plugin with deployment tools
• Thinking Git plugin builds Docker images
• Assuming Git plugin monitors servers

2. Which of the following is the correct syntax to checkout a Git repository in a Jenkins pipeline?

easy

A. checkout git: 'https://github.com/example/repo.git', branch: 'main'

B. git url: 'https://github.com/example/repo.git', branch: 'main'

C. git checkout 'https://github.com/example/repo.git' branch 'main'

D. checkout scm: 'https://github.com/example/repo.git', branch: 'main'

Solution

1. Step 1: Recall Jenkins pipeline git step syntax

   The correct syntax uses the git step with named parameters like url and branch.

2. Step 2: Validate each option

   git url: 'https://github.com/example/repo.git', branch: 'main' matches the correct syntax: git url: '...', branch: '...'. Others are incorrect or invalid syntax.

3. Final Answer:

   git url: 'https://github.com/example/repo.git', branch: 'main' -> Option B

4. Quick Check:

   Use git url: ..., branch: ... syntax [OK]

Hint: Use 'git url: ..., branch: ...' in pipeline [OK]

Common Mistakes:

• Using 'checkout git:' instead of 'git url:'
• Mixing git CLI syntax with Jenkins pipeline
• Using 'checkout scm:' incorrectly

3. Given this Jenkins pipeline snippet:

pipeline {
  agent any
  stages {
    stage('Checkout') {
      steps {
        git url: 'https://github.com/example/repo.git', branch: 'dev'
      }
    }
  }
}

What branch will Jenkins checkout?

medium

A. feature

B. main

C. master

D. dev

Solution

1. Step 1: Identify branch parameter in git step

   The pipeline uses branch: 'dev' in the git step, specifying the branch to checkout.

2. Step 2: Confirm branch checked out

   Jenkins will checkout the 'dev' branch as explicitly set in the pipeline.

3. Final Answer:

   dev -> Option D

4. Quick Check:

   Branch parameter sets checkout branch [OK]

Hint: Look for branch: '...' in git step [OK]

Common Mistakes:

• Assuming default branch 'main' is used
• Confusing 'master' with 'dev'
• Ignoring explicit branch parameter

4. You configured a Jenkins pipeline with:

git url: 'https://github.com/example/repo.git', branch: 'main', credentialsId: 'git-creds'

But Jenkins fails to clone with authentication error. What is the likely cause?

medium

A. The credentialsId is missing or incorrect

B. The branch name is misspelled

C. The git URL is invalid

D. The Jenkins agent is offline

Solution

1. Step 1: Analyze authentication failure cause

   Authentication errors usually mean Jenkins cannot use the provided credentials to access the repo.

2. Step 2: Check credentialsId correctness

   If credentialsId is missing or wrong, Jenkins cannot authenticate, causing failure.

3. Final Answer:

   The credentialsId is missing or incorrect -> Option A

4. Quick Check:

   Authentication error = credentials issue [OK]

Hint: Check credentialsId for authentication errors [OK]

Common Mistakes:

• Blaming branch name for auth errors
• Ignoring credentialsId parameter
• Assuming URL is always the problem

5. You want Jenkins to checkout a private Git repo using SSH keys stored in Jenkins credentials. Which configuration is correct in a pipeline script?

hard

A. git url: 'https://github.com/example/repo.git', credentialsId: 'ssh-key-id'

B. git url: '[e-mail]:example/repo.git', branch: 'main'

C. git url: '[e-mail]:example/repo.git', credentialsId: 'ssh-key-id'

D. git url: 'https://github.com/example/repo.git', branch: 'main'

Solution

1. Step 1: Identify SSH URL format for private repo

   SSH URLs use the format [e-mail]:owner/repo.git to connect via SSH keys.

2. Step 2: Confirm credentialsId usage for SSH keys

   To use stored SSH keys, credentialsId must be set with the SSH key ID.

3. Step 3: Validate options

   git url: '[e-mail]:example/repo.git', credentialsId: 'ssh-key-id' correctly uses SSH URL and credentialsId. The options using HTTPS require username/password or token credentials, not SSH keys. git url: '[e-mail]:example/repo.git', branch: 'main' misses credentialsId.

4. Final Answer:

   git url: '[e-mail]:example/repo.git', credentialsId: 'ssh-key-id' -> Option C

5. Quick Check:

   SSH URL + credentialsId for SSH keys [OK]

Hint: Use SSH URL with credentialsId for SSH keys [OK]

Common Mistakes:

• Using HTTPS URL with SSH credentials
• Omitting credentialsId for private repos
• Confusing branch with credentials