Skip to content

Latest commit

 

History

History
1051 lines (720 loc) · 42.8 KB

README.adoc

File metadata and controls

1051 lines (720 loc) · 42.8 KB

Git Plugin

Build Contributors Jenkins Plugin Installs GitHub release Gitter

Changelog in GitHub Releases

Release notes are recorded in GitHub Releases since July 1, 2019 (git plugin 3.10.1 and later). Prior release notes are recorded in the git plugin repository change log.

Configuration

Repositories

The git plugin fetches commits from one or more remote repositories and performs a checkout in the agent workspace. Repositories and their related information include:

Repository URL

The URL of the remote repository. The git plugin passes the remote repository URL to the git implementation (command line or JGit). Valid repository URL’s include https, ssh, scp, git, local file, and other forms. Valid repository URL forms are described in the git documentation.

Credentials

Credentials are defined using the Jenkins credentials plugin. They are selected from a drop-down list and their identifier is stored in the job definition. Refer to using credentials for more details on supported credential types.

Name

Git uses a shortname to simplify user references to the URL of the remote repository. The default shortname is origin. Other values may be assigned and then used throughout the job definition to refer to the remote repository.

Refspec

A refspec maps remote branches to local references. It defines the branches and tags which will be fetched from the remote repository into the agent workspace.

A refspec defines the remote references that will be retrieved and how they map to local references. If left blank, it will default to the normal git fetch behavior and will retrieve all branches. This default behavior is sufficient for most cases.

The default refspec is +refs/heads/*:refs/remotes/REPOSITORYNAME/ where REPOSITORYNAME is the value you specify in the above repository "Name" field. The default refspec retrieves all branches. If a checkout only needs one branch, then a more restrictive refspec can reduce the data transfer from the remote repository to the agent workspace. For example, +refs/heads/master:refs/remotes/origin/master will retrieve only the master branch and nothing else.

The refspec can be used with the honor refspec on initial clone option in the advanced clone behaviors to limit the number of remote branches mapped to local references. If "honor refspec on initial clone" is not enabled, then a default refspec for its initial fetch. This maintains compatibility with previous behavior and allows the job definition to decide if the refspec should be honored on initial clone.

Multiple refspecs can be entered by separating them with a space character. The refspec value +refs/heads/master:refs/remotes/origin/master +refs/heads/develop:refs/remotes/origin/develop retrieves the master branch and the develop branch and nothing else.

Refer to the git refspec documentation for more refspec details.

Using Credentials

The git plugin supports username / password credentials and private key credentials provided by the Jenkins credentials plugin. It does not support other credential types like secret text, secret file, or certificates. Select credentials from the job definition drop down menu or enter their identifiers in Pipeline job definitions.

Push notification from repository

To minimize the delay between a push and a build, configure the remote repository to use a Webhook to notify Jenkins of changs to the repository. Refer to webhook documentation for your repository:

Other git repositories can use a post-receive hook in the remote repository to notify Jenkins of changes. Add the following line in your hooks/post-receive file on the git server, replacing <URL of the Git repository> with the fully qualified URL you use when cloning the repository.

curl http://yourserver/git/notifyCommit?url=<URL of the Git repository>

This will scan all the jobs that:

  • Have Build Triggers > Poll SCM enabled. No polling schedule is required.

  • Are configured to build the repository at the specified URL

For jobs that meet these conditions, polling will be triggered. If polling finds a change worthy of a build, a build will be triggered.

This allows a notify script to remain the same for all Jenkins jobs. Or if you have multiple repositories under a single repository host application (such as Gitosis), you can share a single post-receive hook script with all the repositories. Finally, this URL doesn’t require authentication even for secured Jenkins, because the server doesn’t directly use anything that the client is sending. It polls to verify that there is a change before it actually starts a build.

When notifyCommit is successful, the list of triggered projects is returned.

Enabling JGit

See the git client plugin documentation for instructions to enable JGit. JGit becomes available throughout Jenkins once it has been enabled.

Global Configuration

In the Configure System page, the Git Plugin provides the following options:

Global Config user.name Value

Defines the default git user name that will be assigned when git commits a change from Jenkins. For example, Janice Examplesperson. This can be overridden by individual projects with the Custom user name/e-mail address extension.

Global Config user.email Value

Defines the default git user e-mail that will be assigned when git commits a change from Jenkins. For example, [email protected]. This can be overridden by individual projects with the Custom user name/e-mail address extension.

Create new accounts based on author/committer’s email

New user accounts are created in Jenkins for committers and authors identified in changelogs. The new user accounts are added to the internal Jenkins database. The e-mail address is used as the id of the account.

Show the entire commit summary in changes

The changes page for each job would truncate the change summary prior to git plugin 4.0. With the release of git plugin 4.0, the default was changed to show the complete change summary. Administrators that want to restore the old behavior may disable this setting.

Repository Browser

A Repository Browser adds links in "changes" views within Jenkins to an external system for browsing the details of those changes. The "Auto" selection attempts to infer the repository browser from the "Repository URL" and can detect Cloud versions of GitHub, Bitbucket and GitLab.

Repository browsers include:

AssemblaWeb

Repository browser for git repositories hosted by Assembla. Options include:

Assembla Git URL

Root URL serving this Assembla repository. For example, https://app.assembla.com/spaces/git-plugin/git/source

FishEye

Repository browser for git repositories hosted by Atlassian Fisheye. Options include:

URL

Root URL serving this FishEye repository. For example, https://fisheye.example.com/browser/my-project

GitLab

Repository browser for git repositories hosted on GitLab.com. No options can be configured for this repository browser. Users hosting their own instances of GitLab should use the gitlab browser instead.

Gitea

Repository browser for git repositories hosted by Gitea. Options include:

Repository URL

Root URL serving this gitea repository. For example, https://gitea.example.com/username/project-name

Kiln

Repository browser for git repositories hosted by Kiln. Options include:

URL

Root URL serving this Kiln repository. For example, https://kiln.example.com/username/my-project

Microsoft Team Foundation Server/Visual Studio Team Services

Repository browser for git repositories hosted by Azure DevOps. Options include:

URL or name

Root URL serving this Azure DevOps repository. For example, https://example.visualstudio.com/_git/my-project.

bitbucketweb

Repository browser for git repositories hosted by Bitbucket. Options include:

URL

Root URL serving this Bitbucket repository. For example, https://bitbucket.example.com/username/my-project

cgit

Repository browser for git repositories hosted by cgit. Options include:

URL

Root URL serving this cgit repository. For example, https://git.zx2c4.com/cgit/

gitblit

GitBlit root url

Root URL serving this GitBlit repository. For example, https://gitblit.example.com/cgit/

Project name in GitBlit

Name of the GitBlit project. For example, my-project

githubweb

Repository browser for git repositories hosted by GitHub. Options include:

GitHub root url

Root URL serving this GitHub repository. For example, https://github.example.com/username/my-project

gitiles

Repository browser for git repositories hosted by Gitiles. Options include:

gitiles root url

Root URL serving this Gitiles repository. For example, https://gerrit.googlesource.com/gitiles/

gitlab

Repository browser for git repositories hosted by GitLab. Options include:

URL

Root URL serving this GitLab repository. For example, https://gitlab.example.com/username/my-project

Version

Major and minor version of GitLab you use, such as 12.6. If you don’t specify a version, a modern version of GitLab (>= 8.0) is assumed. For example, 12.6

gitlist

Repository browser for git repositories hosted by GitList. Options include:

URL

Root URL serving this GitList repository. For example, https://gitlist.example.com/username/my-project

gitoriousweb

Gitorious was acquired in 2015. This browser is deprecated.

URL

Root URL serving this Gitorious repository. For example, https://gitorious.org/username/my-project

gitweb

Repository browser for git repositories hosted by GitWeb. Options include:

URL

Root URL serving this GitWeb repository. For example, https://gitweb.example.com/username/my-project

gogs

Repository browser for git repositories hosted by Gogs. Options include:

URL

Root URL serving this Gogs repository. For example, https://gogs.example.com/username/my-project

phabricator

Repository browser for git repositories hosted by Phacility Phabricator. Options include:

URL

Root URL serving this Phabricator repository. For example, https://phabricator.example.com/

Repository name in Phab

Name of the Phabricator repository. For example, my-project

redmineweb

Repository browser for git repositories hosted by Redmine. Options include:

URL

Root URL serving this Redmine repository. For example, https://redmine.example.com/username/projects/my-project/repository

rhodecode

Repository browser for git repositories hosted by RhodeCode. Options include:

URL

Root URL serving this RhodeCode repository. For example, https://rhodecode.example.com/username/my-project

stash

Stash is now called BitBucket Server. Repository browser for git repositories hosted by BitBucket Server. Options include:

URL

Root URL serving this Stash repository. For example, https://stash.example.com/username/my-project

viewgit

Repository browser for git repositories hosted by viewgit. Options include:

ViewGit root url

Root URL serving this ViewGit repository. For example, https://viewgit.example.com/

Project Name in ViewGit

ViewGit project name. For example, my-project

Extensions

Extensions add new behavior or modify existing plugin behavior for different uses. Extensions help users more precisely tune the plugin to meet their needs.

Extensions include:

Clone Extensions

Advanced clone behaviours

Advanced clone behaviors modify the git clone and git fetch commands. They control:

  • breadth of history retrieval (refspecs)

  • depth of history retrieval (shallow clone)

  • disc space use (reference repositories)

  • duration of the command (timeout)

  • tag retrieval

Advanced clone behaviors include:

Honor refspec on initial clone

Perform initial clone using the refspec defined for the repository. This can save time, data transfer and disk space when you only need to access the references specified by the refspec. If this is not enabled, then the plugin default refspec includes all remote branches.

Shallow clone

Perform a shallow clone by requesting a limited number of commits from the tip of the requested branch(es). Git will not download the complete history of the project. This can save time and disk space when you just want to access the latest version of a repository.

Shallow clone depth

Set shallow clone depth to the specified number of commits. Git will only download depth commits from the remote repository, saving time and disk space.

Path of the reference repo to use during clone

Specify a folder containing a repository that will be used by git as a reference during clone operations. This option will be ignored if the folder is not available on the agent.

Timeout (in minutes) for clone and fetch operations

Specify a timeout (in minutes) for clone and fetch operations.

Fetch tags

Deselect this to perform a clone without tags, saving time and disk space when you want to access only what is specified by the refspec, without considering any repository tags.

Checkout Extensions

Advanced checkout behaviors

Advanced checkout behaviors modify the git checkout command. Advanced checkout behaviors include

Timeout (in minutes) for checkout operation

Specify a timeout (in minutes) for checkout. The checkout is stopped if the timeout is exceeded. Checkout timeout is usually only required with slow file systems or large repositories.

Advanced sub-modules behaviours

Advanced sub-modules behaviors modify the git submodule commands. They control:

  • depth of history retrieval (shallow clone)

  • disc space use (reference repositories)

  • credential use

  • duration of the command (timeout)

  • concurrent threads used to fetch submodules

Advanced sub-modules include:

Disable submodules processing

Ignore submodules in the repository.

Recursively update submodules

Retrieve all submodules recursively. Without this option, submodules which contain other submodules will ignore the contained submodules.

Update tracking submodules to tip of branch

Retrieve the tip of the configured branch in .gitmodules.

Use credentials from default remote of parent repository

Use credentials from the default remote of the parent project. Submodule updates do not use credentials by default. Enabling this extension will provide the parent repository credentials to each of the submodule repositories. Submodule credentials require that the submodule repository must accept the same credentials as the parent project. If the parent project is cloned with https, then the authenticated submodule references must use https as well. If the parent project is cloned with ssh, then the authenticated submodule references must use ssh as well.

Shallow clone

Perform shallow clone of submodules. Git will not download the complete history of the project, saving time and disk space.

Shallow clone depth

Set shallow clone depth for submodules. Git will only download recent history of the project, saving time and disk space.

Path of the reference repo to use during submodule update

Folder containing a repository that will be used by git as a reference during submodule clone operations. This option will be ignored if the folder is not available on the agent running the build. A reference repository may contain multiple subprojects. See the combining repositories section for more details.

Timeout (in minutes) for submodule operations

Specify a timeout (in minutes) for submodules operations. This option overrides the default timeout.

Number of threads to use when updating submodules

Number of parallel processes to be used when updating submodules. Default is to use a single thread for submodule updates

Checkout to a sub-directory

Checkout to a subdirectory of the workspace instead of using the workspace root.

This extension should not be used in Jenkins Pipeline (either declarative or scripted). Jenkins Pipeline already provides standard techniques for checkout to a subdirectory. Use ws and dir in Jenkins Pipeline rather than this extension.

Local subdirectory for repo

Name of the local directory (relative to the workspace root) for the git repository checkout. If left empty, the workspace root itself will be used.

Checkout to specific local branch

Branch name

If given, checkout the revision to build as HEAD on the named branch. If value is an empty string or "**", then the branch name is computed from the remote branch without the origin. In that case, a remote branch 'origin/master' will be checked out to a local branch named 'master', and a remote branch 'origin/develop/new-feature' will be checked out to a local branch named 'develop/new-feature'.

Wipe out repository and force clone

Delete the contents of the workspace before build and before checkout. Deletes the git repository inside the workspace and will force a full clone.

Clean after checkout

Clean the workspace after every checkout by deleting all untracked files and directories, including those which are specified in .gitignore. Resets all tracked files to their versioned state. Ensures that the workspace is in the same state as if clone and checkout were performed in a new workspace. Reduces the risk that current build will be affected by files generated by prior builds. Does not remove files outside the workspace (like temporary files or cache files). Does not remove files in the .git repository of the workspace.

Delete untracked nested repositories

Remove subdirectories which contain .git subdirectories if this option is enabled. This is implemented in command line git as git clean -xffd. Refer to the git clean manual page for more information.

Clean before checkout

Clean the workspace before every checkout by deleting all untracked files and directories, including those which are specified in .gitignore. Resets all tracked files to their versioned state. Ensures that the workspace is in the same state as if cloned and checkout were performed in a new workspace. Reduces the risk that current build will be affected by files generated by prior builds. Does not remove files outside the workspace (like temporary files or cache files). Does not remove files in the .git repository of the workspace.

Delete untracked nested repositories

Remove subdirectories which contain .git subdirectories if this option is enabled. This is implemented in command line git as git clean -xffd. Refer to the git clean manual page for more information.

Git LFS pull after checkout

Enable git large file support for the workspace by pulling large files after the checkout completes. Requires that the master and each agent performing an LFS checkout have installed git lfs.

Changelog Extensions

The plugin can calculate the source code differences between two builds. Changelog extensions adapt the changelog calculations for different cases.

Calculate changelog against a specific branch

'Calculate changelog against a specific branch' uses the specified branch to compute the changelog instead of computing it based on the previous build. This extension can be useful for computing changes related to a known base branch, especially in environments which do not have the concept of a "pull request".

Name of repository

Name of the repository, such as 'origin', that contains the branch.

Name of branch

Name of the branch used for the changelog calculation within the named repository.

Use commit author in changelog

The default behavior is to use the Git commit’s "Committer" value in build changesets. If this option is selected, the git commit’s "Author" value is used instead.

Tagging Extensions

Create a tag for every build

Create a tag in the workspace for every build to unambiguously mark the commit that was built. You can combine this with Git publisher to push the tags to the remote repository.

Build initiation extensions

The git plugin can start builds based on many different conditions.

Don’t trigger a build on commit notifications

If checked, this repository will be ignored when the notifyCommit URL is accessed whether the repository matches or not.

Force polling using workspace

The git plugin polls remotely using ls-remote when configured with a single branch (no wildcards!). When this extension is enabled, the polling is performed from a cloned copy of the workspace instead of using ls-remote.

If this option is selected, polling will use a workspace instead of using ls-remote.

By default, the plugin polls by executing a polling process or thread on the Jenkins master. If the Jenkins master does not have a git installation, the administrator may enable JGit to use a pure Java git implementation for polling. In addition, the administrator may need to disable command line git to prevent use of command line git on the Jenkins master.

Merge Extensions

Merge before build

These options allow you to perform a merge to a particular branch before building. For example, you could specify an integration branch to be built, and to merge to master. In this scenario, on every change of integration, Jenkins will perform a merge with the master branch, and try to perform a build if the merge is successful. It then may push the merge back to the remote repository if the Git Publisher post-build action is selected.

Name of repository

Name of the repository, such as origin, that contains the branch. If left blank, it’ll default to the name of the first repository configured.

Branch to merge to

The name of the branch within the named repository to merge to, such as master.

Merge strategy

Merge strategy selection. Choices include:

  • default

  • resolve

  • recursive

  • octopus

  • ours

  • subtree

  • recursive_theirs

Fast-forward mode
  • --ff: fast-forward which gracefully falls back to a merge commit when required

  • -ff-only: fast-forward without any fallback

  • --no-ff: merge commit always, even if a fast-forward would have been allowed

Custom user name/e-mail address

user.name

Defines the user name value which git will assign to new commits made in the workspace. If given, git config user.name [this] is called before builds. This overrides values from the global settings.

user.email

Defines the user email value which git will assign to new commits made in the workspace. If given, git config user.email [this] is called before builds. This overrides whatever is in the global settings.

Polling ignores commits from certain users

These options allow you to perform a merge to a particular branch before building. For example, you could specify an integration branch to be built, and to merge to master. In this scenario, on every change of integration, Jenkins will perform a merge with the master branch, and try to perform a build if the merge is successful. It then may push the merge back to the remote repository if the Git Push post-build action is selected.

Excluded Users

If set and Jenkins is configured to poll for changes, Jenkins will ignore any revisions committed by users in this list when determining if a build should be triggered. This can be used to exclude commits done by the build itself from triggering another build, assuming the build server commits the change with a distinct SCM user. Using this behavior prevents the faster git ls-remote polling mechanism. It forces polling to require a workspace, as if you had selected the Force polling using workspace extension.

Each exclusion uses literal pattern matching, and must be separated by a new line.

Polling ignores commits in certain paths

If set and Jenkins is configured to poll for changes, Jenkins will pay attention to included and/or excluded files and/or folders when determining if a build needs to be triggered.

Using this behavior will preclude the faster remote polling mechanism, forcing polling to require a workspace thus sometimes triggering unwanted builds, as if you had selected the Force polling using workspace extension as well. This can be used to exclude commits done by the build itself from triggering another build, assuming the build server commits the change with a distinct SCM user. Using this behavior will preclude the faster git ls-remote polling mechanism, forcing polling to require a workspace, as if you had selected the Force polling using workspace extension as well.

Included Regions

Each inclusion uses java regular expression pattern matching, and must be separated by a new line. An empty list implies that everything is included.

Excluded Regions

Each exclusion uses java regular expression pattern matching, and must be separated by a new line. An empty list excludes nothing.

Polling ignores commits with certain messages

Excluded Messages

If set and Jenkins is set to poll for changes, Jenkins will ignore any revisions committed with message matched to the regular expression pattern when determining if a build needs to be triggered. This can be used to exclude commits done by the build itself from triggering another build, assuming the build server commits the change with a distinct message. You can create more complex patterns using embedded flag expressions.

Prune stale remote tracking branches

Removes remote tracking branches from the local workspace if they no longer exist on the remote. See git remote prune and git fetch --prune for more details.

Prune stale tags

Removes tags from the local workspace before fetch if they no longer exist on the remote. If stale tags are not pruned, deletion of a remote tag will not remove the local tag in the workspace. If the local tag already exists in the workspace, git correctly refuses to create the tag again. Pruning stale tags allows the local workspace to create a tag with the same name as a tag which was removed from the remote.

Sparse Checkout paths

Specify the paths that you’d like to sparse checkout. This may be used for saving space (Think about a reference repository). Be sure to use a recent version of Git, at least above 1.7.10.

Multiple sparse checkout path values can be added to a single job.

Path

File or directory to be included in the checkout

Strategy for choosing what to build

When you are interested in using a job to build multiple branches, you can choose how Jenkins chooses the branches to build and the order they should be built.

This extension point in Jenkins is used by many other plugins to control the job as it builds specific commits. When you activate those plugins, you may see them installing a custom build strategy.

Ancestry
Maximum Age of Commit

The maximum age of a commit (in days) for it to be built. This uses the GIT_COMMITTER_DATE, not GIT_AUTHOR_DATE

Commit in Ancestry

If an ancestor commit (SHA-1) is provided, only branches with this commit in their history will be built.

Default

Build all the branches that match the branch name pattern.

Inverse

Build all branches except for those which match the branch specifiers configure above. This is useful, for example, when you have jobs building your master and various release branches and you want a second job which builds all new feature branches. For example, branches which do not match these patterns without redundantly building master and the release branches again each time they change.

Deprecated Extensions

Custom SCM name - Deprecated

Unique name for this SCM. Was needed when using Git within the Multi SCM plugin. Pipeline is the robust and feature-rich way to checkout from multiple repositories in a single job.

Environment Variables

The git plugin assigns values to environment variables in several contexts. Environment variables are assigned in Freestyle, Pipeline, Multibranch Pipeline, and Organization Folder projects.

Branch Variables

GIT_BRANCH

Name of branch being built including remote name, as in origin/master

GIT_LOCAL_BRANCH

Name of branch being built without remote name, as in master

Commit Variables

GIT_COMMIT

SHA-1 of the commit used in this build

GIT_PREVIOUS_COMMIT

SHA-1 of the commit used in the preceding build of this project

GIT_PREVIOUS_SUCCESSFUL_COMMIT

SHA-1 of the commit used in the most recent successful build of this project

System Configuration Variables

GIT_URL

Remote URL of the first git repository in this workspace

GIT_URL_n

Remote URL of the additional git repositories in this workspace (if any)

GIT_AUTHOR_EMAIL

Author e-mail address that will be used for new commits in this workspace

GIT_AUTHOR_NAME

Author name that will be used for new commits in this workspace

GIT_COMMITTER_EMAIL

Committer e-mail address that will be used for new commits in this workspace*

GIT_COMMITTER_NAME

Committer name that will be used for new commits in this workspace

Properties

Some git plugin settings can only be controlled from command line properties set at Jenkins startup.

Default timeout

The default git timeout value (in minutes) can be overridden by the org.jenkinsci.plugins.gitclient.Git.timeOut property (see JENKINS-11286). The property should be set on the master and on all agents to have effect (see JENKINS-22547).

Command line git is the reference git implementation in the git plugin and the git client plugin. Command line git provides the most functionality and is the most stable implementation. Some installations may not want to install command line git and may want to disable the command line git implementation. Administrators may disable command line git with the property org.jenkinsci.plugins.gitclient.Git.useCLI=false.

Git Publisher

The Jenkins git plugin provides a "git publisher" as a post-build action. The git publisher can push commits or tags from the workspace of a Freestyle project to the remote repository.

The git publisher is only available for Freestyle projects. It is not available for Pipeline, Multibranch Pipeline, Organization Folder, or any other job type other than Freestyle.

Git Publisher Options

The git publisher behaviors are controlled by options that can be configured as part of the Jenkins job. Options include;

Push Only If Build Succeeds

Only push changes from the workspace to the remote repository if the build succeeds. If the build status is unstable, failed, or canceled, the changes from the workspace will not be pushed.

Merge Results

If pre-build merging is configured through one of the merge extensions, then enabling this checkbox will push the merge to the remote repository.

Force Push

Git refuses to replace a remote commit with a different commit. This prevents accidental overwrite of new commits on the remote repository. However, there may be times when overwriting commits on the remote repository is acceptable and even desired. If the commits from the local workspace should overwrite commits on the remote repository, enable this option. It will request that the remote repository destroy history and replace it with history from the workspace.

Git Publisher Tags Options

The git publisher can push tags from the workspace to the remote repository. Options in this section will allow the plugin to create a new tag. Options will also allow the plugin to update an existing tag, though the git documentation strongly advises against updating tags.

Tag to push

Name of the tag to be pushed from the local workspace to the remote repository. The name may include Jenkins environment variables or may be a fixed string. For example, the tag to push might be $BUILD_TAG, my-tag-$BUILD_NUMBER, build-$BUILD_NUMBER-from-$NODE_NAME, or a-very-specific-string-that-will-be-used-once.

Tag message

If the option is selected to create a tag or update a tag, then this message will be associated with the tag that is created. The message will expand references to Jenkins environment variables. For example, the message Build $BUILD_NUMBER tagged on $NODE_NAME will use the message Build 1 tagged on master if build 1 of the job runs on the master.

Create new tag

Create a new tag in the workspace. The git publisher will fail the job if the tag already exists.

Update new tag

Modify existing tag in the workspace so that it points to the most recent commit. Many git repository hosting services will reject attempts to push a tag which has been modified to point to a different commit than its original commit. Refer to force push for an option which may force the remote repository to accept a modified tag. The git documentation strongly advises against updating tags.

Tag remote name

Git uses the 'remote name' as a short string replacement for the full URL of the remote repository. This option defines which remote should receive the push. This is typically origin, though it could be any one of the remote names defined when the plugin performs the checkout.

Git Publisher Branches Options

The git publisher can push branches from the workspace to the remote repository. Options in this section will allow the plugin to push the contents of a local branch to the remote repository.

Branch to push

The name of the remote branch that will receive the latest commits from the agent workspace. This is usually the same branch that was used for the checkout

Target remote name

The shortname of the remote that will receive the latest commits from the agent workspace. Usually this is origin. It needs to be a shortname that is defined in the agent workspace, either through the initial checkout or through later configuration.

Rebase before push

Some Jenkins jobs may be blocked from pushing changes to the remote repository because the remote repository has received new commits since the start of the job. This may happen with projects that receive many commits or with projects that have long running jobs. The Rebase before push option fetches the most recent commits from the remote repository, applies local changes over the most recent commits, then pushes the result. The plugin uses git rebase to apply the local changes over the most recent remote changes.

Because Rebase before push is modifying the commits in the agent workspace after the job has completed, it is creating a configuration of commits that has not been evaluated by any Jenkins job. The commits in the local workspace have been evaluated by the job. The most recent commits from the remote repository have not been evaluated by the job. Users may find that the risk of pushing an untested configuration is less than the risk of delaying the visibility of the changes which have been evaluated by the job.

Combining repositories

A single reference repository may contain commits from multiple repositories. For example, if a repository named parent includes references to submodules child-1 and child-2, a reference repository could be created to cache commits from all three repositories using the commands:

$ mkdir multirepository-cache.git
$ cd  multirepository-cache.git
$ git init --bare
$ git remote add parent https://github.com/jenkinsci/git-plugin
$ git remote add child-1 https://github.com/jenkinsci/git-client-plugin
$ git remote add child-2 https://github.com/jenkinsci/platformlabeler-plugin
$ git fetch --all

Those commands create a single bare repository with the current commits from all three repositories. If that reference repository is used in the advanced clone options clone reference repository, it will reduce data transfer and disc use for the parent repository. If that reference repository is used in the submodule options clone reference repository, it will reduce data transfer and disc use for the submodule repositories.

Bug Reports

Report issues and enhancements in the Jenkins issue tracker.

Contributing to the Plugin

Refer to contributing to the plugin for contribution guidelines. Refer to plugin development priorities for the prioritized list of development topics.