Git plugin configuration in Jenkins - Commands & Configuration

Introduction

Jenkins uses the Git plugin to connect to Git repositories. This plugin helps Jenkins download your code so it can build and test it automatically.

When you want Jenkins to get the latest code from a GitHub repository before building.

When you need Jenkins to track changes in a Git repository and trigger builds automatically.

When you want to specify which branch Jenkins should build from.

When you want Jenkins to use credentials to access private Git repositories.

When you want Jenkins to clone a repository with specific options like shallow clone.

Commands

This command installs the Git plugin in Jenkins so it can connect to Git repositories.

Terminal

java -jar jenkins-cli.jar -s http://localhost:8080 install-plugin git

Expected Output

Installing plugin: git

Downloading plugin git

Success

Restart Jenkins to activate the plugin.

This command creates a Jenkins job configured to use the Git plugin with the settings defined in example-job-config.xml.

Terminal

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

Expected Output

Created job: example-job

This command retrieves the configuration of the Jenkins job to verify the Git plugin settings.

Terminal

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

Expected Output

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

<project>

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

    <configVersion>2</configVersion>

    <userRemoteConfigs>

      <hudson.plugins.git.UserRemoteConfig>

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

      </hudson.plugins.git.UserRemoteConfig>

    </userRemoteConfigs>

    <branches>

      <hudson.plugins.git.BranchSpec>

        <name>*/main</name>

      </hudson.plugins.git.BranchSpec>

    </branches>

  </scm>

</project>

Key Concept

If you remember nothing else from Git plugin configuration, remember: Jenkins needs the Git plugin installed and properly set up in the job to fetch your code from the repository.

Common Mistakes

Not installing the Git plugin before configuring jobs.

Jenkins cannot connect to Git repositories without the plugin, so builds will fail.

Always install the Git plugin first using Jenkins CLI or the web interface.

Using incorrect repository URLs or branch names in the job configuration.

Jenkins will fail to clone or checkout the code, causing build errors.

Double-check the repository URL and branch name for typos and correctness.

Not providing credentials for private repositories.

Jenkins cannot access private repos without authentication, so cloning fails.

Add credentials in Jenkins and reference them in the job configuration.

Summary

Install the Git plugin in Jenkins to enable Git repository access.

Create or update Jenkins jobs to use the Git plugin with the correct repository URL and branch.

Verify the job configuration to ensure Git settings are correct before running builds.