Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/master' into jakarta
Browse files Browse the repository at this point in the history
  • Loading branch information
basil committed Aug 5, 2024
2 parents aa97268 + c54ef07 commit d0fc6e9
Show file tree
Hide file tree
Showing 6 changed files with 300 additions and 316 deletions.
88 changes: 44 additions & 44 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,7 @@ withCredentials([gitUsernamePassword(credentialsId: 'my-credentials-id',
[#using-repositories]
=== Repositories

image:/images/git-repository-configuration.png[Repository Configuration]
image:images/git-repository-configuration.png[Repository Configuration]

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:
Expand Down Expand Up @@ -348,7 +348,7 @@ JGit becomes available throughout Jenkins once it has been enabled.
[#global-configuration]
=== [[GitPlugin-Configuration]]Global Configuration

image:/images/git-global-configuration.png[Global Configuration]
image:images/git-global-configuration.png[Global Configuration]

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

Expand Down Expand Up @@ -473,7 +473,7 @@ See link:https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks["Customizing G
[#repository-browser]
=== Repository Browser

image:/images/git-repository-browser.png[Repository Browser]
image:images/git-repository-browser.png[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.
Expand All @@ -483,7 +483,7 @@ Repository browsers include:
[#assemblaweb-repository-browser]
==== AssemblaWeb

image:/images/git-repository-browser-assemblaweb.png[Assembla Repository Browser]
image:images/git-repository-browser-assemblaweb.png[Assembla Repository Browser]

Repository browser for git repositories hosted by link:https://www.assembla.com/home[Assembla].
Options include:
Expand All @@ -497,7 +497,7 @@ Assembla Git URL::
[#fisheye-repository-browser]
==== FishEye

image:/images/git-repository-browser-fisheye.png[FishEye Repository Browser]
image:images/git-repository-browser-fisheye.png[FishEye Repository Browser]

Repository browser for git repositories hosted by link:https://www.atlassian.com/software/fisheye[Atlassian Fisheye].
Options include:
Expand All @@ -511,7 +511,7 @@ URL::
[#kiln-repository-browser]
==== Kiln

image:/images/git-repository-browser-kiln.png[Kiln Repository Browser]
image:images/git-repository-browser-kiln.png[Kiln Repository Browser]

Repository browser for git repositories hosted by link:http://www.fogbugz.com/version-control[Kiln].
Options include:
Expand All @@ -525,7 +525,7 @@ URL::
[#visual-studio-team-services-repository-browser]
==== Microsoft Team Foundation Server/Visual Studio Team Services

image:/images/git-repository-browser-microsoft.png[Microsoft Repository Browser]
image:images/git-repository-browser-microsoft.png[Microsoft Repository Browser]

Repository browser for git repositories hosted by link:https://azure.microsoft.com/en-us/solutions/devops/[Azure DevOps].
Options include:
Expand All @@ -539,7 +539,7 @@ URL or name::
[bitbucketweb-repository-browser]
==== bitbucketweb

image:/images/git-repository-browser-bitbucket.png[Bitbucket Repository Browser]
image:images/git-repository-browser-bitbucket.png[Bitbucket Repository Browser]

Repository browser for git repositories hosted by link:https://bitbucket.org/[Bitbucket].
Options include:
Expand All @@ -553,7 +553,7 @@ URL::
[bitbucketserver-repository-browser]
==== bitbucketserver

image:/images/git-repository-browser-bitbucketserver.png[Bitbucket Server Repository Browser]
image:images/git-repository-browser-bitbucketserver.png[Bitbucket Server Repository Browser]

Repository browser for git repositories hosted by an on-premises Bitbucket Server installation.
Options include:
Expand All @@ -567,7 +567,7 @@ URL::
[#cgit-repository-browser]
==== cgit

image:/images/git-repository-browser-cgit.png[CGit Repository Browser]
image:images/git-repository-browser-cgit.png[CGit Repository Browser]

Repository browser for git repositories hosted by link:https://git.zx2c4.com/cgit/[cgit].
Options include:
Expand All @@ -581,7 +581,7 @@ URL::
[#gitblit-repository-browser]
==== gitblit

image:/images/git-repository-browser-gitblit.png[GitBlit Repository Browser]
image:images/git-repository-browser-gitblit.png[GitBlit Repository Browser]

[[gitblit-url]]
GitBlit root url::
Expand All @@ -598,7 +598,7 @@ Project name in GitBlit::
[#githubweb-repository-browser]
==== githubweb

image:/images/git-repository-browser-github.png[GitHub Repository Browser]
image:images/git-repository-browser-github.png[GitHub Repository Browser]

Repository browser for git repositories hosted by link:https://github.com//[GitHub].
Options include:
Expand All @@ -612,7 +612,7 @@ URL::
[#gitiles-repository-browser]
==== gitiles

image:/images/git-repository-browser-gitiles.png[Gitiles Repository Browser]
image:images/git-repository-browser-gitiles.png[Gitiles Repository Browser]

Repository browser for git repositories hosted by link:https://gerrit.googlesource.com/gitiles/[Gitiles].
Options include:
Expand All @@ -627,7 +627,7 @@ gitiles root url::
[#gitlab-com-repository-browser]
==== gitlab

image:/images/git-repository-browser-gitlab.png[GitLab Repository Browser]
image:images/git-repository-browser-gitlab.png[GitLab Repository Browser]

Repository browser for git repositories hosted by link:https://gitlab.com/[GitLab].
Options include:
Expand All @@ -648,7 +648,7 @@ Version::
[#gitlist-repository-browser]
==== gitlist

image:/images/git-repository-browser-gitlist.png[Gitlist Repository Browser]
image:images/git-repository-browser-gitlist.png[Gitlist Repository Browser]

Repository browser for git repositories hosted by link:https://gitlist.org/[GitList].
Options include:
Expand All @@ -674,7 +674,7 @@ URL::
[#gitweb-repository-browser]
==== gitweb

image:/images/git-repository-browser-gitweb.png[Gitweb Repository Browser]
image:images/git-repository-browser-gitweb.png[Gitweb Repository Browser]

Repository browser for git repositories hosted by link:https://git-scm.com/docs/gitweb[GitWeb].
Options include:
Expand All @@ -688,7 +688,7 @@ URL::
[#gogs-repository-browser]
==== gogs

image:/images/git-repository-browser-gogs.png[Gogs Repository Browser]
image:images/git-repository-browser-gogs.png[Gogs Repository Browser]

Repository browser for git repositories hosted by link:https://gogs.io/[Gogs].
Options include:
Expand Down Expand Up @@ -720,7 +720,7 @@ Repository name in Phab::
[#redmineweb-repository-browser]
==== redmineweb

image:/images/git-repository-browser-redmine.png[Redmine Repository Browser]
image:images/git-repository-browser-redmine.png[Redmine Repository Browser]

Repository browser for git repositories hosted by link:https://www.redmine.org/[Redmine].
Options include:
Expand All @@ -734,7 +734,7 @@ URL::
[#rhodecode-repository-browser]
==== rhodecode

image:/images/git-repository-browser-rhodecode.png[RhodeCode Repository Browser]
image:images/git-repository-browser-rhodecode.png[RhodeCode Repository Browser]

Repository browser for git repositories hosted by link:https://thodecode.com/[RhodeCode].
Options include:
Expand All @@ -748,7 +748,7 @@ URL::
[#stash-repository-browser]
==== stash

image:/images/git-repository-browser-stash.png[Stash Repository Browser]
image:images/git-repository-browser-stash.png[Stash Repository Browser]

Stash is now called *BitBucket Server*.
Repository browser for git repositories hosted by link:https://www.atlassian.com/software/bitbucket[BitBucket Server].
Expand All @@ -763,7 +763,7 @@ URL::
[#viewgit-repository-browser]
==== viewgit

image:/images/git-repository-browser-viewgit.png[Viewgit Repository Browser]
image:images/git-repository-browser-viewgit.png[Viewgit Repository Browser]

Repository browser for git repositories hosted by link:https://www.openhub.net/p/viewgit[viewgit].
Options include:
Expand Down Expand Up @@ -824,7 +824,7 @@ The extensions can adjust the amount of history retrieved, how long the retrieva
[#advanced-clone-behaviours]
==== Advanced clone behaviours

image:/images/git-advanced-clone-behaviours.png[Advanced clone behaviours]
image:images/git-advanced-clone-behaviours.png[Advanced clone behaviours]

Advanced clone behaviors modify the `link:https://git-scm.com/docs/git-clone[git clone]` and `link:https://git-scm.com/docs/git-fetch[git fetch]` commands.
They control:
Expand Down Expand Up @@ -871,15 +871,15 @@ Fetch tags::
[#prune-stale-remote-tracking-branches]
==== Prune stale remote tracking branches

image:/images/git-prune-stale-remote-tracking-branches.png[Prune stale remote tracking branches]
image:images/git-prune-stale-remote-tracking-branches.png[Prune stale remote tracking branches]

Removes remote tracking branches from the local workspace if they no longer exist on the remote.
See `link:https://git-scm.com/docs/git-remote#Documentation/git-remote.txt-empruneem[git remote prune]` and `link:https://git-scm.com/docs/git-fetch#_pruning[git fetch --prune]` for more details.

[#prune-stale-tags]
==== Prune stale tags

image:/images/git-prune-stale-tags.png[Prune stale tags]
image:images/git-prune-stale-tags.png[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.
Expand All @@ -895,7 +895,7 @@ The extensions can adjust the maximum duration of the checkout operation, the us
[#advanced-checkout-behaviors]
==== Advanced checkout behaviors

image:/images/git-advanced-checkout-behaviors.png[Advanced checkout behaviors]
image:images/git-advanced-checkout-behaviors.png[Advanced checkout behaviors]

Advanced checkout behaviors modify the `link:https://git-scm.com/docs/git-checkout[git checkout]` command.
Advanced checkout behaviors include
Expand All @@ -909,7 +909,7 @@ Timeout (in minutes) for checkout operation::
[#advanced-sub-modules-behaviours]
==== Advanced sub-modules behaviours

image:/images/git-advanced-sub-modules-behaviours.png[Advanced sub-modules behaviours]
image:images/git-advanced-sub-modules-behaviours.png[Advanced sub-modules behaviours]

Advanced sub-modules behaviors modify the `link:https://git-scm.com/docs/git-submodule[git submodule]` commands.
They control:
Expand Down Expand Up @@ -974,7 +974,7 @@ Shallow clone depth::
[#checkout-to-a-sub-directory]
==== Checkout to a sub-directory

image:/images/git-checkout-to-a-sub-directory.png[Checkout to a sub-directory]
image:images/git-checkout-to-a-sub-directory.png[Checkout to a sub-directory]

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

Expand All @@ -990,7 +990,7 @@ Local subdirectory for repo::
[#checkout-to-specific-local-branch]
==== Checkout to specific local branch

image:/images/git-checkout-to-specific-local-branch.png[Checkout to specific local branch]
image:images/git-checkout-to-specific-local-branch.png[Checkout to specific local branch]

Branch name::

Expand All @@ -1002,15 +1002,15 @@ Branch name::
[#wipe-out-repository-and-force-clone]
==== Wipe out repository and force clone

image:/images/git-wipe-out-repository-and-force-clone.png[Wipe out repository and force clone]
image:images/git-wipe-out-repository-and-force-clone.png[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 after checkout

image:/images/git-clean-after-checkout.png[Clean after checkout]
image:images/git-clean-after-checkout.png[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.
Expand All @@ -1028,7 +1028,7 @@ Delete untracked nested repositories::
[#clean-before-checkout]
==== Clean before checkout

image:/images/git-clean-before-checkout.png[Clean before checkout]
image:images/git-clean-before-checkout.png[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.
Expand All @@ -1046,7 +1046,7 @@ Delete untracked nested repositories::
[#sparse-checkout-paths]
==== Sparse checkout paths

image:/images/git-sparse-checkout-paths.png[Sparse checkout paths]
image:images/git-sparse-checkout-paths.png[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).
Expand All @@ -1061,7 +1061,7 @@ Path::
[#git-lfs-pull-after-checkout]
==== Git LFS pull after checkout

image:/images/git-lfs-pull-after-checkout.png[Git LFS pull after checkout]
image:images/git-lfs-pull-after-checkout.png[Git LFS pull after checkout]

Enable https://git-lfs.github.com/[git large file support] for the workspace by pulling large files after the checkout completes.
Requires that the controller and each agent performing an LFS checkout have installed `git lfs`.
Expand All @@ -1075,7 +1075,7 @@ Changelog extensions adapt the changelog calculations for different cases.
[#calculate-changelog-against-a-specific-branch]
==== Calculate changelog against a specific branch

image:/images/git-calculate-changelog-against-a-specific-branch.png[Calculate changelog against a specific branch]
image:images/git-calculate-changelog-against-a-specific-branch.png[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".
Expand All @@ -1091,7 +1091,7 @@ Name of branch::
[#use-commit-author-in-changelog]
==== Use commit author in changelog

image:/images/git-use-commit-author-in-changelog.png[Use commit author in changelog]
image:images/git-use-commit-author-in-changelog.png[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.
Expand All @@ -1104,7 +1104,7 @@ Tagging extensions allow the plugin to apply tags in the current workspace.
[#create-a-tag-for-every-build]
==== Create a tag for every build

image:/images/git-create-a-tag-for-every-build.png[Create a tag for every build]
image:images/git-create-a-tag-for-every-build.png[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.
Expand All @@ -1119,14 +1119,14 @@ They can ignore notifications of a change or force a deeper evaluation of the co
[#dont-trigger-a-build-on-commit-notifications]
==== Don't trigger a build on commit notifications

image:/images/git-do-not-trigger-a-build-on-commit-notifications.png[Do not trigger a build on commit notifications]
image:images/git-do-not-trigger-a-build-on-commit-notifications.png[Do not 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]
==== Force polling using workspace

image:/images/git-force-polling-using-workspace.png[Force polling using workspace]
image:images/git-force-polling-using-workspace.png[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`.
Expand All @@ -1140,7 +1140,7 @@ In addition, the administrator may need to <<GitPlugin-WhyNotJGit,disable comman
[#polling-ignores-commits-from-certain-users]
==== Polling ignores commits from certain users

image:/images/git-polling-ignores-commits-from-certain-users.png[Polling ignores commits from certain users]
image:images/git-polling-ignores-commits-from-certain-users.png[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.
Expand All @@ -1160,7 +1160,7 @@ Excluded Users::
[#polling-ignores-commits-in-certain-paths]
==== Polling ignores commits in certain paths

image:/images/git-polling-ignores-commits-in-certain-paths.png[Polling ignores commits in certain paths]
image:images/git-polling-ignores-commits-in-certain-paths.png[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.

Expand All @@ -1181,7 +1181,7 @@ Excluded Regions::
[#polling-ignores-commits-with-certain-messages]
==== Polling ignores commits with certain messages

image:/images/git-polling-ignores-commits-with-certain-messages.png[Polling ignores commits with certain messages]
image:images/git-polling-ignores-commits-with-certain-messages.png[Polling ignores commits with certain messages]

Excluded Messages::

Expand All @@ -1192,7 +1192,7 @@ Excluded Messages::
[#strategy-for-choosing-what-to-build]
==== Strategy for choosing what to build

image:/images/git-strategy-for-choosing-what-to-build.png[Strategy for choosing what to build]
image:images/git-strategy-for-choosing-what-to-build.png[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.

Expand Down Expand Up @@ -1246,7 +1246,7 @@ Merge extensions control the source branch for the merge and the options applied
[#merge-before-build]
==== Merge before build

image:/images/git-merge-before-build.png[Merge before build]
image:images/git-merge-before-build.png[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.
Expand Down Expand Up @@ -1285,7 +1285,7 @@ Fast-forward mode::
[#custom-user-name-e-mail-address]
==== Custom user name/e-mail address

image:/images/git-custom-user-name-e-mail-address.png[Custom user name/e-mail address]
image:images/git-custom-user-name-e-mail-address.png[Custom user name/e-mail address]

user.name::

Expand Down
Loading

0 comments on commit d0fc6e9

Please sign in to comment.