Git repository configuration in Jenkins - Commands & Configuration

Introduction

When you want Jenkins to get your project code, you need to tell it where your Git repository is. This setup helps Jenkins find and use your code automatically.

When you want Jenkins to build your project from the latest code in GitHub.

When you need Jenkins to test your code every time someone adds new changes.

When you want Jenkins to deploy your app using the code stored in a Git repository.

When you want to automate your software delivery by connecting Jenkins with your Git repo.

When you want Jenkins to track different branches or tags in your Git repository.

Commands

This command creates a new Jenkins job named 'my-job' using the configuration defined in 'config.xml', which includes the Git repository settings.

Terminal

java -jar jenkins-cli.jar -s http://localhost:8080 create-job my-job < config.xml

Expected Output

Created job: my-job

This command retrieves the configuration of the Jenkins job 'my-job' to verify the Git repository settings are correctly applied.

Terminal

java -jar jenkins-cli.jar -s http://localhost:8080 get-job my-job

Expected Output

<?xml version="1.0" encoding="UTF-8"?>

<project>

  <scm class="hudson.plugins.git.GitSCM" plugin="git@4.10.0">

    <configVersion>2</configVersion>

    <userRemoteConfigs>

      <hudson.plugins.git.UserRemoteConfig>

        <url>https://github.com/example-user/example-repo.git</url>

      </hudson.plugins.git.UserRemoteConfig>

    </userRemoteConfigs>

    <branches>

      <hudson.plugins.git.BranchSpec>

        <name>*/main</name>

      </hudson.plugins.git.BranchSpec>

    </branches>

  </scm>

</project>

This command starts a build of the 'my-job' Jenkins job, which will clone the Git repository and run the configured build steps.

Terminal

java -jar jenkins-cli.jar -s http://localhost:8080 build my-job

Expected Output

Started build #1 for job my-job

This command shows the console output of build number 1 of the 'my-job' to check if the Git repository was cloned successfully.

Terminal

java -jar jenkins-cli.jar -s http://localhost:8080 console my-job 1

Expected Output

[Pipeline] Start of Pipeline

Cloning repository https://github.com/example-user/example-repo.git

Checking out Revision abcdef1234567890abcdef1234567890abcdef12 (main)

[Pipeline] End of Pipeline

Finished: SUCCESS

Key Concept

If you remember nothing else from this pattern, remember: Jenkins needs the exact Git repository URL and branch to fetch your code automatically.

Common Mistakes

Using an incorrect or incomplete Git repository URL in Jenkins job configuration.

Jenkins cannot find or clone the repository, causing build failures.

Always use the full HTTPS or SSH URL of the Git repository, including the correct protocol and domain.

Not specifying the branch name or using a wrong branch pattern.

Jenkins may build the wrong branch or fail to find the branch, leading to unexpected code versions.

Specify the correct branch pattern like '*/main' or '*/master' to match the branch you want Jenkins to build.

Not providing credentials when the Git repository is private.

Jenkins cannot access the repository and cloning fails.

Configure Jenkins with proper credentials (SSH keys or username/password) to access private repositories.

Summary

Create a Jenkins job with Git repository URL and branch configured.

Verify the job configuration to ensure the Git settings are correct.

Trigger a build to let Jenkins clone the repository and run the pipeline.

Check build logs to confirm the repository was cloned successfully.

Practice

1. What is the main purpose of configuring a Git repository in Jenkins?

easy

A. To set the Jenkins server's IP address

B. To tell Jenkins where to find the source code for building

C. To configure Jenkins user permissions

D. To install Jenkins plugins automatically

Solution

1. Step 1: Understand Jenkins and Git integration

   Jenkins needs to know the location of the source code to build and test it automatically.

2. Step 2: Identify the role of Git repository configuration

   Configuring the Git repository provides Jenkins with the URL and branch to fetch the code.

3. Final Answer:

   To tell Jenkins where to find the source code for building -> Option B

4. Quick Check:

   Git repo config = source code location [OK]

Hint: Git repo config tells Jenkins where code lives [OK]

Common Mistakes:

• Confusing repository URL with Jenkins server settings
• Thinking Git config sets user permissions
• Assuming it installs plugins automatically

2. Which of the following is the correct way to specify a Git repository URL in Jenkins?

easy

A. C:\Users\repo

B. http://jenkins.local/repo.git

C. [e-mail]:user/repo.git

D. ftp://github.com/user/repo.git

Solution

1. Step 1: Identify valid Git repository URL formats

   Git URLs typically use SSH (git@...) or HTTPS (https://...) protocols.

2. Step 2: Check each option's format

   [e-mail]:user/repo.git uses SSH format, which is valid. http://jenkins.local/repo.git is a Jenkins URL, not a Git repo. C:\Users\repo is a Windows path, not a URL. ftp://github.com/user/repo.git uses FTP, which Git does not use.

3. Final Answer:

   [e-mail]:user/repo.git -> Option C

4. Quick Check:

   SSH or HTTPS URL = valid Git repo URL [OK]

Hint: Git URLs use SSH or HTTPS, not local paths or FTP [OK]

Common Mistakes:

• Using local file paths instead of URLs
• Confusing Jenkins URLs with Git URLs
• Using unsupported protocols like FTP

3. Given this Jenkins Git configuration snippet:

Repository URL: https://github.com/example/project.git
Branch Specifier: feature-branch

What will Jenkins do when it runs a build?

medium

A. Clone the 'feature-branch' branch from the repository

B. Fail because branch specifier is missing

C. Clone all branches from the repository

D. Clone the 'main' branch from the repository

Solution

1. Step 1: Understand the Branch Specifier field

   The Branch Specifier tells Jenkins which branch to clone and build.

2. Step 2: Analyze the given branch specifier

   The branch is set to 'feature-branch', so Jenkins will clone that specific branch.

3. Final Answer:

   Clone the 'feature-branch' branch from the repository -> Option A

4. Quick Check:

   Branch Specifier = selected branch [OK]

Hint: Branch Specifier sets which branch Jenkins clones [OK]

Common Mistakes:

• Assuming Jenkins always clones 'main' branch
• Thinking Jenkins clones all branches by default
• Believing branch specifier can be empty

4. You configured Jenkins with this Git repository URL:
https://github.com/example/project.git
But the build fails with authentication errors. What is the most likely cause?

medium

A. Credentials are missing or incorrect in Jenkins Git config

B. The branch name is misspelled

C. The repository URL is incorrect

D. Jenkins server is offline

Solution

1. Step 1: Understand authentication in Git with Jenkins

   Private repositories require credentials for Jenkins to access them.

2. Step 2: Analyze the error cause

   Authentication errors usually mean Jenkins lacks correct credentials or they are not configured.

3. Final Answer:

   Credentials are missing or incorrect in Jenkins Git config -> Option A

4. Quick Check:

   Authentication error = check credentials [OK]

Hint: Authentication errors mean missing or wrong credentials [OK]

Common Mistakes:

• Assuming URL is always wrong for auth errors
• Ignoring credentials setup in Jenkins
• Blaming branch name for authentication issues

5. You want Jenkins to build code from a private Git repository using SSH keys. Which steps must you take to configure this correctly?

hard

A. Upload the repository code manually to Jenkins workspace

B. Use HTTPS URL and enter username/password in Jenkins Git config

C. Set the repository URL to HTTP and disable authentication

D. Add the SSH private key in Jenkins credentials and use the SSH Git URL

Solution

1. Step 1: Use SSH URL for private repo access

   SSH URLs look like [e-mail]:user/repo.git and allow key-based authentication.

2. Step 2: Add SSH private key to Jenkins credentials

   Jenkins needs the private key stored securely to authenticate with the Git server.

3. Step 3: Configure Jenkins Git plugin to use SSH URL and credentials

   Set the repository URL to the SSH format and select the SSH key credential in Jenkins.

4. Final Answer:

   Add the SSH private key in Jenkins credentials and use the SSH Git URL -> Option D

5. Quick Check:

   SSH key + SSH URL = secure private repo access [OK]

Hint: Use SSH URL + private key credential for private repos [OK]

Common Mistakes:

• Using HTTP URL without credentials for private repos
• Trying to disable authentication for private repos
• Uploading code manually instead of using Git