Git plugin configuration in Jenkins - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the purpose of the Git plugin in Jenkins?

The Git plugin allows Jenkins to connect to Git repositories to clone, fetch, and manage source code for builds.

beginner

Which Jenkins field specifies the Git repository URL in the Git plugin configuration?

The 'Repository URL' field is where you enter the Git repository's HTTPS or SSH URL.

intermediate

How do you provide credentials for private Git repositories in Jenkins Git plugin?

You add credentials in Jenkins and select them in the Git plugin under 'Credentials' to allow Jenkins to access private repos.

beginner

What does the 'Branches to build' field control in the Git plugin?

It specifies which branch or branches Jenkins should check out and build, e.g., 'main' or 'feature/*'.

intermediate

How can you configure Jenkins Git plugin to clean the workspace before building?

Enable the 'Clean before checkout' option to remove old files and ensure a fresh copy of the repository.

In Jenkins Git plugin, where do you enter the URL of the Git repository?

A Repository URL field

B Build Triggers section

C Post-build Actions

D Pipeline Script

The Repository URL field is used to specify the Git repository location.

How does Jenkins authenticate to a private Git repository using the Git plugin?

A By entering username and password in the build script

B By configuring Jenkins system environment variables

C By using anonymous access

D By selecting stored credentials in the plugin configuration

Jenkins uses stored credentials selected in the Git plugin to authenticate securely.

What is the effect of setting 'Branches to build' to 'main' in the Git plugin?

A Jenkins builds all branches

B Jenkins builds only the main branch

C Jenkins ignores the main branch

D Jenkins builds only tags

Specifying 'main' means Jenkins will check out and build only the main branch.

Which option ensures Jenkins cleans the workspace before checking out the Git repository?

A Disable submodules

B Shallow clone

C Clean before checkout

D Sparse checkout

The 'Clean before checkout' option removes old files to avoid conflicts.

What type of URL can be used in the Git plugin's Repository URL field?

A HTTPS or SSH Git URLs

B Only HTTP URLs

C Only local file paths

D FTP URLs

The Git plugin supports both HTTPS and SSH URLs for repositories.

Describe how to configure Jenkins Git plugin to build a private repository branch.

Think about URL, credentials, and branch settings.

Explain the purpose of the 'Clean before checkout' option in Jenkins Git plugin.

Consider workspace cleanliness before build.

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