The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.
For a list of other such plugins, see the Pipeline Steps Reference page.
library: Load a shared library on the fly Load a library dynamically rather than using @Library syntax. You may use global variables defined in the library thereafter:
library 'mylib@master'
usefulFunction()
You may also load classes defined in the library by selecting their fully-qualified names like properties on the return value of this step, then call static methods or call constructors as if they were a method named new:
def utils = library('mylib').com.mycorp.jenkins.Utils.new(this)
utils.handyStuff()
identifier
@. You may instead define a library inline here.
Stringchangelog (optional)
booleanretriever (optional)
legacySCMcheckout step. Not all version expressions may be supported, no prevalidation of versions is available, and you must manually configure the SCM to refer to
${library.THISLIBNAME.version}.
scm
$class: 'AWSCodePipelineSCM'name
StringclearWorkspace
booleanregion
StringawsAccessKey
In order to integrate with AWS CodePipeline, you must authorize access to the pipeline and its related artifacts. If you installed Jenkins on a supported Amazon EC2 instance type, such as Amazon Linux, you can install the AWS CLI and configure a profile with the required credentials. This is the preferred method. In all other cases, you can store AWS credentials in these fields. You should securely configure your Jenkins instance to use HTTPS so that these credentials are not sent unencrypted. For more information, see AWS CodePipeline Integration for Other Products and Services.
StringawsSecretKey
>In order to integrate with AWS CodePipeline, you must authorize access to the pipeline and its related artifacts. If you installed Jenkins on a supported Amazon EC2 instance type, such as Amazon Linux, you can install the AWS CLI and configure a profile with the required credentials. This is the preferred method. In all other cases, you can store AWS credentials in these fields. You should securely configure your Jenkins instance to use HTTPS so that these credentials are not sent unencrypted. For more information, see AWS CodePipeline Integration for Other Products and Services.
StringproxyHost
You might need a proxy host address if you are hosting Jenkins on a private network. The proxy name can be an IP address or DNS address. The AWS CodePipeline Plugin for Jenkins requires internet access. If access is not configured, you might see errors in the AWS CodePipeline Polling Log.
StringproxyPort
You might need a proxy port for your proxy host address if you are hosting Jenkins on a private network. The proxy port is a number, might be on port 8080, 3128, or 8443, depending on your network protocols and security settings. If access is not configured, you might see errors in the AWS CodePipeline Polling Log.
Stringcategory
This is the category of the action type in AWS CodePipeline, and is usually either Build or Test. To see an example usage, see Install and Configure the AWS CodePipeline Plugin for Jenkins.
Stringprovider
This is the provider name of the action type in AWS CodePipeline. You must provide this exact string when adding an action for Jenkins in AWS CodePipeline. To see an example usage, see Install and Configure the AWS CodePipeline Plugin for Jenkins.
Stringversion
Leave the default as 1.
Stringaccurevdepot
Stringstream
StringserverName (optional)
StringserverUUID (optional)
StringaccurevTool (optional)
Stringcleanreftree (optional)
booleandirectoryOffset (optional)
StringdontPopContent (optional)
booleanfilterForPollSCM (optional)
StringignoreStreamParent (optional)
booleanreftree (optional)
StringsnapshotNameFormat (optional)
StringsubPath (optional)
Stringsynctime (optional)
booleanuseSnapshot (optional)
booleanworkspace (optional)
StringwspaceORreftree (optional)
String$class: 'BazaarSCM'source
Stringcleantree
booleanbrowser
$class: 'Loggerhead'url
String$class: 'OpenGrok'url
StringrootModule
Stringcheckout
boolean$class: 'BitKeeperSCM'parent
StringlocalRepository
StringusePull
booleanquiet
boolean$class: 'BlameSubversionSCM'if it is false and the build is not triggered by upstream job,
the plugin will not collect any svn info from upstream job.
else the plugin will collect svn info from latest upstream job
alwaysCollectSVNInfo
boolean$class: 'CCUCMScm'loadModule
Stringnewest
booleanmode
$class: 'PollChildMode'levelToPoll
Stringcomponent (optional)
StringcreateBaseline (optional)
Check this if you want create a baseline after a completed deliver.
This is only applicable for child and sibling poll mode.
booleannewest (optional)
boolean$class: 'PollRebaseMode'levelToPoll
Stringcomponent (optional)
StringcreateBaseline (optional)
booleanexcludeList (optional)
String$class: 'PollSelfMode'levelToPoll
Stringcomponent (optional)
Stringnewest (optional)
boolean$class: 'PollSiblingMode'levelToPoll
Stringcomponent (optional)
StringcreateBaseline (optional)
Check this if you want create a baseline after a completed deliver.
This is only applicable for child and sibling poll mode.
booleannewest (optional)
booleanuseHyperLinkForPolling (optional)
boolean$class: 'PollSubscribeMode'levelToPoll
StringcomponentsToMonitor
componentSelection
StringjobsToMonitor
jobname
Stringignores
StringjobName (optional)
StringcascadePromotion (optional)
booleancomponent (optional)
Stringnewest (optional)
booleanstream
StringtreatUnstable
StringnameTemplate
StringforceDeliver
booleanrecommend
booleanmakeTag
booleansetDescription
booleanbuildProject
StringremoveViewPrivateFiles
booleantrimmedChangeSet
booleandiscard
boolean$class: 'CVSSCM'repositories
cvsRoot
StringpasswordRequired
booleanpassword
StringrepositoryItems
location
$class: 'BranchRepositoryLocation'branchName
StringuseHeadIfNotFound
boolean$class: 'HeadRepositoryLocation'$class: 'TagRepositoryLocation'tagName
StringuseHeadIfNotFound
booleanmodules
remoteName
StringlocalName
StringprojectsetFileName
StringexcludedRegions
src/main/web/.*\.html src/main/web/.*\.jpeg src/main/web/.*\.gifThe example above illustrates that if only html/jpeg/gif files have been committed to the SCM a build will not occur. More information on regular expressions can be found here.
pattern
StringcompressionLevel
intrepositoryBrowser
$class: 'FishEyeCVS'url
String$class: 'OpenGrok'url
String$class: 'ViewCVS'url
StringcanUseUpdate
booleanlegacy
If you have multiple modules to check out, this option is forced (otherwise they'll overlap.)
This affects other path specifiers, such as artifact archivers --- you now specify "build/foo.jar" instead of "foo/build/foo.jar".
booleanskipChangeLog
booleanpruneEmptyDirectories
booleandisableCvsQuiet
booleancleanOnFailedUpdate
booleanforceCleanCopy
booleancheckoutCurrentTimestamp
The build quiet period is designed to assist with CVS checkouts by waiting for a specific period of time without commits. Normally you want the checkout to reflect the time when the quiet period was exited successfully. Select this option if you need to re-enable the legacy behaviour of Jenkins, i.e. using the time that the build started checking out as the timestamp for the checkout operation. Note: enabling this option can result in the quiet period being defeated especially in those cases where the build is not able to start immediately after exiting the quiet period.
boolean$class: 'ClearCaseSCM'branch
Stringlabel
StringextractConfigSpec
booleanconfigSpecFileName
StringrefreshConfigSpec
booleanrefreshConfigSpecCommand
StringconfigSpec
StringviewTag
Stringuseupdate
booleanextractLoadRules
booleanloadRules
StringuseOtherLoadRulesForPolling
booleanloadRulesForPolling
Stringusedynamicview
booleanviewdrive
Stringmkviewoptionalparam
StringfilterOutDestroySubBranchEvent
booleandoNotUpdateConfigSpec
booleanrmviewonrename
booleanexcludedRegions
StringmultiSitePollBuffer
StringuseTimeRule
booleancreateDynView
booleanviewPath
Stringchangeset
ALL, BRANCH, NONE, UPDTviewStorage
Three strategies are currently available to manage view storage location.
$class: 'DefaultViewStorage'$class: 'ServerViewStorage'assignedLabelString
Label expression used to populate view storage location dropdown.
Stringserver
The view storage location that will be passed to the -stgloc option.
The list of available servers is retrieved using cleartool lsstgloc -view
Note that auto is always available.
String$class: 'SpecificViewStorage'winStorageDir
StringunixStorageDir
String$class: 'ClearCaseUcmBaselineSCM'$class: 'ClearCaseUcmSCM'stream
Stringloadrules
StringviewTag
Stringusedynamicview
booleanviewdrive
Stringmkviewoptionalparam
StringfilterOutDestroySubBranchEvent
booleanuseUpdate
booleanrmviewonrename
booleanexcludedRegions
StringmultiSitePollBuffer
StringoverrideBranchName
StringcreateDynView
booleanfreezeCode
booleanrecreateView
booleanallocateViewName
booleanviewPath
StringuseManualLoadRules
booleanchangeset
ALL, BRANCH, NONE, UPDTviewStorage
Three strategies are currently available to manage view storage location.
$class: 'DefaultViewStorage'$class: 'ServerViewStorage'assignedLabelString
Label expression used to populate view storage location dropdown.
Stringserver
The view storage location that will be passed to the -stgloc option.
The list of available servers is retrieved using cleartool lsstgloc -view
Note that auto is always available.
String$class: 'SpecificViewStorage'winStorageDir
StringunixStorageDir
StringbuildFoundationBaseline
If checked, instead of creating a view on the current stream, the job will look up the current foundation baselines for the given stream and work in readonly on these baselines. If polling is enabled, the build will be triggered every time a new foundation baseline is detected on the given stream.
boolean$class: 'CloneWorkspaceSCM'parentJobName
Stringcriteria
String$class: 'CmvcSCM'family
Stringbecome
Stringreleases
StringcheckoutScript
StringtrackViewReportWhereClause
String$class: 'ConfigurationRotator'acrs
$class: 'ClearCaseUCM'pvobName
Stringcontribute
Contribute data to a global database. Defined in the Compatibility Action Storage Plugin.
booleantargets
baselineName
Stringlevel
INITIAL, BUILT, TESTED, RELEASED, REJECTEDfixed
booleanuseNewest (optional)
boolean$class: 'Git'targets
name
Stringrepository
Stringbranch
StringcommitId
Stringfixed
booleanuseNewest (optional)
boolean$class: 'CvsProjectset'repositories
cvsRoot
StringpasswordRequired
booleanpassword
StringrepositoryItems
location
$class: 'BranchRepositoryLocation'branchName
StringuseHeadIfNotFound
boolean$class: 'HeadRepositoryLocation'$class: 'TagRepositoryLocation'tagName
StringuseHeadIfNotFound
booleanmodules
remoteName
StringlocalName
StringprojectsetFileName
StringexcludedRegions
src/main/web/.*\.html src/main/web/.*\.jpeg src/main/web/.*\.gifThe example above illustrates that if only html/jpeg/gif files have been committed to the SCM a build will not occur. More information on regular expressions can be found here.
pattern
StringcompressionLevel
intrepositoryBrowser
$class: 'FishEyeCVS'url
String$class: 'OpenGrok'url
String$class: 'ViewCVS'url
StringcanUseUpdate
booleanusername
Stringpassword
Stringbrowser
$class: 'FishEyeCVS'url
String$class: 'OpenGrok'url
String$class: 'ViewCVS'url
StringskipChangeLog
booleanpruneEmptyDirectories
booleandisableCvsQuiet
booleancleanOnFailedUpdate
booleanforceCleanCopy
boolean$class: 'DarcsScm'source
StringlocalDir
Stringclean
booleanbrowser
$class: 'DarcsWeb'url
Stringrepo
String$class: 'Darcsden'url
String$class: 'DelegateSCM'clazz
String$class: 'DimensionsSCM'project
Stringfolders
StringpathsToExclude
Stringworkarea
StringcanJobDelete
booleancanJobForce
booleancanJobRevert
booleanjobUserName
StringjobPasswd
StringjobServer
StringjobDatabase
StringcanJobUpdate
booleanjobTimeZone
StringjobWebUrl
Stringdirectory
Stringpermissions
Stringeol
StringcanJobExpand
booleancanJobNoMetadata
booleancanJobNoTouch
booleanforceAsSlave
boolean$class: 'DrushMakefileSCM'makefile
Specify the content of the Makefile. Support for YAML Makefiles depends on the version of Drush you have installed.
This example will generate a vanilla Drupal 7.38:
api=2
core=7.x
projects[drupal][version]=7.38
Stringroot
String$class: 'EndevorConfiguration'connectionId
StringfilterPattern
StringfileExtension
StringcredentialsId
StringtargetFolder
Stringfilesystempath
The file path for the source code.
e.g. \\Server1\project1\src or c:\myproject\src
Note for distributed build environment, please make sure the path is accessible on remote node(s)
StringclearWorkspace
If true, the system will delete all existing files/sub-folders in workspace before checking-out. Poll changes will not be affected by this setting.
booleancopyHidden
If true, the system will copy hidden files and folders as well. Default is false.
booleanfilterSettings
includeFilter
booleanselectors
You can apply wildcard filter(s) when detecting changes and copying files. By default, the system will filter out hidden files, on Unix, that means files/folder starting with ".", on Windows, that means files/folders with "hidden" attribute. You may want to filter out, e.g. files with ".tmp" extension.
Note: filters are applied on both sides, source and destination (i.e. the workspace). E.g. if you filter out ".tmp" files, all ".tmp" files currently in workspace will not be removed.
wildcard
ANT style wildcard.
To include just *.java, set filter type to "Include" and type add "*.java" (without quote) in the wildcard. To exclude *.exe" and all JUnit test cases, set filter type to "Exclude" and add two wildcard, one for "*.dll" and one for "*Test*"
To exclude a directory, set filter to "**/dir_to_exclude/**"
Note: (1) the wildcard is case insensitive, (2) all backslashes (\) will be replaced with slashes (/)
String$class: 'FeatureBranchAwareMercurialSCM'installation
Stringsource
Stringbranch
Stringmodules
Stringsubdir
my/sources (use forward slashes). If changing this entry, you probably want to clean the workspace first.
Stringbrowser
$class: 'BitBucket'url
String$class: 'FishEye'url
String$class: 'GoogleCode'url
String$class: 'HgWeb'url
String$class: 'Kallithea'url
String$class: 'KilnHG'url
String$class: 'RhodeCode'url
String$class: 'RhodeCodeLegacy'url
Stringclean
booleanbranchPattern
String$class: 'GeneXusServerSCM'gxInstallationId
StringserverURL
StringcredentialsId
StringkbName
StringkbVersion
StringlocalKbPath
StringlocalKbVersion
StringkbDbServerInstance
StringkbDbCredentialsId
StringkbDbName
StringkbDbInSameFolder
boolean$class: 'GitSCM'userRemoteConfigs
${SUPER_PROJECT_URL}/${SUBMODULE}, rather than relying on information from .gitmodules.url
Stringname
You normally want to specify this when you have multiple remote repositories.
Stringrefspec
In other words, the default refspec is "+refs/heads/*:refs/remotes/REPOSITORYNAME/*" where REPOSITORYNAME is the value you specify in the above "name of repository" textbox.
When do you want to modify this value? A good example is when you want to just retrieve one branch. For example, +refs/heads/master:refs/remotes/origin/master would only retrieve the master branch and nothing else.
The plugin uses a default refspec for its initial fetch, unless the "Advanced Clone Option" is set to honor refspec. This keeps 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. +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.
See the term definition in Git user manual for more details.
StringcredentialsId
Stringbranches
name
Specify the branches if you'd like to track a specific branch in a repository. If left blank, all branches will be examined for changes and built.
The safest way is to use the refs/heads/<branchName> syntax. This way the expected branch is unambiguous.
If your branch name has a / in it make sure to use the full reference above. When not presented with a full path the plugin will only use the part of the string right of the last slash. Meaning foo/bar will actually match bar
.If you use a wildcard branch specifier, with a slash (e.g. release/), you'll need to specify the origin repository in the branch names to make sure changes are picked up. So e.g. origin/release/
Possible options:
StringdoGenerateSubmoduleConfigurations
booleansubmoduleCfg
hudson.plugins.git.SubmoduleConfig
browser
$class: 'AssemblaWeb'repoUrl
String$class: 'BacklogGitRepositoryBrowser'repoName
StringrepoUrl
String$class: 'BitbucketWeb'repoUrl
String$class: 'CGit'repoUrl
String$class: 'FisheyeGitRepositoryBrowser'repoUrl
String$class: 'GitBlitRepositoryBrowser'repoUrl
StringprojectName
String$class: 'GitBucketBrowser'url
String$class: 'GitLab'repoUrl
Stringversion (optional)
String$class: 'GitList'repoUrl
String$class: 'GitWeb'repoUrl
String$class: 'GiteaBrowser'repoUrl
https://gitea.example.com then the URL for bob's skunkworks project repository might be
https://gitea.example.com/bob/skunkworks
String$class: 'GithubWeb'repoUrl
String$class: 'Gitiles'repoUrl
String$class: 'GitoriousWeb'repoUrl
String$class: 'GogsGit'repoUrl
String$class: 'KilnGit'repoUrl
String$class: 'Phabricator'repoUrl
Stringrepo
String$class: 'RedmineWeb'repoUrl
String$class: 'RhodeCode'repoUrl
String$class: 'Stash'repoUrl
String$class: 'TFS2013GitRepositoryBrowser'repoUrl
If TFS is also used as the repository server, this can usually be left blank.
String$class: 'TracGitRepositoryBrowser'$class: 'ViewGitWeb'repoUrl
StringprojectName
StringgitTool
Stringextensions
$class: 'AuthorInChangelog'$class: 'BuildChooserSetting'This extension point in Jenkins is used by many other plugins to control the job to build specific commits. When you activate those plugins, you may see them installing a custom strategy here.
buildChooser
$class: 'AlternativeBuildChooser'$class: 'AncestryBuildChooser'maximumAgeInDays
intancestorCommitSha1
String$class: 'DefaultBuildChooser'$class: 'DeflakeGitBuildChooser'$class: 'GerritTriggerBuildChooser'$class: 'InverseBuildChooser'$class: 'ChangelogToBranch'options
compareRemote
StringcompareTarget
String$class: 'CheckoutOption'timeout
int$class: 'CleanBeforeCheckout'$class: 'CleanCheckout'$class: 'CloneOption'shallow
booleannoTags
booleanreference
Stringtimeout
intdepth (optional)
inthonorRefspec (optional)
boolean$class: 'CodeCommitURLHelper'credentialId
OPTIONAL: Select the credentials to use.
If not specified, defaults to the DefaultAWSCredentialsProviderChain behaviour - *FROM THE JENKINS INSTANCE*
In the latter case, usage of IAM Role Profiles seems not to work, thus relying on environment variables / system properties or the ~/.aws/credentials file, thus not recommended.
StringrepositoryName
String$class: 'DisableRemotePoll'$class: 'GitLFSPull'$class: 'GitTagMessageExtension'useMostRecentTag (optional)
boolean$class: 'IgnoreNotifyCommit'$class: 'LocalBranch'If selected, and its 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/newfeature.
Please note that this has not been tested with submodules.
localBranch
String$class: 'MessageExclusion'excludedMessage
.*\[maven-release-plugin\].*The example above illustrates that if only revisions with "[maven-release-plugin]" message in first comment line have been committed to the SCM a build will not occur. You can create more complex patterns using embedded flag expressions.
(?s).*FOO.*This example will search FOO message in all comment lines.
String$class: 'PathRestriction'includedRegions
myapp/src/main/web/.*\.html
myapp/src/main/web/.*\.jpeg
myapp/src/main/web/.*\.gif
The example above illustrates that a build will only occur, if html/jpeg/gif files have been committed to the SCM. Exclusions take precedence over inclusions, if there is an overlap between included and excluded regions.
StringexcludedRegions
myapp/src/main/web/.*\.html
myapp/src/main/web/.*\.jpeg
myapp/src/main/web/.*\.gif
The example above illustrates that if only html/jpeg/gif files have been committed to the SCM a build will not occur.
String$class: 'PerBuildTag'$class: 'PreBuildMerge'options
mergeTarget
StringfastForwardMode (optional)
FF, FF_ONLY, NO_FFmergeRemote (optional)
StringmergeStrategy (optional)
DEFAULT, RESOLVE, RECURSIVE, OCTOPUS, OURS, SUBTREE, RECURSIVE_THEIRSpretestedIntegrationgitIntegrationStrategy
accumulatedshortCommitMessage (optional)
booleansquashintegrationBranch
The branch name must match your integration branch name. No trailing slash.
git checkout -B <Branch name> <Repository name>/<Branch name>
git merge --squash <Branch matched by git>
git commit -C <Branch matched by git>
git checkout -B <Branch name> <Repository name>/<Branch name>
git merge -m <commitMsg> <Branch matched by git> --no-ff
Changes are only ever pushed when the build results is SUCCESS
git push <Repository name> <Branch name>StringrepoName
The repository name. In git the repository is always the name of the remote. So if you have specified a repository name in your Git configuration. You need to specify the exact same name here, otherwise no integration will be performed. We do the merge based on this.
No trailing slash on repository name.
Remember to specify this when working with NAMED repositories in Git
String$class: 'PruneStaleBranch'$class: 'RelativeTargetDirectory'relativeTargetDir
String$class: 'ScmName'Unique name for this SCM. Needed when using Git within the Multi SCM plugin.
name
String$class: 'SparseCheckoutPaths'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
sparseCheckoutPaths
path
String$class: 'SubmoduleOption'disableSubmodules
booleanrecursiveSubmodules
booleantrackingSubmodules
booleanreference
git init --bare git remote add SubProject1 https://gitrepo.com/subproject1 git remote add SubProject2 https://gitrepo.com/subproject2 git fetch --all
Stringtimeout
intparentCredentials
booleandepth (optional)
intshallow (optional)
booleanthreads (optional)
int$class: 'UserExclusion'excludedUsers
auto_build_userThe example above illustrates that if only revisions by "auto_build_user" have been committed to the SCM a build will not occur.
String$class: 'UserIdentity'name
If given, "git config user.name [this]" is called before builds. This overrides whatever is in the global settings.
Stringemail
If given, "git config user.email [this]" is called before builds. This overrides whatever is in the global settings.
String$class: 'WipeWorkspace'$class: 'HarvestSCM'broker
StringpasswordFile
StringuserId
Stringpassword
StringprojectName
Stringstate
StringviewPath
StringclientPath
StringprocessName
StringrecursiveSearch
StringuseSynchronize
booleanextraOptions
String$class: 'IspwConfiguration'connectionId
StringcredentialsId
StringserverConfig
StringserverStream
StringserverApplication
StringserverLevel
StringlevelOption
StringcomponentType
StringfolderName
StringispwDownloadAll
boolean$class: 'IspwContainerConfiguration'connectionId
StringcredentialsId
StringserverConfig
StringcontainerName
StringcontainerType
StringserverLevel
StringcomponentType
StringispwDownloadAll
boolean$class: 'MercurialSCM'source
Stringbrowser (optional)
$class: 'BitBucket'url
String$class: 'FishEye'url
String$class: 'GoogleCode'url
String$class: 'HgWeb'url
String$class: 'Kallithea'url
String$class: 'KilnHG'url
String$class: 'RhodeCode'url
String$class: 'RhodeCodeLegacy'url
Stringclean (optional)
booleancredentialsId (optional)
StringdisableChangeLog (optional)
booleaninstallation (optional)
Stringmodules (optional)
Stringrevision (optional)
default branch.)
StringrevisionType (optional)
BRANCH, TAG, CHANGESET, REVSETsubdir (optional)
my/sources (use forward slashes). If changing this entry, you probably want to clean the workspace first.
String$class: 'MergeBotUpdater'$class: 'MultiSCM'scmList
$class: 'AWSCodePipelineSCM'name
StringclearWorkspace
booleanregion
StringawsAccessKey
In order to integrate with AWS CodePipeline, you must authorize access to the pipeline and its related artifacts. If you installed Jenkins on a supported Amazon EC2 instance type, such as Amazon Linux, you can install the AWS CLI and configure a profile with the required credentials. This is the preferred method. In all other cases, you can store AWS credentials in these fields. You should securely configure your Jenkins instance to use HTTPS so that these credentials are not sent unencrypted. For more information, see AWS CodePipeline Integration for Other Products and Services.
StringawsSecretKey
>In order to integrate with AWS CodePipeline, you must authorize access to the pipeline and its related artifacts. If you installed Jenkins on a supported Amazon EC2 instance type, such as Amazon Linux, you can install the AWS CLI and configure a profile with the required credentials. This is the preferred method. In all other cases, you can store AWS credentials in these fields. You should securely configure your Jenkins instance to use HTTPS so that these credentials are not sent unencrypted. For more information, see AWS CodePipeline Integration for Other Products and Services.
StringproxyHost
You might need a proxy host address if you are hosting Jenkins on a private network. The proxy name can be an IP address or DNS address. The AWS CodePipeline Plugin for Jenkins requires internet access. If access is not configured, you might see errors in the AWS CodePipeline Polling Log.
StringproxyPort
You might need a proxy port for your proxy host address if you are hosting Jenkins on a private network. The proxy port is a number, might be on port 8080, 3128, or 8443, depending on your network protocols and security settings. If access is not configured, you might see errors in the AWS CodePipeline Polling Log.
Stringcategory
This is the category of the action type in AWS CodePipeline, and is usually either Build or Test. To see an example usage, see Install and Configure the AWS CodePipeline Plugin for Jenkins.
Stringprovider
This is the provider name of the action type in AWS CodePipeline. You must provide this exact string when adding an action for Jenkins in AWS CodePipeline. To see an example usage, see Install and Configure the AWS CodePipeline Plugin for Jenkins.
Stringversion
Leave the default as 1.
Stringaccurevdepot
Stringstream
StringserverName (optional)
StringserverUUID (optional)
StringaccurevTool (optional)
Stringcleanreftree (optional)
booleandirectoryOffset (optional)
StringdontPopContent (optional)
booleanfilterForPollSCM (optional)
StringignoreStreamParent (optional)
booleanreftree (optional)
StringsnapshotNameFormat (optional)
StringsubPath (optional)
Stringsynctime (optional)
booleanuseSnapshot (optional)
booleanworkspace (optional)
StringwspaceORreftree (optional)
String$class: 'BazaarSCM'source
Stringcleantree
booleanbrowser
$class: 'Loggerhead'url
String$class: 'OpenGrok'url
StringrootModule
Stringcheckout
boolean$class: 'BitKeeperSCM'parent
StringlocalRepository
StringusePull
booleanquiet
boolean$class: 'BlameSubversionSCM'if it is false and the build is not triggered by upstream job,
the plugin will not collect any svn info from upstream job.
else the plugin will collect svn info from latest upstream job
alwaysCollectSVNInfo
boolean$class: 'CCUCMScm'loadModule
Stringnewest
booleanmode
$class: 'PollChildMode'levelToPoll
Stringcomponent (optional)
StringcreateBaseline (optional)
Check this if you want create a baseline after a completed deliver.
This is only applicable for child and sibling poll mode.
booleannewest (optional)
boolean$class: 'PollRebaseMode'levelToPoll
Stringcomponent (optional)
StringcreateBaseline (optional)
booleanexcludeList (optional)
String$class: 'PollSelfMode'levelToPoll
Stringcomponent (optional)
Stringnewest (optional)
boolean$class: 'PollSiblingMode'levelToPoll
Stringcomponent (optional)
StringcreateBaseline (optional)
Check this if you want create a baseline after a completed deliver.
This is only applicable for child and sibling poll mode.
booleannewest (optional)
booleanuseHyperLinkForPolling (optional)
boolean$class: 'PollSubscribeMode'levelToPoll
StringcomponentsToMonitor
componentSelection
StringjobsToMonitor
jobname
Stringignores
StringjobName (optional)
StringcascadePromotion (optional)
booleancomponent (optional)
Stringnewest (optional)
booleanstream
StringtreatUnstable
StringnameTemplate
StringforceDeliver
booleanrecommend
booleanmakeTag
booleansetDescription
booleanbuildProject
StringremoveViewPrivateFiles
booleantrimmedChangeSet
booleandiscard
boolean$class: 'CVSSCM'repositories
cvsRoot
StringpasswordRequired
booleanpassword
StringrepositoryItems
location
$class: 'BranchRepositoryLocation'branchName
StringuseHeadIfNotFound
boolean$class: 'HeadRepositoryLocation'$class: 'TagRepositoryLocation'tagName
StringuseHeadIfNotFound
booleanmodules
remoteName
StringlocalName
StringprojectsetFileName
StringexcludedRegions
src/main/web/.*\.html src/main/web/.*\.jpeg src/main/web/.*\.gifThe example above illustrates that if only html/jpeg/gif files have been committed to the SCM a build will not occur. More information on regular expressions can be found here.
pattern
StringcompressionLevel
intrepositoryBrowser
$class: 'FishEyeCVS'url
String$class: 'OpenGrok'url
String$class: 'ViewCVS'url
StringcanUseUpdate
booleanlegacy
If you have multiple modules to check out, this option is forced (otherwise they'll overlap.)
This affects other path specifiers, such as artifact archivers --- you now specify "build/foo.jar" instead of "foo/build/foo.jar".
booleanskipChangeLog
booleanpruneEmptyDirectories
booleandisableCvsQuiet
booleancleanOnFailedUpdate
booleanforceCleanCopy
booleancheckoutCurrentTimestamp
The build quiet period is designed to assist with CVS checkouts by waiting for a specific period of time without commits. Normally you want the checkout to reflect the time when the quiet period was exited successfully. Select this option if you need to re-enable the legacy behaviour of Jenkins, i.e. using the time that the build started checking out as the timestamp for the checkout operation. Note: enabling this option can result in the quiet period being defeated especially in those cases where the build is not able to start immediately after exiting the quiet period.
boolean$class: 'ClearCaseSCM'branch
Stringlabel
StringextractConfigSpec
booleanconfigSpecFileName
StringrefreshConfigSpec
booleanrefreshConfigSpecCommand
StringconfigSpec
StringviewTag
Stringuseupdate
booleanextractLoadRules
booleanloadRules
StringuseOtherLoadRulesForPolling
booleanloadRulesForPolling
Stringusedynamicview
booleanviewdrive
Stringmkviewoptionalparam
StringfilterOutDestroySubBranchEvent
booleandoNotUpdateConfigSpec
booleanrmviewonrename
booleanexcludedRegions
StringmultiSitePollBuffer
StringuseTimeRule
booleancreateDynView
booleanviewPath
Stringchangeset
ALL, BRANCH, NONE, UPDTviewStorage
Three strategies are currently available to manage view storage location.
$class: 'DefaultViewStorage'$class: 'ServerViewStorage'assignedLabelString
Label expression used to populate view storage location dropdown.
Stringserver
The view storage location that will be passed to the -stgloc option.
The list of available servers is retrieved using cleartool lsstgloc -view
Note that auto is always available.
String$class: 'SpecificViewStorage'winStorageDir
StringunixStorageDir
String$class: 'ClearCaseUcmBaselineSCM'$class: 'ClearCaseUcmSCM'stream
Stringloadrules
StringviewTag
Stringusedynamicview
booleanviewdrive
Stringmkviewoptionalparam
StringfilterOutDestroySubBranchEvent
booleanuseUpdate
booleanrmviewonrename
booleanexcludedRegions
StringmultiSitePollBuffer
StringoverrideBranchName
StringcreateDynView
booleanfreezeCode
booleanrecreateView
booleanallocateViewName
booleanviewPath
StringuseManualLoadRules
booleanchangeset
ALL, BRANCH, NONE, UPDTviewStorage
Three strategies are currently available to manage view storage location.
$class: 'DefaultViewStorage'$class: 'ServerViewStorage'assignedLabelString
Label expression used to populate view storage location dropdown.
Stringserver
The view storage location that will be passed to the -stgloc option.
The list of available servers is retrieved using cleartool lsstgloc -view
Note that auto is always available.
String$class: 'SpecificViewStorage'winStorageDir
StringunixStorageDir
StringbuildFoundationBaseline
If checked, instead of creating a view on the current stream, the job will look up the current foundation baselines for the given stream and work in readonly on these baselines. If polling is enabled, the build will be triggered every time a new foundation baseline is detected on the given stream.
boolean$class: 'CloneWorkspaceSCM'parentJobName
Stringcriteria
String$class: 'CmvcSCM'family
Stringbecome
Stringreleases
StringcheckoutScript
StringtrackViewReportWhereClause
String$class: 'ConfigurationRotator'acrs
$class: 'ClearCaseUCM'pvobName
Stringcontribute
Contribute data to a global database. Defined in the Compatibility Action Storage Plugin.
booleantargets
baselineName
Stringlevel
INITIAL, BUILT, TESTED, RELEASED, REJECTEDfixed
booleanuseNewest (optional)
boolean$class: 'Git'targets
name
Stringrepository
Stringbranch
StringcommitId
Stringfixed
booleanuseNewest (optional)
boolean$class: 'CvsProjectset'repositories
cvsRoot
StringpasswordRequired
booleanpassword
StringrepositoryItems
location
$class: 'BranchRepositoryLocation'branchName
StringuseHeadIfNotFound
boolean$class: 'HeadRepositoryLocation'$class: 'TagRepositoryLocation'tagName
StringuseHeadIfNotFound
booleanmodules
remoteName
StringlocalName
StringprojectsetFileName
StringexcludedRegions
src/main/web/.*\.html src/main/web/.*\.jpeg src/main/web/.*\.gifThe example above illustrates that if only html/jpeg/gif files have been committed to the SCM a build will not occur. More information on regular expressions can be found here.
pattern
StringcompressionLevel
intrepositoryBrowser
$class: 'FishEyeCVS'url
String$class: 'OpenGrok'url
String$class: 'ViewCVS'url
StringcanUseUpdate
booleanusername
Stringpassword
Stringbrowser
$class: 'FishEyeCVS'url
String$class: 'OpenGrok'url
String$class: 'ViewCVS'url
StringskipChangeLog
booleanpruneEmptyDirectories
booleandisableCvsQuiet
booleancleanOnFailedUpdate
booleanforceCleanCopy
boolean$class: 'DarcsScm'source
StringlocalDir
Stringclean
booleanbrowser
$class: 'DarcsWeb'url
Stringrepo
String$class: 'Darcsden'url
String$class: 'DelegateSCM'clazz
String$class: 'DimensionsSCM'project
Stringfolders
StringpathsToExclude
Stringworkarea
StringcanJobDelete
booleancanJobForce
booleancanJobRevert
booleanjobUserName
StringjobPasswd
StringjobServer
StringjobDatabase
StringcanJobUpdate
booleanjobTimeZone
StringjobWebUrl
Stringdirectory
Stringpermissions
Stringeol
StringcanJobExpand
booleancanJobNoMetadata
booleancanJobNoTouch
booleanforceAsSlave
boolean$class: 'DrushMakefileSCM'makefile
Specify the content of the Makefile. Support for YAML Makefiles depends on the version of Drush you have installed.
This example will generate a vanilla Drupal 7.38:
api=2
core=7.x
projects[drupal][version]=7.38
Stringroot
String$class: 'EndevorConfiguration'connectionId
StringfilterPattern
StringfileExtension
StringcredentialsId
StringtargetFolder
Stringfilesystempath
The file path for the source code.
e.g. \\Server1\project1\src or c:\myproject\src
Note for distributed build environment, please make sure the path is accessible on remote node(s)
StringclearWorkspace
If true, the system will delete all existing files/sub-folders in workspace before checking-out. Poll changes will not be affected by this setting.
booleancopyHidden
If true, the system will copy hidden files and folders as well. Default is false.
booleanfilterSettings
includeFilter
booleanselectors
You can apply wildcard filter(s) when detecting changes and copying files. By default, the system will filter out hidden files, on Unix, that means files/folder starting with ".", on Windows, that means files/folders with "hidden" attribute. You may want to filter out, e.g. files with ".tmp" extension.
Note: filters are applied on both sides, source and destination (i.e. the workspace). E.g. if you filter out ".tmp" files, all ".tmp" files currently in workspace will not be removed.
wildcard
ANT style wildcard.
To include just *.java, set filter type to "Include" and type add "*.java" (without quote) in the wildcard. To exclude *.exe" and all JUnit test cases, set filter type to "Exclude" and add two wildcard, one for "*.dll" and one for "*Test*"
To exclude a directory, set filter to "**/dir_to_exclude/**"
Note: (1) the wildcard is case insensitive, (2) all backslashes (\) will be replaced with slashes (/)
String$class: 'FeatureBranchAwareMercurialSCM'installation
Stringsource
Stringbranch
Stringmodules
Stringsubdir
my/sources (use forward slashes). If changing this entry, you probably want to clean the workspace first.
Stringbrowser
$class: 'BitBucket'url
String$class: 'FishEye'url
String$class: 'GoogleCode'url
String$class: 'HgWeb'url
String$class: 'Kallithea'url
String$class: 'KilnHG'url
String$class: 'RhodeCode'url
String$class: 'RhodeCodeLegacy'url
Stringclean
booleanbranchPattern
String$class: 'GeneXusServerSCM'gxInstallationId
StringserverURL
StringcredentialsId
StringkbName
StringkbVersion
StringlocalKbPath
StringlocalKbVersion
StringkbDbServerInstance
StringkbDbCredentialsId
StringkbDbName
StringkbDbInSameFolder
boolean$class: 'GitSCM'userRemoteConfigs
${SUPER_PROJECT_URL}/${SUBMODULE}, rather than relying on information from .gitmodules.url
Stringname
You normally want to specify this when you have multiple remote repositories.
Stringrefspec
In other words, the default refspec is "+refs/heads/*:refs/remotes/REPOSITORYNAME/*" where REPOSITORYNAME is the value you specify in the above "name of repository" textbox.
When do you want to modify this value? A good example is when you want to just retrieve one branch. For example, +refs/heads/master:refs/remotes/origin/master would only retrieve the master branch and nothing else.
The plugin uses a default refspec for its initial fetch, unless the "Advanced Clone Option" is set to honor refspec. This keeps 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. +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.
See the term definition in Git user manual for more details.
StringcredentialsId
Stringbranches
name
Specify the branches if you'd like to track a specific branch in a repository. If left blank, all branches will be examined for changes and built.
The safest way is to use the refs/heads/<branchName> syntax. This way the expected branch is unambiguous.
If your branch name has a / in it make sure to use the full reference above. When not presented with a full path the plugin will only use the part of the string right of the last slash. Meaning foo/bar will actually match bar
.If you use a wildcard branch specifier, with a slash (e.g. release/), you'll need to specify the origin repository in the branch names to make sure changes are picked up. So e.g. origin/release/
Possible options:
StringdoGenerateSubmoduleConfigurations
booleansubmoduleCfg
hudson.plugins.git.SubmoduleConfig
browser
$class: 'AssemblaWeb'repoUrl
String$class: 'BacklogGitRepositoryBrowser'repoName
StringrepoUrl
String$class: 'BitbucketWeb'repoUrl
String$class: 'CGit'repoUrl
String$class: 'FisheyeGitRepositoryBrowser'repoUrl
String$class: 'GitBlitRepositoryBrowser'repoUrl
StringprojectName
String$class: 'GitBucketBrowser'url
String$class: 'GitLab'repoUrl
Stringversion (optional)
String$class: 'GitList'repoUrl
String$class: 'GitWeb'repoUrl
String$class: 'GiteaBrowser'repoUrl
https://gitea.example.com then the URL for bob's skunkworks project repository might be
https://gitea.example.com/bob/skunkworks
String$class: 'GithubWeb'repoUrl
String$class: 'Gitiles'repoUrl
String$class: 'GitoriousWeb'repoUrl
String$class: 'GogsGit'repoUrl
String$class: 'KilnGit'repoUrl
String$class: 'Phabricator'repoUrl
Stringrepo
String$class: 'RedmineWeb'repoUrl
String$class: 'RhodeCode'repoUrl
String$class: 'Stash'repoUrl
String$class: 'TFS2013GitRepositoryBrowser'repoUrl
If TFS is also used as the repository server, this can usually be left blank.
String$class: 'TracGitRepositoryBrowser'$class: 'ViewGitWeb'repoUrl
StringprojectName
StringgitTool
Stringextensions
$class: 'AuthorInChangelog'$class: 'BuildChooserSetting'This extension point in Jenkins is used by many other plugins to control the job to build specific commits. When you activate those plugins, you may see them installing a custom strategy here.
buildChooser
$class: 'AlternativeBuildChooser'$class: 'AncestryBuildChooser'maximumAgeInDays
intancestorCommitSha1
String$class: 'DefaultBuildChooser'$class: 'DeflakeGitBuildChooser'$class: 'GerritTriggerBuildChooser'$class: 'InverseBuildChooser'$class: 'ChangelogToBranch'options
compareRemote
StringcompareTarget
String$class: 'CheckoutOption'timeout
int$class: 'CleanBeforeCheckout'$class: 'CleanCheckout'$class: 'CloneOption'shallow
booleannoTags
booleanreference
Stringtimeout
intdepth (optional)
inthonorRefspec (optional)
boolean$class: 'CodeCommitURLHelper'credentialId
OPTIONAL: Select the credentials to use.
If not specified, defaults to the DefaultAWSCredentialsProviderChain behaviour - *FROM THE JENKINS INSTANCE*
In the latter case, usage of IAM Role Profiles seems not to work, thus relying on environment variables / system properties or the ~/.aws/credentials file, thus not recommended.
StringrepositoryName
String$class: 'DisableRemotePoll'$class: 'GitLFSPull'$class: 'GitTagMessageExtension'useMostRecentTag (optional)
boolean$class: 'IgnoreNotifyCommit'$class: 'LocalBranch'If selected, and its 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/newfeature.
Please note that this has not been tested with submodules.
localBranch
String$class: 'MessageExclusion'excludedMessage
.*\[maven-release-plugin\].*The example above illustrates that if only revisions with "[maven-release-plugin]" message in first comment line have been committed to the SCM a build will not occur. You can create more complex patterns using embedded flag expressions.
(?s).*FOO.*This example will search FOO message in all comment lines.
String$class: 'PathRestriction'includedRegions
myapp/src/main/web/.*\.html
myapp/src/main/web/.*\.jpeg
myapp/src/main/web/.*\.gif
The example above illustrates that a build will only occur, if html/jpeg/gif files have been committed to the SCM. Exclusions take precedence over inclusions, if there is an overlap between included and excluded regions.
StringexcludedRegions
myapp/src/main/web/.*\.html
myapp/src/main/web/.*\.jpeg
myapp/src/main/web/.*\.gif
The example above illustrates that if only html/jpeg/gif files have been committed to the SCM a build will not occur.
String$class: 'PerBuildTag'$class: 'PreBuildMerge'options
mergeTarget
StringfastForwardMode (optional)
FF, FF_ONLY, NO_FFmergeRemote (optional)
StringmergeStrategy (optional)
DEFAULT, RESOLVE, RECURSIVE, OCTOPUS, OURS, SUBTREE, RECURSIVE_THEIRSpretestedIntegrationgitIntegrationStrategy
accumulatedshortCommitMessage (optional)
booleansquashintegrationBranch
The branch name must match your integration branch name. No trailing slash.
git checkout -B <Branch name> <Repository name>/<Branch name>
git merge --squash <Branch matched by git>
git commit -C <Branch matched by git>
git checkout -B <Branch name> <Repository name>/<Branch name>
git merge -m <commitMsg> <Branch matched by git> --no-ff
Changes are only ever pushed when the build results is SUCCESS
git push <Repository name> <Branch name>StringrepoName
The repository name. In git the repository is always the name of the remote. So if you have specified a repository name in your Git configuration. You need to specify the exact same name here, otherwise no integration will be performed. We do the merge based on this.
No trailing slash on repository name.
Remember to specify this when working with NAMED repositories in Git
String$class: 'PruneStaleBranch'$class: 'RelativeTargetDirectory'relativeTargetDir
String$class: 'ScmName'Unique name for this SCM. Needed when using Git within the Multi SCM plugin.
name
String$class: 'SparseCheckoutPaths'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
sparseCheckoutPaths
path
String$class: 'SubmoduleOption'disableSubmodules
booleanrecursiveSubmodules
booleantrackingSubmodules
booleanreference
git init --bare git remote add SubProject1 https://gitrepo.com/subproject1 git remote add SubProject2 https://gitrepo.com/subproject2 git fetch --all
Stringtimeout
intparentCredentials
booleandepth (optional)
intshallow (optional)
booleanthreads (optional)
int$class: 'UserExclusion'excludedUsers
auto_build_userThe example above illustrates that if only revisions by "auto_build_user" have been committed to the SCM a build will not occur.
String$class: 'UserIdentity'name
If given, "git config user.name [this]" is called before builds. This overrides whatever is in the global settings.
Stringemail
If given, "git config user.email [this]" is called before builds. This overrides whatever is in the global settings.
String$class: 'WipeWorkspace'$class: 'HarvestSCM'broker
StringpasswordFile
StringuserId
Stringpassword
StringprojectName
Stringstate
StringviewPath
StringclientPath
StringprocessName
StringrecursiveSearch
StringuseSynchronize
booleanextraOptions
String$class: 'IspwConfiguration'connectionId
StringcredentialsId
StringserverConfig
StringserverStream
StringserverApplication
StringserverLevel
StringlevelOption
StringcomponentType
StringfolderName
StringispwDownloadAll
boolean$class: 'IspwContainerConfiguration'connectionId
StringcredentialsId
StringserverConfig
StringcontainerName
StringcontainerType
StringserverLevel
StringcomponentType
StringispwDownloadAll
boolean$class: 'MercurialSCM'source
Stringbrowser (optional)
$class: 'BitBucket'url
String$class: 'FishEye'url
String$class: 'GoogleCode'url
String$class: 'HgWeb'url
String$class: 'Kallithea'url
String$class: 'KilnHG'url
String$class: 'RhodeCode'url
String$class: 'RhodeCodeLegacy'url
Stringclean (optional)
booleancredentialsId (optional)
StringdisableChangeLog (optional)
booleaninstallation (optional)
Stringmodules (optional)
Stringrevision (optional)
default branch.)
StringrevisionType (optional)
BRANCH, TAG, CHANGESET, REVSETsubdir (optional)
my/sources (use forward slashes). If changing this entry, you probably want to clean the workspace first.
String$class: 'MergeBotUpdater'$class: 'MultiSCM'$class: 'OpenShiftImageStreams'imageStreamName
Stringtag
StringapiURL
Stringnamespace
StringauthToken
Stringverbose
String$class: 'PdsConfiguration'connectionId
StringfilterPattern
StringfileExtension
StringcredentialsId
StringtargetFolder
String$class: 'PerforceSCM'p4User
Stringp4Passwd
Stringp4Client
Stringp4Port
StringprojectOptions
Stringp4Tool
Stringp4SysRoot
Stringp4SysDrive
Stringp4Label
Stringp4Counter
Stringp4UpstreamProject
StringlineEndValue
Stringp4Charset
Stringp4CommandCharset
StringclientOwner
StringupdateCounterValue
booleanforceSync
booleandontUpdateServer
booleanalwaysForceSync
booleancreateWorkspace
booleanupdateView
booleandisableChangeLogOnly
booleandisableSyncOnly
booleanshowIntegChanges
booleandontUpdateClient
booleanexposeP4Passwd
booleanpollOnlyOnMaster
booleanslaveClientNameFormat
StringfirstChange
intfileLimit
intbrowser
$class: 'FishEyePerforce'url
StringrootModule
String$class: 'P4Web'url
String$class: 'Perfbrowse'url
StringexcludedUsers
StringexcludedFiles
StringexcludedFilesCaseSensitivity
booleandepotType
value
Stringp4Stream
StringclientSpec
StringprojectPath
StringcleanWorkspace
cleanType
value
StringrestoreChangedDeletedFiles
booleanwipeRepoBeforeBuild
booleanuseViewMask
viewMask
StringuseViewMaskForPolling
booleanuseViewMaskForSyncing
booleanuseViewMaskForChangeLog
booleanperforcecredential
Select the appropriate credential for the Perforce connection. Perforce Credentials are defined in the Jenkins Credentials plugin here.
There are two types:
Stringworkspace
Select the appropriate Perforce workspace behaviour from the list. Not all modes will suit all Jenkins Job build types.
There are five types:
manualSpeccharset
The character set used by Jenkins when syncing files from the Perforce server. This should be set to 'none' unless connected to a Unicode enabled Perforce server.
StringpinHost
booleanname
Specify the name of the Perforce workspace to be used as the Jenkins build workspace. If the workspace does not yet exist, the configuration will be saved in Jenkins; the workspace is created only when it is to be used. If the workspace exists and you are connected to a Perforce server the auto-text fill should list suitable workspaces; updates are only applied when the workspace is used.
Stringspec
allwrite
booleanclobber
booleancompress
booleanlocked
booleanmodtime
booleanrmdir
booleanstreamName
Stringline
Set line-ending character(s) for client text files.
linefeed: UNIX style.
carriage return: Macintosh style. (obsolete)
carriage return-linefeed: Windows style.
hybrid: writes UNIX style but reads UNIX, Mac or Windows style.
Stringview
Lines to map depot files into the client workspace.
Maps files in the depot to files in your client workspace. Defines the files that you want in your client workspace and specifies where you want them to reside. The default view maps all depot files onto the client. See 'p4 help views' for view syntax. A new view takes effect on the next 'p4 sync'.
StringchangeView
Stringtype
Type of client: writeable/readonly/partitioned/graph
By default all clients are 'writeable', certain clients are short lived and perform long sync and build cycles. Over time these build clients can fragment the 'db.have' table which is used to track what files a client has synced. Setting a type of 'readonly' gives the client its own personal 'db.have' database table. A 'readonly' client cannot 'edit' or 'submit' files, however for build automation this is not usually a requirement and the performance tradeoff is worth considering if your build automation is causing issues with the 'db.have' table. This option requires that an administrator has first configured the 'client.readonly.dir' setting. If it is necessary to submit changes as part of your build, you may specify a 'partitioned' client: like a 'reaonly' client, this type also has a separate 'db.have' table under the 'client.readonly.dir' directory, but allows journalled 'edit' and 'submit' of files.
StringserverID
Stringbackup
Client's participation in backup enable/disable. If not specified backup of a writable client defaults to enabled.
booleancleanup
booleansyncID (optional)
StringspecFileSpeccharset
The character set used by Jenkins when syncing files from the Perforce server. This should be set to 'none' unless connected to a Unicode enabled Perforce server.
StringpinHost
booleanname
Specify the name of the Perforce workspace to be used as the Jenkins build workspace. If the workspace does not yet exist, the configuration will be saved in Jenkins; the workspace is created only when it is to be used. If the workspace exists and you are connected to a Perforce server the auto-text fill should list suitable workspaces; updates are only applied when the workspace is used.
StringspecPath
StringsyncID (optional)
StringstaticSpeccharset
The character set used by Jenkins when syncing files from the Perforce server. This should be set to 'none' unless connected to a Unicode enabled Perforce server.
StringpinHost
booleanname
Specify the name of an existing workspace in Perforce to be used as the Jenkins build workspace. If connected to a Perforce server the auto-text fill should list suitable workspaces
StringsyncID (optional)
StringstreamSpeccharset
The character set used by Jenkins when syncing files from the Perforce server. This should be set to 'none' unless connected to a Unicode enabled Perforce server.
StringpinHost
booleanstreamName
Specify the full Perforce depot path for the given stream. If connected to a Perforce server the auto-text fill should list possible streams.
For example: //stream-depot/main-streamStringformat
Jenklin slave nodes must each use a unique Perforce workspace. The format string configures the workspace name by substituting the specified variables: (at least one variable must be used)
Variables can be taken from the Jenkins Environment or Parameterized builds
StringsyncID (optional)
StringtemplateSpeccharset
The character set used by Jenkins when syncing files from the Perforce server. This should be set to 'none' unless connected to a Unicode enabled Perforce server.
StringpinHost
booleantemplateName
Specify the name of an existing workspace in Perforce used to create or update a Jenkins build workspace. If connected to a Perforce server the auto-text fill should list suitable workspaces
Stringformat
Jenklin slave nodes must each use a unique Perforce workspace. The format string configures the workspace name by substituting the specified variables: (at least one variable must be used)
Variables can be taken from the Jenkins Environment or Parameterized builds
StringsyncID (optional)
Stringfilter
pathFilterpath
Changes can be filtered to not trigger a build; if all the files within a change match the specified path, the build is filtered.
For example, with a Filter of " //depot/main/tests ":
Case A (change will be filtered):
Files:
//depot/main/tests/index.xml //depot/main/tests/001/test.xml //depot/main/tests/002/test.xml Case B (change will not be filtered, as build.xml is outside of the filter):
Files:
//depot/main/src/build.xml //depot/main/tests/004/test.xml //depot/main/tests/005/test.xml This is not Perforce syntax. Use of ... and * patterns are not supported. Only paths to directories are supported.
StringviewPatternpatternText
Changes can be filtered to not trigger a build; if none of the files within a change match a Java pattern (regular expression) listed, the build is filtered.
For example, with the following regular expressions:
//depot/main/tests.*
//depot/main/src/.*\.cpp
//depot/main/build/.*(?:\.rb|\.py|\.bat|Jenkinsfile)
//depot/main/lib/(?!Lib1|Lib2).*
Case A (change will not be filtered, as these files match our first pattern on "tests"):
Files:
//depot/main/tests/CONTRIUBTING.md //depot/main/tests/001/index.xml Case B (Be careful with incomplete file paths! Change will NOT be filtered,
as this file matches a pattern which was likely intended as describing a "tests/" directory.)
Files:
//depot/main/tests.doc Case C (change will NOT be filtered, as all files match our fourth pattern looking for script files in 'build/'):
Files:
//depot/main/build/rbs/deploy_server.rb //depot/main/build/deploy/deploy.bat //depot/main/build/Jenkinsfile Case D (change will be filtered, as no file matches our second pattern for ".cpp" files under "main/src"):
Files:
//depot/main/src/howto.doc //depot/main/src/oldmain.c //depot/main/src/art/splash.bmp //depot/main/src/bt/funnelcake.php Case E (change will be filtered. Lib1 is included in a negative lookahead, and thus is excluded.)
Files:
//depot/main/lib/Lib1/build.xml StringcaseSensitive
booleanincrementalperChange
booleanuserFilteruser
Changes can be filtered to not trigger a build; if the owner of a change matches the specified name, the build is filtered.
StringviewFilterviewMask
Changes can be filtered to not trigger a build; if none of the files within a change are contained in the view mask, the build is filtered.
For example, with a View Mask Filter of:
//depot/main/tests
-//depot/main/tests/001
Case A (change will not be filtered, as index.xml is in the view mask):
Files:
//depot/main/tests/index.xml //depot/main/tests/001/test.xml Case B (change will not be filtered, as index.xml is in the view mask):
Files:
//depot/main/test/index.xml //depot/main/src/build.xml Case C (change will be filtered, as no file is in the view mask):
Files:
//depot/main/src/build.xml Case D (change will be filtered, as no file is in the view mask):
Files:
//depot/main/src/build.xml //depot/main/tests/001/test.xml Stringpopulate
Perforce will populate the workspace with the file revisions needed for the build. The different options effect the way the workspace is cleaned and the file revisions are updated.
There are three options:
autoCleanreplace
Perforce will check out and overwrite any depot files which are either missing from workspace, or have been modified locally.
booleandelete
Perforce will delete any local files that are not in the depot.
booleantidy
booleanmodtime
booleanquiet
Enables the -q flag for all applicable Perforce operations. Summary details will still be displayed.
booleanpin
When a build is triggered by Polling, Build Now or an external Action, the workspace will sync only to the specified label. Any other specified change or label will be ignored.
Supports variable expansion e.g. ${VAR}. If 'now' is used, or a variable that expands to 'now', then the latest change is used (within the scope of the workspace view).
Stringparallel
enable
booleanpath
Stringthreads
Stringminfiles
Stringminbytes
StringpreviewOnlyquiet
Enables the -q flag for all applicable Perforce operations. Summary details will still be displayed.
booleanpin
StringflushOnlyquiet
booleanpin
When a build is triggered by Polling, Build Now or an external Action, the workspace will flush only to the specified label or changelist number. Any other specified change or label will be ignored.
Supports variable expansion e.g. ${VAR}. If 'now' is used, or a variable that expands to 'now', then the latest change is used (within the scope of the workspace view).
StringforceCleanhave
booleanquiet
Enables the -q flag for all applicable Perforce operations. Summary details will still be displayed.
booleanpin
When a build is triggered by Polling, Build Now or an external Action, the workspace will sync only to the specified label. Any other specified change or label will be ignored.
Supports variable expansion e.g. ${VAR}. If 'now' is used, or a variable that expands to 'now', then the latest change is used (within the scope of the workspace view).
Stringparallel
enable
booleanpath
Stringthreads
Stringminfiles
Stringminbytes
StringgraphCleanquiet
Enables the -q flag for all applicable Perforce operations. Summary details will still be displayed.
booleanpin
When a build is triggered by Polling, Build Now or an external Action, the workspace will sync only to the specified label. Any other specified change or label will be ignored.
Supports variable expansion e.g. ${VAR}. If 'now' is used, or a variable that expands to 'now', then the latest change is used (within the scope of the workspace view).
Stringparallel
enable
booleanpath
Stringthreads
Stringminfiles
Stringminbytes
StringsyncOnlyrevert
booleanhave
booleanforce
booleanmodtime
booleanquiet
Enables the -q flag for all applicable Perforce operations. Summary details will still be displayed.
booleanpin
When a build is triggered by Polling, Build Now or an external Action, the workspace will sync only to the specified label. Any other specified change or label will be ignored.
Supports variable expansion e.g. ${VAR}. If 'now' is used, or a variable that expands to 'now', then the latest change is used (within the scope of the workspace view).
Stringparallel
enable
booleanpath
Stringthreads
Stringminfiles
Stringminbytes
Stringbrowser
fishEyeurl
StringrootModule
StringopenGrokurl
StringdepotPath
StringprojectName
Stringp4Weburl
Stringswarmurl
String$class: 'PlasticSCM'selector
StringworkspaceName
StringuseUpdate
booleanuseMultipleWorkspaces
booleanadditionalWorkspaces
selector
StringworkspaceName
StringuseUpdate
boolean$class: 'ProxySCM'projectName
String$class: 'PvcsScm'projectRoot
StringarchiveRoot
StringchangeLogPrefixFudge
StringmoduleDir
StringloginId
StringpvcsWorkspace
StringpromotionGroup
StringversionLabel
StringcleanCopy
boolean$class: 'RTCScm'overrideGlobal
The build toolkit location and Jazz Repository connection can be defined globally or overridden. If not defined globally, it must be overridden.
booleanbuildTool
The RTC build toolkit to use when performing builds. The toolkits available are defined in the system configuration (with the other tools like Ant and Java). The build toolkit is also necessary on the Master for polling and validating the job configuration unless the "Avoid using build toolkit on Master" option is enabled.
StringserverURI
The Jazz Repository connection URI for the Rational Team Concert (RTC) server
Stringtimeout
The timeout period in seconds for Jazz repository requests made during the build.
intuserId
The build user id. Either credentials or a user id and password information should be supplied.
Stringpassword
The Jazz Repository password for the build user. The use of a password is not secure, it can be easily discovered by anyone with access to this page. Credentials, a password file or a password should be supplied.
hudson.util.Secret
passwordFile
The path to the file containing the obfuscated Jazz Repository password for the build user. Credentials, a password file or a password should be supplied.
StringcredentialsId
Credentials to use for the build user. A user name and password credential for the Jazz Repository should be configured.
StringbuildType
value
StringbuildDefinition
StringbuildWorkspace
StringbuildSnapshot
StringbuildStream
StringacceptBeforeLoad (optional)
booleanbuildSnapshotContext (optional)
snapshotOwnerType
StringprocessAreaOfOwningStream
StringowningStream
StringowningWorkspace
StringclearLoadDirectory (optional)
booleancomponentLoadConfig (optional)
StringcomponentsToExclude (optional)
StringcreateFoldersForComponents (optional)
booleancurrentSnapshotOwnerType (optional)
StringcustomizedSnapshotName (optional)
StringgenerateChangelogWithGoodBuild (optional)
booleanloadDirectory (optional)
StringloadPolicy (optional)
StringoverrideDefaultSnapshotName (optional)
booleanpathToLoadRuleFile (optional)
StringprocessArea (optional)
StringuseDynamicLoadRules (optional)
booleanavoidUsingToolkit
Where possible avoid using the Build toolkit when performing tasks on the Master. This is still in the experimental stage. You will require an RTC 5.0 server which provides some of the services used.
The Build toolkit will not be used when polling RTC and terminating the RTC Build. The toolkit is still required though. It is used for other configuration tasks on the Master (i.e. validating the connection to RTC, the build definition or workspace). It is also used for checkout tasks typically performed on slave nodes.
boolean$class: 'SCLMSCM'server
Stringport
intcredentialsId
StringJESINTERFACELEVEL1
booleanproject
Stringalternate
Stringgroup
Stringtypes
StringcustJobStep
booleanJobStep
StringcustJobHeader
booleanJobHeader
String$class: 'ShellScriptSCM'checkoutShell
StringpollingShell
StringuseCheckoutForPolling
boolean$class: 'SimpleClearCaseSCM'loadRules
/vobs/structure/package/product/subproduct
/vobs/structure/package/product/anothersubproduct.
Stringviewname
Stringbranch
Stringfilter
boolean$class: 'StarTeamSCM'hostname
Stringport
intprojectname
Stringviewname
Stringfoldername
Stringusername
Stringpassword
Stringlabelname
Stringpromotionstate
boolean$class: 'StoreSCM'scriptName
StringrepositoryName
Stringpundles
pundleType
PACKAGE, BUNDLEname
StringversionRegex
StringminimumBlessingLevel
StringgenerateParcelBuilderInputFile
booleanparcelBuilderInputFilename
String$class: 'SubversionSCM'locations
remote
StringcredentialsId
Stringlocal
.) may be used to check out the project directly into the workspace rather than into a subdirectory.
StringdepthOption
StringignoreExternalsOption
svn:externals to gain read access to the entire Subversion repository. This can happen if you follow the normal practice of giving Jenkins credentials with read access to the entire Subversion repository. You will also need to provide the credentials to use when checking/polling out the svn:externals using the
Additional Credentials option.
booleancancelProcessOnExternalsFail
booleanworkspaceUpdater
$class: 'CheckoutUpdater'$class: 'NoopUpdater'$class: 'UpdateUpdater'$class: 'UpdateWithCleanUpdater'$class: 'UpdateWithRevertUpdater'browser
$class: 'Assembla'spaceName
String$class: 'BacklogRepositoryBrowser'url
When no value is set, project of "Backlog URL" set above is used.
String$class: 'CollabNetSVN'url
String$class: 'FishEyeSVN'url
StringrootModule
String$class: 'Phabricator'url
Stringrepo
String$class: 'PolarionRepositoryBrowser'url
Stringlocation
String$class: 'RedmineRepositoryBrowser'repositoryId
String$class: 'SVNWeb'url
String$class: 'Sventon'url
StringrepositoryInstance
String$class: 'Sventon2'url
StringrepositoryInstance
String$class: 'TeamForge'connectionFactory
url
This should be the URL of your CollabNet TeamForge site. It should be of the form 'https://forge.collab.net'.
Stringusername
The user who will upload the files.
Stringpassword
The password for the user specified above. If incorrectly given, the login to the CollabNet TeamForge server will fail.
Stringproject
Stringrepo
String$class: 'TracRepositoryBrowser'$class: 'ViewSVN'url
String$class: 'ViewVCRepositoryBrowser'url
Stringlocation
String$class: 'VisualSVN'url
String$class: 'WebSVN'url
StringexcludedRegions
/trunk/myapp/src/main/web/.*\.html /trunk/myapp/src/main/web/.*\.jpeg /trunk/myapp/src/main/web/.*\.gifThe example above illustrates that if only html/jpeg/gif files have been committed to the SCM a build will not occur. More information on regular expressions can be found here.
StringexcludedUsers
auto_build_userThe example above illustrates that if only revisions by "auto_build_user" have been committed to the SCM a build will not occur.
StringexcludedRevprop
StringexcludedCommitMessages
StringincludedRegions
/trunk/myapp/c/library1/.* /trunk/myapp/c/library2/.*If /trunk/myapp is checked out, the build will only occur when there are changes to either the c/library1 and c/library2 subtrees. If there are also excluded regions specified, then a file is not ignored when it is in the included list and not in the excluded list. More information on regular expressions can be found here.
StringignoreDirPropChanges
booleanfilterChangelog
booleanadditionalCredentials
If there are additional credentials required in order to obtain a complete checkout of the source, they can be provided here.
The realm is how the repository self-identifies to a client. It usually has the following format:
<proto://host:port> Realm Name
proto is the protocol, e.g. http or svn.host is the host how it's accessed by Jenkins, e.g. as IP address 192.168.1.100, host name svnserver, or host name and domain svn.example.org.port is the port, even if not explicitly specified. By default, this is 80 for HTTP, 443 for HTTPS, 3690 for the svn protocol.Realm Name is how the repository self-identifies. Common options include VisualSVN Server, Subversion Authentication or the UUID of the repository.To find out the realm, you could do any of the following:
Realm Name (see above) in the authentication dialog.svn program.
svn info https://svnserver/repo and it will tell you the realm when asking you to enter a password, e.g.: Authentication realm: <svn://svnserver:3690> VisualSVN Server.~/.subversion/auth/svn/simple; it will be two lines below the line svn:realmstring.svn+ssh protocol, the realm has the format username@svn+ssh://host:port – note that the username is before the svn+ssh:// (unlike the URL used for normal SVN operations), and that there are no angle brackets and no realm name. For this protocol the default port is 22.Make sure to enter the realm exactly as shown, starting with a < (except for repositories accessed via svn+ssh – see above).
realm
<scheme://hostname(:port)> name, while for servers accessed via
svn+ssh it is of the format
(username@)svn+ssh://hostname(:port).
StringcredentialsId
StringquietOperation
Mimics subversion command line --quiet parameter for check out / update operations to help keep the output shorter. Prints nothing, or only summary information.
boolean$class: 'SurroundSCM'server
StringserverPort
Stringbranch
Stringrepository
StringcredentialsId
StringrsaKey (optional)
rsaKeyFileId (optional)
StringrsaKeyFilePath (optional)
StringrsaKeyType (optional)
NoKey, Path, IDrsaKeyValue (optional)
StringrsaKeyFileId (optional)
StringrsaKeyFilePath (optional)
StringrsaKeyPath (optional)
String$class: 'SynergySCM'project
Stringdatabase
Stringrelease
Stringpurpose
Stringusername
Stringpassword
Stringengine
StringoldProject
Stringbaseline
StringoldBaseline
StringccmHome
StringremoteClient
booleandetectConflict
booleanreplaceSubprojects
booleancheckForUpdateWarnings
booleanleaveSessionOpen
booleanmaintainWorkarea
booleancheckTaskModifiedObjects
boolean$class: 'TeamFoundationServerScm'serverUrl
/DefaultCollection.
http://tfs.example.com:8080/tfs/DefaultCollectionhttps://tfs.example.com:8080/tfs/CustomCollectionhttps://fabrikam-fiber-inc.visualstudio.comHistorically, this field was labeled "Server URL" because earlier versions of TFS did not support team project collections.
StringprojectPath
The name of the project as it is registered on the server.
StringworkspaceName
The name of the Workspace under which the source should be retrieved. This workspace is created as needed. You can normally omit the property unless you want to name a workspace to avoid conflicts on the server (i.e. when you have multiple projects on one server talking to TFS/Team Services)
The default value is to create a workspace named Hudson-${JOB_NAME}. The TFS plugin for Jenkins supports the following macros that are replaced in the workspace name:
StringuserName
Stringpassword
hudson.util.Secret
cloakedPaths (optional)
Paths that are cloaked will not be pulled into the local workspace during a GET from the TFVC repository.
Check-ins that contain files only in cloaked folders (in other words, fully cloaked) will not trigger a build, whereas a check-in containing any path that isn't cloaked will trigger a build.
For example, suppose the Project path is $/Example/project/path, and the repository contains the following subfolders:
$/Example/project/path/ANow, suppose the following paths were entered as Cloaked Paths:
$/Example/project/path/A/1
$/Example/project/path/A/2
$/Example/project/path/B
$/Example/project/path/C
$/Example/project/path/A/2...then the resulting workspace on the Jenkins server would only have the following folders:
$/Example/project/path/B
$/Example/project/path/A
$/Example/project/path/A/1
$/Example/project/path/C
To continue with the example, the following check-in will not trigger a build, because it only contains changes under cloaked paths:
$/Example/project/path/A/2/alpha.txt...whereas this check-in will trigger a build, because it contains at least one path that isn't cloaked:
$/Example/project/path/A/2/second.txt
$/Example/project/path/B/bravo.txt
$/Example/project/path/A/1/first.txt
$/Example/project/path/A/2/second.txt
$/Example/project/path/B/bravo.txt
StringcredentialsConfigurer (optional)
$class: 'AutomaticCredentialsConfigurer'$class: 'ManualCredentialsConfigurer'userName
The name of the user that will be connecting to TFS/Team Services to query history, checkout files, etc.
For [on-premises] Team Foundation Server, the user name can be specified in two ways:
For Team Services, there are also two options:
Stringpassword
hudson.util.Secret
localPath (optional)
The folder where all files will be retrieved into. The folder name is a relative path, under the workspace of the current job.
The default setting is to retrieve the files into the workspace (ie. the workfolder is ".".
StringuseOverwrite (optional)
booleanuseUpdate (optional)
booleanversionSpec (optional)
String$class: 'VaultSCM'serverName
Stringpath
StringuserName
Stringpassword
StringrepositoryName
StringvaultName
StringsslEnabled
booleanuseNonWorkingFolder
booleanmerge
StringfileTime
StringmakeWritableEnabled
booleanverboseEnabled
boolean$class: 'hudson.plugins.gradle_repo.RepoScm'repositoryUrl
Stringbranch
String$class: 'hudson.plugins.repo.RepoScm'manifestRepositoryUrl
StringcurrentBranch (optional)
booleandepth (optional)
intdestinationDir (optional)
StringforceSync (optional)
booleanignoreProjects (optional)
Stringjobs (optional)
intlocalManifest (optional)
StringmanifestBranch (optional)
StringmanifestFile (optional)
StringmanifestGroup (optional)
StringmirrorDir (optional)
StringnoTags (optional)
booleanquiet (optional)
booleanrepoUrl (optional)
StringresetFirst (optional)
booleanshowAllChanges (optional)
booleantrace (optional)
boolean$class: 'OpenShiftImageStreams'imageStreamName
Stringtag
StringapiURL
Stringnamespace
StringauthToken
Stringverbose
String$class: 'PdsConfiguration'connectionId
StringfilterPattern
StringfileExtension
StringcredentialsId
StringtargetFolder
String$class: 'PerforceSCM'p4User
Stringp4Passwd
Stringp4Client
Stringp4Port
StringprojectOptions
Stringp4Tool
Stringp4SysRoot
Stringp4SysDrive
Stringp4Label
Stringp4Counter
Stringp4UpstreamProject
StringlineEndValue
Stringp4Charset
Stringp4CommandCharset
StringclientOwner
StringupdateCounterValue
booleanforceSync
booleandontUpdateServer
booleanalwaysForceSync
booleancreateWorkspace
booleanupdateView
booleandisableChangeLogOnly
booleandisableSyncOnly
booleanshowIntegChanges
booleandontUpdateClient
booleanexposeP4Passwd
booleanpollOnlyOnMaster
booleanslaveClientNameFormat
StringfirstChange
intfileLimit
intbrowser
$class: 'FishEyePerforce'url
StringrootModule
String$class: 'P4Web'url
String$class: 'Perfbrowse'url
StringexcludedUsers
StringexcludedFiles
StringexcludedFilesCaseSensitivity
booleandepotType
value
Stringp4Stream
StringclientSpec
StringprojectPath
StringcleanWorkspace
cleanType
value
StringrestoreChangedDeletedFiles
booleanwipeRepoBeforeBuild
booleanuseViewMask
viewMask
StringuseViewMaskForPolling
booleanuseViewMaskForSyncing
booleanuseViewMaskForChangeLog
booleanperforcecredential
Select the appropriate credential for the Perforce connection. Perforce Credentials are defined in the Jenkins Credentials plugin here.
There are two types:
Stringworkspace
Select the appropriate Perforce workspace behaviour from the list. Not all modes will suit all Jenkins Job build types.
There are five types:
manualSpeccharset
The character set used by Jenkins when syncing files from the Perforce server. This should be set to 'none' unless connected to a Unicode enabled Perforce server.
StringpinHost
booleanname
Specify the name of the Perforce workspace to be used as the Jenkins build workspace. If the workspace does not yet exist, the configuration will be saved in Jenkins; the workspace is created only when it is to be used. If the workspace exists and you are connected to a Perforce server the auto-text fill should list suitable workspaces; updates are only applied when the workspace is used.
Stringspec
allwrite
booleanclobber
booleancompress
booleanlocked
booleanmodtime
booleanrmdir
booleanstreamName
Stringline
Set line-ending character(s) for client text files.
linefeed: UNIX style.
carriage return: Macintosh style. (obsolete)
carriage return-linefeed: Windows style.
hybrid: writes UNIX style but reads UNIX, Mac or Windows style.
Stringview
Lines to map depot files into the client workspace.
Maps files in the depot to files in your client workspace. Defines the files that you want in your client workspace and specifies where you want them to reside. The default view maps all depot files onto the client. See 'p4 help views' for view syntax. A new view takes effect on the next 'p4 sync'.
StringchangeView
Stringtype
Type of client: writeable/readonly/partitioned/graph
By default all clients are 'writeable', certain clients are short lived and perform long sync and build cycles. Over time these build clients can fragment the 'db.have' table which is used to track what files a client has synced. Setting a type of 'readonly' gives the client its own personal 'db.have' database table. A 'readonly' client cannot 'edit' or 'submit' files, however for build automation this is not usually a requirement and the performance tradeoff is worth considering if your build automation is causing issues with the 'db.have' table. This option requires that an administrator has first configured the 'client.readonly.dir' setting. If it is necessary to submit changes as part of your build, you may specify a 'partitioned' client: like a 'reaonly' client, this type also has a separate 'db.have' table under the 'client.readonly.dir' directory, but allows journalled 'edit' and 'submit' of files.
StringserverID
Stringbackup
Client's participation in backup enable/disable. If not specified backup of a writable client defaults to enabled.
booleancleanup
booleansyncID (optional)
StringspecFileSpeccharset
The character set used by Jenkins when syncing files from the Perforce server. This should be set to 'none' unless connected to a Unicode enabled Perforce server.
StringpinHost
booleanname
Specify the name of the Perforce workspace to be used as the Jenkins build workspace. If the workspace does not yet exist, the configuration will be saved in Jenkins; the workspace is created only when it is to be used. If the workspace exists and you are connected to a Perforce server the auto-text fill should list suitable workspaces; updates are only applied when the workspace is used.
StringspecPath
StringsyncID (optional)
StringstaticSpeccharset
The character set used by Jenkins when syncing files from the Perforce server. This should be set to 'none' unless connected to a Unicode enabled Perforce server.
StringpinHost
booleanname
Specify the name of an existing workspace in Perforce to be used as the Jenkins build workspace. If connected to a Perforce server the auto-text fill should list suitable workspaces
StringsyncID (optional)
StringstreamSpeccharset
The character set used by Jenkins when syncing files from the Perforce server. This should be set to 'none' unless connected to a Unicode enabled Perforce server.
StringpinHost
booleanstreamName
Specify the full Perforce depot path for the given stream. If connected to a Perforce server the auto-text fill should list possible streams.
For example: //stream-depot/main-streamStringformat
Jenklin slave nodes must each use a unique Perforce workspace. The format string configures the workspace name by substituting the specified variables: (at least one variable must be used)
Variables can be taken from the Jenkins Environment or Parameterized builds
StringsyncID (optional)
StringtemplateSpeccharset
The character set used by Jenkins when syncing files from the Perforce server. This should be set to 'none' unless connected to a Unicode enabled Perforce server.
StringpinHost
booleantemplateName
Specify the name of an existing workspace in Perforce used to create or update a Jenkins build workspace. If connected to a Perforce server the auto-text fill should list suitable workspaces
Stringformat
Jenklin slave nodes must each use a unique Perforce workspace. The format string configures the workspace name by substituting the specified variables: (at least one variable must be used)
Variables can be taken from the Jenkins Environment or Parameterized builds
StringsyncID (optional)
Stringfilter
pathFilterpath
Changes can be filtered to not trigger a build; if all the files within a change match the specified path, the build is filtered.
For example, with a Filter of " //depot/main/tests ":
Case A (change will be filtered):
Files:
//depot/main/tests/index.xml //depot/main/tests/001/test.xml //depot/main/tests/002/test.xml Case B (change will not be filtered, as build.xml is outside of the filter):
Files:
//depot/main/src/build.xml //depot/main/tests/004/test.xml //depot/main/tests/005/test.xml This is not Perforce syntax. Use of ... and * patterns are not supported. Only paths to directories are supported.
StringviewPatternpatternText
Changes can be filtered to not trigger a build; if none of the files within a change match a Java pattern (regular expression) listed, the build is filtered.
For example, with the following regular expressions:
//depot/main/tests.*
//depot/main/src/.*\.cpp
//depot/main/build/.*(?:\.rb|\.py|\.bat|Jenkinsfile)
//depot/main/lib/(?!Lib1|Lib2).*
Case A (change will not be filtered, as these files match our first pattern on "tests"):
Files:
//depot/main/tests/CONTRIUBTING.md //depot/main/tests/001/index.xml Case B (Be careful with incomplete file paths! Change will NOT be filtered,
as this file matches a pattern which was likely intended as describing a "tests/" directory.)
Files:
//depot/main/tests.doc Case C (change will NOT be filtered, as all files match our fourth pattern looking for script files in 'build/'):
Files:
//depot/main/build/rbs/deploy_server.rb //depot/main/build/deploy/deploy.bat //depot/main/build/Jenkinsfile Case D (change will be filtered, as no file matches our second pattern for ".cpp" files under "main/src"):
Files:
//depot/main/src/howto.doc //depot/main/src/oldmain.c //depot/main/src/art/splash.bmp //depot/main/src/bt/funnelcake.php Case E (change will be filtered. Lib1 is included in a negative lookahead, and thus is excluded.)
Files:
//depot/main/lib/Lib1/build.xml StringcaseSensitive
booleanincrementalperChange
booleanuserFilteruser
Changes can be filtered to not trigger a build; if the owner of a change matches the specified name, the build is filtered.
StringviewFilterviewMask
Changes can be filtered to not trigger a build; if none of the files within a change are contained in the view mask, the build is filtered.
For example, with a View Mask Filter of:
//depot/main/tests
-//depot/main/tests/001
Case A (change will not be filtered, as index.xml is in the view mask):
Files:
//depot/main/tests/index.xml //depot/main/tests/001/test.xml Case B (change will not be filtered, as index.xml is in the view mask):
Files:
//depot/main/test/index.xml //depot/main/src/build.xml Case C (change will be filtered, as no file is in the view mask):
Files:
//depot/main/src/build.xml Case D (change will be filtered, as no file is in the view mask):
Files:
//depot/main/src/build.xml //depot/main/tests/001/test.xml Stringpopulate
Perforce will populate the workspace with the file revisions needed for the build. The different options effect the way the workspace is cleaned and the file revisions are updated.
There are three options:
autoCleanreplace
Perforce will check out and overwrite any depot files which are either missing from workspace, or have been modified locally.
booleandelete
Perforce will delete any local files that are not in the depot.
booleantidy
booleanmodtime
booleanquiet
Enables the -q flag for all applicable Perforce operations. Summary details will still be displayed.
booleanpin
When a build is triggered by Polling, Build Now or an external Action, the workspace will sync only to the specified label. Any other specified change or label will be ignored.
Supports variable expansion e.g. ${VAR}. If 'now' is used, or a variable that expands to 'now', then the latest change is used (within the scope of the workspace view).
Stringparallel
enable
booleanpath
Stringthreads
Stringminfiles
Stringminbytes
StringpreviewOnlyquiet
Enables the -q flag for all applicable Perforce operations. Summary details will still be displayed.
booleanpin
StringflushOnlyquiet
booleanpin
When a build is triggered by Polling, Build Now or an external Action, the workspace will flush only to the specified label or changelist number. Any other specified change or label will be ignored.
Supports variable expansion e.g. ${VAR}. If 'now' is used, or a variable that expands to 'now', then the latest change is used (within the scope of the workspace view).
StringforceCleanhave
booleanquiet
Enables the -q flag for all applicable Perforce operations. Summary details will still be displayed.
booleanpin
When a build is triggered by Polling, Build Now or an external Action, the workspace will sync only to the specified label. Any other specified change or label will be ignored.
Supports variable expansion e.g. ${VAR}. If 'now' is used, or a variable that expands to 'now', then the latest change is used (within the scope of the workspace view).
Stringparallel
enable
booleanpath
Stringthreads
Stringminfiles
Stringminbytes
StringgraphCleanquiet
Enables the -q flag for all applicable Perforce operations. Summary details will still be displayed.
booleanpin
When a build is triggered by Polling, Build Now or an external Action, the workspace will sync only to the specified label. Any other specified change or label will be ignored.
Supports variable expansion e.g. ${VAR}. If 'now' is used, or a variable that expands to 'now', then the latest change is used (within the scope of the workspace view).
Stringparallel
enable
booleanpath
Stringthreads
Stringminfiles
Stringminbytes
StringsyncOnlyrevert
booleanhave
booleanforce
booleanmodtime
booleanquiet
Enables the -q flag for all applicable Perforce operations. Summary details will still be displayed.
booleanpin
When a build is triggered by Polling, Build Now or an external Action, the workspace will sync only to the specified label. Any other specified change or label will be ignored.
Supports variable expansion e.g. ${VAR}. If 'now' is used, or a variable that expands to 'now', then the latest change is used (within the scope of the workspace view).
Stringparallel
enable
booleanpath
Stringthreads
Stringminfiles
Stringminbytes
Stringbrowser
fishEyeurl
StringrootModule
StringopenGrokurl
StringdepotPath
StringprojectName
Stringp4Weburl
Stringswarmurl
String$class: 'PlasticSCM'selector
StringworkspaceName
StringuseUpdate
booleanuseMultipleWorkspaces
booleanadditionalWorkspaces
selector
StringworkspaceName
StringuseUpdate
boolean$class: 'ProxySCM'projectName
String$class: 'PvcsScm'projectRoot
StringarchiveRoot
StringchangeLogPrefixFudge
StringmoduleDir
StringloginId
StringpvcsWorkspace
StringpromotionGroup
StringversionLabel
StringcleanCopy
boolean$class: 'RTCScm'overrideGlobal
The build toolkit location and Jazz Repository connection can be defined globally or overridden. If not defined globally, it must be overridden.
booleanbuildTool
The RTC build toolkit to use when performing builds. The toolkits available are defined in the system configuration (with the other tools like Ant and Java). The build toolkit is also necessary on the Master for polling and validating the job configuration unless the "Avoid using build toolkit on Master" option is enabled.
StringserverURI
The Jazz Repository connection URI for the Rational Team Concert (RTC) server
Stringtimeout
The timeout period in seconds for Jazz repository requests made during the build.
intuserId
The build user id. Either credentials or a user id and password information should be supplied.
Stringpassword
The Jazz Repository password for the build user. The use of a password is not secure, it can be easily discovered by anyone with access to this page. Credentials, a password file or a password should be supplied.
hudson.util.Secret
passwordFile
The path to the file containing the obfuscated Jazz Repository password for the build user. Credentials, a password file or a password should be supplied.
StringcredentialsId
Credentials to use for the build user. A user name and password credential for the Jazz Repository should be configured.
StringbuildType
value
StringbuildDefinition
StringbuildWorkspace
StringbuildSnapshot
StringbuildStream
StringacceptBeforeLoad (optional)
booleanbuildSnapshotContext (optional)
snapshotOwnerType
StringprocessAreaOfOwningStream
StringowningStream
StringowningWorkspace
StringclearLoadDirectory (optional)
booleancomponentLoadConfig (optional)
StringcomponentsToExclude (optional)
StringcreateFoldersForComponents (optional)
booleancurrentSnapshotOwnerType (optional)
StringcustomizedSnapshotName (optional)
StringgenerateChangelogWithGoodBuild (optional)
booleanloadDirectory (optional)
StringloadPolicy (optional)
StringoverrideDefaultSnapshotName (optional)
booleanpathToLoadRuleFile (optional)
StringprocessArea (optional)
StringuseDynamicLoadRules (optional)
booleanavoidUsingToolkit
Where possible avoid using the Build toolkit when performing tasks on the Master. This is still in the experimental stage. You will require an RTC 5.0 server which provides some of the services used.
The Build toolkit will not be used when polling RTC and terminating the RTC Build. The toolkit is still required though. It is used for other configuration tasks on the Master (i.e. validating the connection to RTC, the build definition or workspace). It is also used for checkout tasks typically performed on slave nodes.
boolean$class: 'SCLMSCM'server
Stringport
intcredentialsId
StringJESINTERFACELEVEL1
booleanproject
Stringalternate
Stringgroup
Stringtypes
StringcustJobStep
booleanJobStep
StringcustJobHeader
booleanJobHeader
String$class: 'ShellScriptSCM'checkoutShell
StringpollingShell
StringuseCheckoutForPolling
boolean$class: 'SimpleClearCaseSCM'loadRules
/vobs/structure/package/product/subproduct
/vobs/structure/package/product/anothersubproduct.
Stringviewname
Stringbranch
Stringfilter
boolean$class: 'StarTeamSCM'hostname
Stringport
intprojectname
Stringviewname
Stringfoldername
Stringusername
Stringpassword
Stringlabelname
Stringpromotionstate
boolean$class: 'StoreSCM'scriptName
StringrepositoryName
Stringpundles
pundleType
PACKAGE, BUNDLEname
StringversionRegex
StringminimumBlessingLevel
StringgenerateParcelBuilderInputFile
booleanparcelBuilderInputFilename
String$class: 'SubversionSCM'locations
remote
StringcredentialsId
Stringlocal
.) may be used to check out the project directly into the workspace rather than into a subdirectory.
StringdepthOption
StringignoreExternalsOption
svn:externals to gain read access to the entire Subversion repository. This can happen if you follow the normal practice of giving Jenkins credentials with read access to the entire Subversion repository. You will also need to provide the credentials to use when checking/polling out the svn:externals using the
Additional Credentials option.
booleancancelProcessOnExternalsFail
booleanworkspaceUpdater
$class: 'CheckoutUpdater'$class: 'NoopUpdater'$class: 'UpdateUpdater'$class: 'UpdateWithCleanUpdater'$class: 'UpdateWithRevertUpdater'browser
$class: 'Assembla'spaceName
String$class: 'BacklogRepositoryBrowser'url
When no value is set, project of "Backlog URL" set above is used.
String$class: 'CollabNetSVN'url
String$class: 'FishEyeSVN'url
StringrootModule
String$class: 'Phabricator'url
Stringrepo
String$class: 'PolarionRepositoryBrowser'url
Stringlocation
String$class: 'RedmineRepositoryBrowser'repositoryId
String$class: 'SVNWeb'url
String$class: 'Sventon'url
StringrepositoryInstance
String$class: 'Sventon2'url
StringrepositoryInstance
String$class: 'TeamForge'connectionFactory
url
This should be the URL of your CollabNet TeamForge site. It should be of the form 'https://forge.collab.net'.
Stringusername
The user who will upload the files.
Stringpassword
The password for the user specified above. If incorrectly given, the login to the CollabNet TeamForge server will fail.
Stringproject
Stringrepo
String$class: 'TracRepositoryBrowser'$class: 'ViewSVN'url
String$class: 'ViewVCRepositoryBrowser'url
Stringlocation
String$class: 'VisualSVN'url
String$class: 'WebSVN'url
StringexcludedRegions
/trunk/myapp/src/main/web/.*\.html /trunk/myapp/src/main/web/.*\.jpeg /trunk/myapp/src/main/web/.*\.gifThe example above illustrates that if only html/jpeg/gif files have been committed to the SCM a build will not occur. More information on regular expressions can be found here.
StringexcludedUsers
auto_build_userThe example above illustrates that if only revisions by "auto_build_user" have been committed to the SCM a build will not occur.
StringexcludedRevprop
StringexcludedCommitMessages
StringincludedRegions
/trunk/myapp/c/library1/.* /trunk/myapp/c/library2/.*If /trunk/myapp is checked out, the build will only occur when there are changes to either the c/library1 and c/library2 subtrees. If there are also excluded regions specified, then a file is not ignored when it is in the included list and not in the excluded list. More information on regular expressions can be found here.
StringignoreDirPropChanges
booleanfilterChangelog
booleanadditionalCredentials
If there are additional credentials required in order to obtain a complete checkout of the source, they can be provided here.
The realm is how the repository self-identifies to a client. It usually has the following format:
<proto://host:port> Realm Name
proto is the protocol, e.g. http or svn.host is the host how it's accessed by Jenkins, e.g. as IP address 192.168.1.100, host name svnserver, or host name and domain svn.example.org.port is the port, even if not explicitly specified. By default, this is 80 for HTTP, 443 for HTTPS, 3690 for the svn protocol.Realm Name is how the repository self-identifies. Common options include VisualSVN Server, Subversion Authentication or the UUID of the repository.To find out the realm, you could do any of the following:
Realm Name (see above) in the authentication dialog.svn program.
svn info https://svnserver/repo and it will tell you the realm when asking you to enter a password, e.g.: Authentication realm: <svn://svnserver:3690> VisualSVN Server.~/.subversion/auth/svn/simple; it will be two lines below the line svn:realmstring.svn+ssh protocol, the realm has the format username@svn+ssh://host:port – note that the username is before the svn+ssh:// (unlike the URL used for normal SVN operations), and that there are no angle brackets and no realm name. For this protocol the default port is 22.Make sure to enter the realm exactly as shown, starting with a < (except for repositories accessed via svn+ssh – see above).
realm
<scheme://hostname(:port)> name, while for servers accessed via
svn+ssh it is of the format
(username@)svn+ssh://hostname(:port).
StringcredentialsId
StringquietOperation
Mimics subversion command line --quiet parameter for check out / update operations to help keep the output shorter. Prints nothing, or only summary information.
boolean$class: 'SurroundSCM'server
StringserverPort
Stringbranch
Stringrepository
StringcredentialsId
StringrsaKey (optional)
rsaKeyFileId (optional)
StringrsaKeyFilePath (optional)
StringrsaKeyType (optional)
NoKey, Path, IDrsaKeyValue (optional)
StringrsaKeyFileId (optional)
StringrsaKeyFilePath (optional)
StringrsaKeyPath (optional)
String$class: 'SynergySCM'project
Stringdatabase
Stringrelease
Stringpurpose
Stringusername
Stringpassword
Stringengine
StringoldProject
Stringbaseline
StringoldBaseline
StringccmHome
StringremoteClient
booleandetectConflict
booleanreplaceSubprojects
booleancheckForUpdateWarnings
booleanleaveSessionOpen
booleanmaintainWorkarea
booleancheckTaskModifiedObjects
boolean$class: 'TeamFoundationServerScm'serverUrl
/DefaultCollection.
http://tfs.example.com:8080/tfs/DefaultCollectionhttps://tfs.example.com:8080/tfs/CustomCollectionhttps://fabrikam-fiber-inc.visualstudio.comHistorically, this field was labeled "Server URL" because earlier versions of TFS did not support team project collections.
StringprojectPath
The name of the project as it is registered on the server.
StringworkspaceName
The name of the Workspace under which the source should be retrieved. This workspace is created as needed. You can normally omit the property unless you want to name a workspace to avoid conflicts on the server (i.e. when you have multiple projects on one server talking to TFS/Team Services)
The default value is to create a workspace named Hudson-${JOB_NAME}. The TFS plugin for Jenkins supports the following macros that are replaced in the workspace name:
StringuserName
Stringpassword
hudson.util.Secret
cloakedPaths (optional)
Paths that are cloaked will not be pulled into the local workspace during a GET from the TFVC repository.
Check-ins that contain files only in cloaked folders (in other words, fully cloaked) will not trigger a build, whereas a check-in containing any path that isn't cloaked will trigger a build.
For example, suppose the Project path is $/Example/project/path, and the repository contains the following subfolders:
$/Example/project/path/ANow, suppose the following paths were entered as Cloaked Paths:
$/Example/project/path/A/1
$/Example/project/path/A/2
$/Example/project/path/B
$/Example/project/path/C
$/Example/project/path/A/2...then the resulting workspace on the Jenkins server would only have the following folders:
$/Example/project/path/B
$/Example/project/path/A
$/Example/project/path/A/1
$/Example/project/path/C
To continue with the example, the following check-in will not trigger a build, because it only contains changes under cloaked paths:
$/Example/project/path/A/2/alpha.txt...whereas this check-in will trigger a build, because it contains at least one path that isn't cloaked:
$/Example/project/path/A/2/second.txt
$/Example/project/path/B/bravo.txt
$/Example/project/path/A/1/first.txt
$/Example/project/path/A/2/second.txt
$/Example/project/path/B/bravo.txt
StringcredentialsConfigurer (optional)
$class: 'AutomaticCredentialsConfigurer'$class: 'ManualCredentialsConfigurer'userName
The name of the user that will be connecting to TFS/Team Services to query history, checkout files, etc.
For [on-premises] Team Foundation Server, the user name can be specified in two ways:
For Team Services, there are also two options:
Stringpassword
hudson.util.Secret
localPath (optional)
The folder where all files will be retrieved into. The folder name is a relative path, under the workspace of the current job.
The default setting is to retrieve the files into the workspace (ie. the workfolder is ".".
StringuseOverwrite (optional)
booleanuseUpdate (optional)
booleanversionSpec (optional)
String$class: 'VaultSCM'serverName
Stringpath
StringuserName
Stringpassword
StringrepositoryName
StringvaultName
StringsslEnabled
booleanuseNonWorkingFolder
booleanmerge
StringfileTime
StringmakeWritableEnabled
booleanverboseEnabled
boolean$class: 'hudson.plugins.gradle_repo.RepoScm'repositoryUrl
Stringbranch
String$class: 'hudson.plugins.repo.RepoScm'manifestRepositoryUrl
StringcurrentBranch (optional)
booleandepth (optional)
intdestinationDir (optional)
StringforceSync (optional)
booleanignoreProjects (optional)
Stringjobs (optional)
intlocalManifest (optional)
StringmanifestBranch (optional)
StringmanifestFile (optional)
StringmanifestGroup (optional)
StringmirrorDir (optional)
StringnoTags (optional)
booleanquiet (optional)
booleanrepoUrl (optional)
StringresetFirst (optional)
booleanshowAllChanges (optional)
booleantrace (optional)
booleanmodernSCMscm
$class: 'BacklogPullRequestSCMSource'id
Stringremote
StringcredentialsId
Stringincludes
Stringexcludes
StringignoreOnPushNotifications
booleanurl
StringapiKey
API key when using Backlog API version 2.
Stringbrowser (optional)
$class: 'AssemblaWeb'repoUrl
String$class: 'BacklogGitRepositoryBrowser'repoName
StringrepoUrl
String$class: 'BitbucketWeb'repoUrl
String$class: 'CGit'repoUrl
String$class: 'FisheyeGitRepositoryBrowser'repoUrl
String$class: 'GitBlitRepositoryBrowser'repoUrl
StringprojectName
String$class: 'GitBucketBrowser'url
String$class: 'GitLab'repoUrl
Stringversion (optional)
String$class: 'GitList'repoUrl
String$class: 'GitWeb'repoUrl
String$class: 'GiteaBrowser'repoUrl
https://gitea.example.com then the URL for bob's skunkworks project repository might be
https://gitea.example.com/bob/skunkworks
String$class: 'GithubWeb'repoUrl
String$class: 'Gitiles'repoUrl
String$class: 'GitoriousWeb'repoUrl
String$class: 'GogsGit'repoUrl
String$class: 'KilnGit'repoUrl
String$class: 'Phabricator'repoUrl
Stringrepo
String$class: 'RedmineWeb'repoUrl
String$class: 'RhodeCode'repoUrl
String$class: 'Stash'repoUrl
String$class: 'TFS2013GitRepositoryBrowser'repoUrl
If TFS is also used as the repository server, this can usually be left blank.
String$class: 'TracGitRepositoryBrowser'$class: 'ViewGitWeb'repoUrl
StringprojectName
Stringextensions (optional)
$class: 'AuthorInChangelog'$class: 'BuildChooserSetting'This extension point in Jenkins is used by many other plugins to control the job to build specific commits. When you activate those plugins, you may see them installing a custom strategy here.
buildChooser
$class: 'AlternativeBuildChooser'$class: 'AncestryBuildChooser'maximumAgeInDays
intancestorCommitSha1
String$class: 'DefaultBuildChooser'$class: 'DeflakeGitBuildChooser'$class: 'GerritTriggerBuildChooser'$class: 'InverseBuildChooser'$class: 'ChangelogToBranch'options
compareRemote
StringcompareTarget
String$class: 'CheckoutOption'timeout
int$class: 'CleanBeforeCheckout'$class: 'CleanCheckout'$class: 'CloneOption'shallow
booleannoTags
booleanreference
Stringtimeout
intdepth (optional)
inthonorRefspec (optional)
boolean$class: 'CodeCommitURLHelper'credentialId
OPTIONAL: Select the credentials to use.
If not specified, defaults to the DefaultAWSCredentialsProviderChain behaviour - *FROM THE JENKINS INSTANCE*
In the latter case, usage of IAM Role Profiles seems not to work, thus relying on environment variables / system properties or the ~/.aws/credentials file, thus not recommended.
StringrepositoryName
String$class: 'DisableRemotePoll'$class: 'GitLFSPull'$class: 'GitTagMessageExtension'useMostRecentTag (optional)
boolean$class: 'IgnoreNotifyCommit'$class: 'LocalBranch'If selected, and its 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/newfeature.
Please note that this has not been tested with submodules.
localBranch
String$class: 'MessageExclusion'excludedMessage
.*\[maven-release-plugin\].*The example above illustrates that if only revisions with "[maven-release-plugin]" message in first comment line have been committed to the SCM a build will not occur. You can create more complex patterns using embedded flag expressions.
(?s).*FOO.*This example will search FOO message in all comment lines.
String$class: 'PathRestriction'includedRegions
myapp/src/main/web/.*\.html
myapp/src/main/web/.*\.jpeg
myapp/src/main/web/.*\.gif
The example above illustrates that a build will only occur, if html/jpeg/gif files have been committed to the SCM. Exclusions take precedence over inclusions, if there is an overlap between included and excluded regions.
StringexcludedRegions
myapp/src/main/web/.*\.html
myapp/src/main/web/.*\.jpeg
myapp/src/main/web/.*\.gif
The example above illustrates that if only html/jpeg/gif files have been committed to the SCM a build will not occur.
String$class: 'PerBuildTag'$class: 'PreBuildMerge'options
mergeTarget
StringfastForwardMode (optional)
FF, FF_ONLY, NO_FFmergeRemote (optional)
StringmergeStrategy (optional)
DEFAULT, RESOLVE, RECURSIVE, OCTOPUS, OURS, SUBTREE, RECURSIVE_THEIRSpretestedIntegrationgitIntegrationStrategy
accumulatedshortCommitMessage (optional)
booleansquashintegrationBranch
The branch name must match your integration branch name. No trailing slash.
git checkout -B <Branch name> <Repository name>/<Branch name>
git merge --squash <Branch matched by git>
git commit -C <Branch matched by git>
git checkout -B <Branch name> <Repository name>/<Branch name>
git merge -m <commitMsg> <Branch matched by git> --no-ff
Changes are only ever pushed when the build results is SUCCESS
git push <Repository name> <Branch name>StringrepoName
The repository name. In git the repository is always the name of the remote. So if you have specified a repository name in your Git configuration. You need to specify the exact same name here, otherwise no integration will be performed. We do the merge based on this.
No trailing slash on repository name.
Remember to specify this when working with NAMED repositories in Git
String$class: 'PruneStaleBranch'$class: 'RelativeTargetDirectory'relativeTargetDir
String$class: 'ScmName'Unique name for this SCM. Needed when using Git within the Multi SCM plugin.
name
String$class: 'SparseCheckoutPaths'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
sparseCheckoutPaths
path
String$class: 'SubmoduleOption'disableSubmodules
booleanrecursiveSubmodules
booleantrackingSubmodules
booleanreference
git init --bare git remote add SubProject1 https://gitrepo.com/subproject1 git remote add SubProject2 https://gitrepo.com/subproject2 git fetch --all
Stringtimeout
intparentCredentials
booleandepth (optional)
intshallow (optional)
booleanthreads (optional)
int$class: 'UserExclusion'excludedUsers
auto_build_userThe example above illustrates that if only revisions by "auto_build_user" have been committed to the SCM a build will not occur.
String$class: 'UserIdentity'name
If given, "git config user.name [this]" is called before builds. This overrides whatever is in the global settings.
Stringemail
If given, "git config user.email [this]" is called before builds. This overrides whatever is in the global settings.
String$class: 'WipeWorkspace'gitTool (optional)
StringmultiBranchcredential
Stringincludes (optional)
A List of Perforce Depot paths (separated by new lines). The plugin will search one directory level deep for a Jenkinsfile (or defined item) using the last directory name for the branch name.
For example, given an include path of: //depot/projA (or //depot/projA/* or //depot/projA/... as these get trimmed before they are passed to p4 dirs)
If a Jenkinsfile is found in //depot/projA/Main/Jenkinsfile and //depot/projA/R1.0/Jenkinsfile then two branches are created for the MultiBranch project 'Main' and 'R1.0'
Stringcharset (optional)
Stringformat (optional)
Stringbrowser (optional)
fishEyeurl
StringrootModule
StringopenGrokurl
StringdepotPath
StringprojectName
Stringp4Weburl
Stringswarmurl
Stringfilter (optional)
Only supports 'Polling per Change' option.>
pathFilterpath
Changes can be filtered to not trigger a build; if all the files within a change match the specified path, the build is filtered.
For example, with a Filter of " //depot/main/tests ":
Case A (change will be filtered):
Files:
//depot/main/tests/index.xml //depot/main/tests/001/test.xml //depot/main/tests/002/test.xml Case B (change will not be filtered, as build.xml is outside of the filter):
Files:
//depot/main/src/build.xml //depot/main/tests/004/test.xml //depot/main/tests/005/test.xml This is not Perforce syntax. Use of ... and * patterns are not supported. Only paths to directories are supported.
StringviewPatternpatternText
Changes can be filtered to not trigger a build; if none of the files within a change match a Java pattern (regular expression) listed, the build is filtered.
For example, with the following regular expressions:
//depot/main/tests.*
//depot/main/src/.*\.cpp
//depot/main/build/.*(?:\.rb|\.py|\.bat|Jenkinsfile)
//depot/main/lib/(?!Lib1|Lib2).*
Case A (change will not be filtered, as these files match our first pattern on "tests"):
Files:
//depot/main/tests/CONTRIUBTING.md //depot/main/tests/001/index.xml Case B (Be careful with incomplete file paths! Change will NOT be filtered,
as this file matches a pattern which was likely intended as describing a "tests/" directory.)
Files:
//depot/main/tests.doc Case C (change will NOT be filtered, as all files match our fourth pattern looking for script files in 'build/'):
Files:
//depot/main/build/rbs/deploy_server.rb //depot/main/build/deploy/deploy.bat //depot/main/build/Jenkinsfile Case D (change will be filtered, as no file matches our second pattern for ".cpp" files under "main/src"):
Files:
//depot/main/src/howto.doc //depot/main/src/oldmain.c //depot/main/src/art/splash.bmp //depot/main/src/bt/funnelcake.php Case E (change will be filtered. Lib1 is included in a negative lookahead, and thus is excluded.)
Files:
//depot/main/lib/Lib1/build.xml StringcaseSensitive
booleanincrementalperChange
booleanuserFilteruser
Changes can be filtered to not trigger a build; if the owner of a change matches the specified name, the build is filtered.
StringviewFilterviewMask
Changes can be filtered to not trigger a build; if none of the files within a change are contained in the view mask, the build is filtered.
For example, with a View Mask Filter of:
//depot/main/tests
-//depot/main/tests/001
Case A (change will not be filtered, as index.xml is in the view mask):
Files:
//depot/main/tests/index.xml //depot/main/tests/001/test.xml Case B (change will not be filtered, as index.xml is in the view mask):
Files:
//depot/main/test/index.xml //depot/main/src/build.xml Case C (change will be filtered, as no file is in the view mask):
Files:
//depot/main/src/build.xml Case D (change will be filtered, as no file is in the view mask):
Files:
//depot/main/src/build.xml //depot/main/tests/001/test.xml Stringmappings (optional)
A List of view mapping paths (separated by new lines). The plugin will create the branch workspace view with each mapping mapped to the branch path and client path.
Note: The Jenkinsfile path will automatically be added to the mappings.
Default: ... will be mapped to //depot/branch/... //client/branch/...
Example: myLibrary/... will be mapped to //depot/branch/myLibrary/... //client/branch/myLibrary/...
Stringpattern (optional)
Filters the list of candidate branches found by the initial search.
For example, a depot might contain several branches and you only want to build branches starting with 'com', set the Include Filter to: .*com.*
Stringpopulate (optional)
autoCleanreplace
Perforce will check out and overwrite any depot files which are either missing from workspace, or have been modified locally.
booleandelete
Perforce will delete any local files that are not in the depot.
booleantidy
booleanmodtime
booleanquiet
Enables the -q flag for all applicable Perforce operations. Summary details will still be displayed.
booleanpin
When a build is triggered by Polling, Build Now or an external Action, the workspace will sync only to the specified label. Any other specified change or label will be ignored.
Supports variable expansion e.g. ${VAR}. If 'now' is used, or a variable that expands to 'now', then the latest change is used (within the scope of the workspace view).
Stringparallel
enable
booleanpath
Stringthreads
Stringminfiles
Stringminbytes
StringpreviewOnlyquiet
Enables the -q flag for all applicable Perforce operations. Summary details will still be displayed.
booleanpin
StringflushOnlyquiet
booleanpin
When a build is triggered by Polling, Build Now or an external Action, the workspace will flush only to the specified label or changelist number. Any other specified change or label will be ignored.
Supports variable expansion e.g. ${VAR}. If 'now' is used, or a variable that expands to 'now', then the latest change is used (within the scope of the workspace view).
StringforceCleanhave
booleanquiet
Enables the -q flag for all applicable Perforce operations. Summary details will still be displayed.
booleanpin
When a build is triggered by Polling, Build Now or an external Action, the workspace will sync only to the specified label. Any other specified change or label will be ignored.
Supports variable expansion e.g. ${VAR}. If 'now' is used, or a variable that expands to 'now', then the latest change is used (within the scope of the workspace view).
Stringparallel
enable
booleanpath
Stringthreads
Stringminfiles
Stringminbytes
StringgraphCleanquiet
Enables the -q flag for all applicable Perforce operations. Summary details will still be displayed.
booleanpin
When a build is triggered by Polling, Build Now or an external Action, the workspace will sync only to the specified label. Any other specified change or label will be ignored.
Supports variable expansion e.g. ${VAR}. If 'now' is used, or a variable that expands to 'now', then the latest change is used (within the scope of the workspace view).
Stringparallel
enable
booleanpath
Stringthreads
Stringminfiles
Stringminbytes
StringsyncOnlyrevert
booleanhave
booleanforce
booleanmodtime
booleanquiet
Enables the -q flag for all applicable Perforce operations. Summary details will still be displayed.
booleanpin
When a build is triggered by Polling, Build Now or an external Action, the workspace will sync only to the specified label. Any other specified change or label will be ignored.
Supports variable expansion e.g. ${VAR}. If 'now' is used, or a variable that expands to 'now', then the latest change is used (within the scope of the workspace view).
Stringparallel
enable
booleanpath
Stringthreads
Stringminfiles
Stringminbytes
Stringtraits (optional)
$class: 'ApprovedPullRequestTrait'strategyId
int$class: 'AuthorInChangelogTrait'$class: 'BitbucketAgedRefsTrait'retentionDays
StringbitbucketBranchCommitSkipTraitbitbucketCommitSkipTrait$class: 'BitbucketJiraValidatorTrait'jiraServerIdx
int$class: 'CheckoutOptionTrait'extension
timeout
int$class: 'CleanAfterCheckoutTrait'$class: 'CleanBeforeCheckoutTrait'$class: 'CleanMercurialSCMSourceTrait'$class: 'CloneOptionTrait'extension
shallow
booleannoTags
booleanreference
Stringtimeout
intdepth (optional)
inthonorRefspec (optional)
boolean$class: 'DisableStatusUpdateTrait'$class: 'DiscoverOtherRefsTrait'ref
The pattern under /refs on the remote repository to discover, can contain a wildcard.
Example: test/*/merged
StringnameMapping (optional)
Mapping for how the ref can be named in for example the @Library.
Example: test-@{1}
Where @{1} replaces the first wildcard in the ref when discovered.
By default it will be "namespace_before_wildcard-@{1}". E.g. if ref is "test/*/merged" the default mapping would be "test-@{1}".
String$class: 'GitBrowserSCMSourceTrait'browser
$class: 'AssemblaWeb'repoUrl
String$class: 'BacklogGitRepositoryBrowser'repoName
StringrepoUrl
String$class: 'BitbucketWeb'repoUrl
String$class: 'CGit'repoUrl
String$class: 'FisheyeGitRepositoryBrowser'repoUrl
String$class: 'GitBlitRepositoryBrowser'repoUrl
StringprojectName
String$class: 'GitBucketBrowser'url
String$class: 'GitLab'repoUrl
Stringversion (optional)
String$class: 'GitList'repoUrl
String$class: 'GitWeb'repoUrl
String$class: 'GiteaBrowser'repoUrl
https://gitea.example.com then the URL for bob's skunkworks project repository might be
https://gitea.example.com/bob/skunkworks
String$class: 'GithubWeb'repoUrl
String$class: 'Gitiles'repoUrl
String$class: 'GitoriousWeb'repoUrl
String$class: 'GogsGit'repoUrl
String$class: 'KilnGit'repoUrl
String$class: 'Phabricator'repoUrl
Stringrepo
String$class: 'RedmineWeb'repoUrl
String$class: 'RhodeCode'repoUrl
String$class: 'Stash'repoUrl
String$class: 'TFS2013GitRepositoryBrowser'repoUrl
If TFS is also used as the repository server, this can usually be left blank.
String$class: 'TracGitRepositoryBrowser'$class: 'ViewGitWeb'repoUrl
StringprojectName
String$class: 'GitHubAgedRefsTrait'retentionDays
StringgitHubBranchCommitSkipTraitgitHubCommitSkipTrait$class: 'GitHubJiraValidatorTrait'jiraServerIdx
int$class: 'GitLFSPullTrait'$class: 'GitToolSCMSourceTrait'gitTool
String$class: 'IgnoreOnPushNotificationTrait'$class: 'LocalBranchTrait'$class: 'MercurialBrowserSCMSourceTrait'browser
$class: 'BitBucket'url
String$class: 'FishEye'url
String$class: 'GoogleCode'url
String$class: 'HgWeb'url
String$class: 'Kallithea'url
String$class: 'KilnHG'url
String$class: 'RhodeCode'url
String$class: 'RhodeCodeLegacy'url
String$class: 'MercurialInstallationSCMSourceTrait'installation
String$class: 'NotificationContextTrait'contextLabel
StringtypeSuffix
Appends the relevant suffix to the context label based on the build type. '/pr-merge', '/pr-head' or '/branch'
boolean$class: 'PreBuildMergeTrait'extension
options
mergeTarget
StringfastForwardMode (optional)
FF, FF_ONLY, NO_FFmergeRemote (optional)
StringmergeStrategy (optional)
DEFAULT, RESOLVE, RECURSIVE, OCTOPUS, OURS, SUBTREE, RECURSIVE_THEIRS$class: 'PretestedIntegrationSCMTrait'extension
gitIntegrationStrategy
accumulatedshortCommitMessage (optional)
booleansquashintegrationBranch
The branch name must match your integration branch name. No trailing slash.
git checkout -B <Branch name> <Repository name>/<Branch name>
git merge --squash <Branch matched by git>
git commit -C <Branch matched by git>
git checkout -B <Branch name> <Repository name>/<Branch name>
git merge -m <commitMsg> <Branch matched by git> --no-ff
Changes are only ever pushed when the build results is SUCCESS
git push <Repository name> <Branch name>StringrepoName
The repository name. In git the repository is always the name of the remote. So if you have specified a repository name in your Git configuration. You need to specify the exact same name here, otherwise no integration will be performed. We do the merge based on this.
No trailing slash on repository name.
Remember to specify this when working with NAMED repositories in Git
String$class: 'PruneStaleBranchTrait'$class: 'PublicRepoPullRequestFilterTrait'$class: 'RefSpecsSCMSourceTrait'templates
value
@{remote} will be replaced by the remote name (which defaults to
origin) before use.
String$class: 'RemoteNameSCMSourceTrait'remoteName
StringskipNotifications$class: 'SubmoduleOptionTrait'extension
disableSubmodules
booleanrecursiveSubmodules
booleantrackingSubmodules
booleanreference
git init --bare git remote add SubProject1 https://gitrepo.com/subproject1 git remote add SubProject2 https://gitrepo.com/subproject2 git fetch --all
Stringtimeout
intparentCredentials
booleandepth (optional)
intshallow (optional)
booleanthreads (optional)
int$class: 'UserIdentityTrait'extension
name
If given, "git config user.name [this]" is called before builds. This overrides whatever is in the global settings.
Stringemail
If given, "git config user.email [this]" is called before builds. This overrides whatever is in the global settings.
String$class: 'WipeWorkspaceTrait'$class: 'com.cloudbees.jenkins.plugins.bitbucket.BranchDiscoveryTrait'strategyId
int$class: 'com.cloudbees.jenkins.plugins.bitbucket.ForkPullRequestDiscoveryTrait'strategyId
inttrust
One of the great powers of pull requests is that anyone with read access to a repository can fork it, commit some changes to their fork and then create a pull request against the original repository with their changes. There are some files stored in source control that are important. For example, a Jenkinsfile may contain configuration details to sandbox pull requests in order to mitigate against malicious pull requests. In order to protect against a malicious pull request itself modifying the Jenkinsfile to remove the protections, you can define the trust policy for pull requests from forks.
Other plugins can extend the available trust policies. The default policies are:
Jenkinsfile) the contents of that file will be retrieved from the target branch on the origin repository and not from the pull request branch on the fork repository.
jenkins.scm.api.SCMRevision>
$class: 'com.cloudbees.jenkins.plugins.bitbucket.OriginPullRequestDiscoveryTrait'strategyId
int$class: 'com.cloudbees.jenkins.plugins.bitbucket.SSHCheckoutTrait'https:// protocol for the Git / Mercurial repository.
This behaviour allows you to select the SSH private key to be used for checking out sources, which will consequently force the checkout to use the ssh:// protocol.
credentialsId
String$class: 'com.cloudbees.jenkins.plugins.bitbucket.TagDiscoveryTrait'$class: 'com.cloudbees.jenkins.plugins.bitbucket.WebhookRegistrationTrait'Overrides the defaults for webhook management.
Webhooks are used to inform Jenkins about changes to repositories. There are two ways webhooks can be configured:
The Manage Jenkins » Configure Jenkins › Bitbucket Endpoints allows defining the list of servers. Each server can be associated with credentials. If credentials are defined then the default behaviour is to use those credentials to automatically manage the webhooks of all repositories that Jenkins is interested in. If no credentials are defined then the default behaviour is to require the user to manually configure webhooks.
mode
String$class: 'jenkins.plugins.gerrit.ChangeDiscoveryTrait'strategyId
int$class: 'jenkins.plugins.gerrit.traits.ChangeDiscoveryTrait'gitBranchDiscoverygitTagDiscoveryheadRegexFilterregex
StringheadWildcardFilterincludes
* as a wildcard; for example:
master release*
Stringexcludes
release
StringheadRegexFilterWithPRregex
StringheadWildcardFilterWithPRincludes
* as a wildcard; for example:
master release*
Stringexcludes
release
String$class: 'org.jenkinsci.plugin.gitea.BranchDiscoveryTrait'strategyId
int$class: 'org.jenkinsci.plugin.gitea.ForkPullRequestDiscoveryTrait'strategyId
inttrust
One of the great powers of pull requests is that anyone with read access to a repository can fork it, commit some changes to their fork and then create a pull request against the original repository with their changes. There are some files stored in source control that are important. For example, a Jenkinsfile may contain configuration details to sandbox pull requests in order to mitigate against malicious pull requests. In order to protect against a malicious pull request itself modifying the Jenkinsfile to remove the protections, you can define the trust policy for pull requests from forks.
Other plugins can extend the available trust policies. The default policies are:
Jenkinsfile) the contents of that file will be retrieved from the target branch on the origin repository and not from the pull request branch on the fork repository.
Nobody.
jenkins.scm.api.SCMRevision>
$class: 'org.jenkinsci.plugin.gitea.OriginPullRequestDiscoveryTrait'strategyId
int$class: 'org.jenkinsci.plugin.gitea.SSHCheckoutTrait'https:// protocol for the Git repository.
This behaviour allows you to select the SSH private key to be used for checking out sources, which will consequently force the checkout to use the ssh:// protocol.
credentialsId
String$class: 'org.jenkinsci.plugin.gitea.WebhookRegistrationTrait'mode
StringgitHubBranchDiscoverystrategyId
intgitHubForkDiscoverystrategyId
inttrust
One of the great powers of pull requests is that anyone with read access to a repository can fork it, commit some changes to their fork and then create a pull request against the original repository with their changes. There are some files stored in source control that are important. For example, a Jenkinsfile may contain configuration details to sandbox pull requests in order to mitigate against malicious pull requests. In order to protect against a malicious pull request itself modifying the Jenkinsfile to remove the protections, you can define the trust policy for pull requests from forks.
Other plugins can extend the available trust policies. The default policies are:
Jenkinsfile) the contents of that file will be retrieved from the target branch on the origin repository and not from the pull request branch on the fork repository.
Nobody.
NOTE: all collaborators are trusted, even if they are only members of a team with read permission.
jenkins.scm.api.SCMRevision>
$class: 'org.jenkinsci.plugins.github_branch_source.OriginPullRequestDiscoveryTrait'strategyId
int$class: 'org.jenkinsci.plugins.github_branch_source.SSHCheckoutTrait'https:// protocol for the Git repository.
This behaviour allows you to select the SSH private key to be used for checking out sources, which will consequently force the checkout to use the ssh:// protocol.
credentialsId
StringgitHubTagDiscoverygerritremote
Stringbrowser (optional)
$class: 'AssemblaWeb'repoUrl
String$class: 'BacklogGitRepositoryBrowser'repoName
StringrepoUrl
String$class: 'BitbucketWeb'repoUrl
String$class: 'CGit'repoUrl
String$class: 'FisheyeGitRepositoryBrowser'repoUrl
String$class: 'GitBlitRepositoryBrowser'repoUrl
StringprojectName
String$class: 'GitBucketBrowser'url
String$class: 'GitLab'repoUrl
Stringversion (optional)
String$class: 'GitList'repoUrl
String$class: 'GitWeb'repoUrl
String$class: 'GiteaBrowser'repoUrl
https://gitea.example.com then the URL for bob's skunkworks project repository might be
https://gitea.example.com/bob/skunkworks
String$class: 'GithubWeb'repoUrl
String$class: 'Gitiles'repoUrl
String$class: 'GitoriousWeb'repoUrl
String$class: 'GogsGit'repoUrl
String$class: 'KilnGit'repoUrl
String$class: 'Phabricator'repoUrl
Stringrepo
String$class: 'RedmineWeb'repoUrl
String$class: 'RhodeCode'repoUrl
String$class: 'Stash'repoUrl
String$class: 'TFS2013GitRepositoryBrowser'repoUrl
If TFS is also used as the repository server, this can usually be left blank.
String$class: 'TracGitRepositoryBrowser'$class: 'ViewGitWeb'repoUrl
StringprojectName
StringcredentialsId (optional)
Stringextensions (optional)
$class: 'AuthorInChangelog'$class: 'BuildChooserSetting'This extension point in Jenkins is used by many other plugins to control the job to build specific commits. When you activate those plugins, you may see them installing a custom strategy here.
buildChooser
$class: 'AlternativeBuildChooser'$class: 'AncestryBuildChooser'maximumAgeInDays
intancestorCommitSha1
String$class: 'DefaultBuildChooser'$class: 'DeflakeGitBuildChooser'$class: 'GerritTriggerBuildChooser'$class: 'InverseBuildChooser'$class: 'ChangelogToBranch'options
compareRemote
StringcompareTarget
String$class: 'CheckoutOption'timeout
int$class: 'CleanBeforeCheckout'$class: 'CleanCheckout'$class: 'CloneOption'shallow
booleannoTags
booleanreference
Stringtimeout
intdepth (optional)
inthonorRefspec (optional)
boolean$class: 'CodeCommitURLHelper'credentialId
OPTIONAL: Select the credentials to use.
If not specified, defaults to the DefaultAWSCredentialsProviderChain behaviour - *FROM THE JENKINS INSTANCE*
In the latter case, usage of IAM Role Profiles seems not to work, thus relying on environment variables / system properties or the ~/.aws/credentials file, thus not recommended.
StringrepositoryName
String$class: 'DisableRemotePoll'$class: 'GitLFSPull'$class: 'GitTagMessageExtension'useMostRecentTag (optional)
boolean$class: 'IgnoreNotifyCommit'$class: 'LocalBranch'If selected, and its 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/newfeature.
Please note that this has not been tested with submodules.
localBranch
String$class: 'MessageExclusion'excludedMessage
.*\[maven-release-plugin\].*The example above illustrates that if only revisions with "[maven-release-plugin]" message in first comment line have been committed to the SCM a build will not occur. You can create more complex patterns using embedded flag expressions.
(?s).*FOO.*This example will search FOO message in all comment lines.
String$class: 'PathRestriction'includedRegions
myapp/src/main/web/.*\.html
myapp/src/main/web/.*\.jpeg
myapp/src/main/web/.*\.gif
The example above illustrates that a build will only occur, if html/jpeg/gif files have been committed to the SCM. Exclusions take precedence over inclusions, if there is an overlap between included and excluded regions.
StringexcludedRegions
myapp/src/main/web/.*\.html
myapp/src/main/web/.*\.jpeg
myapp/src/main/web/.*\.gif
The example above illustrates that if only html/jpeg/gif files have been committed to the SCM a build will not occur.
String$class: 'PerBuildTag'$class: 'PreBuildMerge'options
mergeTarget
StringfastForwardMode (optional)
FF, FF_ONLY, NO_FFmergeRemote (optional)
StringmergeStrategy (optional)
DEFAULT, RESOLVE, RECURSIVE, OCTOPUS, OURS, SUBTREE, RECURSIVE_THEIRSpretestedIntegrationgitIntegrationStrategy
accumulatedshortCommitMessage (optional)
booleansquashintegrationBranch
The branch name must match your integration branch name. No trailing slash.
git checkout -B <Branch name> <Repository name>/<Branch name>
git merge --squash <Branch matched by git>
git commit -C <Branch matched by git>
git checkout -B <Branch name> <Repository name>/<Branch name>
git merge -m <commitMsg> <Branch matched by git> --no-ff
Changes are only ever pushed when the build results is SUCCESS
git push <Repository name> <Branch name>StringrepoName
The repository name. In git the repository is always the name of the remote. So if you have specified a repository name in your Git configuration. You need to specify the exact same name here, otherwise no integration will be performed. We do the merge based on this.
No trailing slash on repository name.
Remember to specify this when working with NAMED repositories in Git
String$class: 'PruneStaleBranch'$class: 'RelativeTargetDirectory'relativeTargetDir
String$class: 'ScmName'Unique name for this SCM. Needed when using Git within the Multi SCM plugin.
name
String$class: 'SparseCheckoutPaths'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
sparseCheckoutPaths
path
String$class: 'SubmoduleOption'disableSubmodules
booleanrecursiveSubmodules
booleantrackingSubmodules
booleanreference
git init --bare git remote add SubProject1 https://gitrepo.com/subproject1 git remote add SubProject2 https://gitrepo.com/subproject2 git fetch --all
Stringtimeout
intparentCredentials
booleandepth (optional)
intshallow (optional)
booleanthreads (optional)
int$class: 'UserExclusion'excludedUsers
auto_build_userThe example above illustrates that if only revisions by "auto_build_user" have been committed to the SCM a build will not occur.
String$class: 'UserIdentity'name
If given, "git config user.name [this]" is called before builds. This overrides whatever is in the global settings.
Stringemail
If given, "git config user.email [this]" is called before builds. This overrides whatever is in the global settings.
String$class: 'WipeWorkspace'gitTool (optional)
StringinsecureHttps (optional)
booleantraits (optional)
$class: 'ApprovedPullRequestTrait'strategyId
int$class: 'AuthorInChangelogTrait'$class: 'BitbucketAgedRefsTrait'retentionDays
StringbitbucketBranchCommitSkipTraitbitbucketCommitSkipTrait$class: 'BitbucketJiraValidatorTrait'jiraServerIdx
int$class: 'CheckoutOptionTrait'extension
timeout
int$class: 'CleanAfterCheckoutTrait'$class: 'CleanBeforeCheckoutTrait'$class: 'CleanMercurialSCMSourceTrait'$class: 'CloneOptionTrait'extension
shallow
booleannoTags
booleanreference
Stringtimeout
intdepth (optional)
inthonorRefspec (optional)
boolean$class: 'DisableStatusUpdateTrait'$class: 'DiscoverOtherRefsTrait'ref
The pattern under /refs on the remote repository to discover, can contain a wildcard.
Example: test/*/merged
StringnameMapping (optional)
Mapping for how the ref can be named in for example the @Library.
Example: test-@{1}
Where @{1} replaces the first wildcard in the ref when discovered.
By default it will be "namespace_before_wildcard-@{1}". E.g. if ref is "test/*/merged" the default mapping would be "test-@{1}".
String$class: 'GitBrowserSCMSourceTrait'browser
$class: 'AssemblaWeb'repoUrl
String$class: 'BacklogGitRepositoryBrowser'repoName
StringrepoUrl
String$class: 'BitbucketWeb'repoUrl
String$class: 'CGit'repoUrl
String$class: 'FisheyeGitRepositoryBrowser'repoUrl
String$class: 'GitBlitRepositoryBrowser'repoUrl
StringprojectName
String$class: 'GitBucketBrowser'url
String$class: 'GitLab'repoUrl
Stringversion (optional)
String$class: 'GitList'repoUrl
String$class: 'GitWeb'repoUrl
String$class: 'GiteaBrowser'repoUrl
https://gitea.example.com then the URL for bob's skunkworks project repository might be
https://gitea.example.com/bob/skunkworks
String$class: 'GithubWeb'repoUrl
String$class: 'Gitiles'repoUrl
String$class: 'GitoriousWeb'repoUrl
String$class: 'GogsGit'repoUrl
String$class: 'KilnGit'repoUrl
String$class: 'Phabricator'repoUrl
Stringrepo
String$class: 'RedmineWeb'repoUrl
String$class: 'RhodeCode'repoUrl
String$class: 'Stash'repoUrl
String$class: 'TFS2013GitRepositoryBrowser'repoUrl
If TFS is also used as the repository server, this can usually be left blank.
String$class: 'TracGitRepositoryBrowser'$class: 'ViewGitWeb'repoUrl
StringprojectName
String$class: 'GitHubAgedRefsTrait'retentionDays
StringgitHubBranchCommitSkipTraitgitHubCommitSkipTrait$class: 'GitHubJiraValidatorTrait'jiraServerIdx
int$class: 'GitLFSPullTrait'$class: 'GitToolSCMSourceTrait'gitTool
String$class: 'IgnoreOnPushNotificationTrait'$class: 'LocalBranchTrait'$class: 'MercurialBrowserSCMSourceTrait'browser
$class: 'BitBucket'url
String$class: 'FishEye'url
String$class: 'GoogleCode'url
String$class: 'HgWeb'url
String$class: 'Kallithea'url
String$class: 'KilnHG'url
String$class: 'RhodeCode'url
String$class: 'RhodeCodeLegacy'url
String$class: 'MercurialInstallationSCMSourceTrait'installation
String$class: 'NotificationContextTrait'contextLabel
StringtypeSuffix
Appends the relevant suffix to the context label based on the build type. '/pr-merge', '/pr-head' or '/branch'
boolean$class: 'PreBuildMergeTrait'extension
options
mergeTarget
StringfastForwardMode (optional)
FF, FF_ONLY, NO_FFmergeRemote (optional)
StringmergeStrategy (optional)
DEFAULT, RESOLVE, RECURSIVE, OCTOPUS, OURS, SUBTREE, RECURSIVE_THEIRS$class: 'PretestedIntegrationSCMTrait'extension
gitIntegrationStrategy
accumulatedshortCommitMessage (optional)
booleansquashintegrationBranch
The branch name must match your integration branch name. No trailing slash.
git checkout -B <Branch name> <Repository name>/<Branch name>
git merge --squash <Branch matched by git>
git commit -C <Branch matched by git>
git checkout -B <Branch name> <Repository name>/<Branch name>
git merge -m <commitMsg> <Branch matched by git> --no-ff
Changes are only ever pushed when the build results is SUCCESS
git push <Repository name> <Branch name>StringrepoName
The repository name. In git the repository is always the name of the remote. So if you have specified a repository name in your Git configuration. You need to specify the exact same name here, otherwise no integration will be performed. We do the merge based on this.
No trailing slash on repository name.
Remember to specify this when working with NAMED repositories in Git
String$class: 'PruneStaleBranchTrait'$class: 'PublicRepoPullRequestFilterTrait'$class: 'RefSpecsSCMSourceTrait'templates
value
@{remote} will be replaced by the remote name (which defaults to
origin) before use.
String$class: 'RemoteNameSCMSourceTrait'remoteName
StringskipNotifications$class: 'SubmoduleOptionTrait'extension
disableSubmodules
booleanrecursiveSubmodules
booleantrackingSubmodules
booleanreference
git init --bare git remote add SubProject1 https://gitrepo.com/subproject1 git remote add SubProject2 https://gitrepo.com/subproject2 git fetch --all
Stringtimeout
intparentCredentials
booleandepth (optional)
intshallow (optional)
booleanthreads (optional)
int$class: 'UserIdentityTrait'extension
name
If given, "git config user.name [this]" is called before builds. This overrides whatever is in the global settings.
Stringemail
If given, "git config user.email [this]" is called before builds. This overrides whatever is in the global settings.
String$class: 'WipeWorkspaceTrait'$class: 'com.cloudbees.jenkins.plugins.bitbucket.BranchDiscoveryTrait'strategyId
int$class: 'com.cloudbees.jenkins.plugins.bitbucket.ForkPullRequestDiscoveryTrait'strategyId
inttrust
One of the great powers of pull requests is that anyone with read access to a repository can fork it, commit some changes to their fork and then create a pull request against the original repository with their changes. There are some files stored in source control that are important. For example, a Jenkinsfile may contain configuration details to sandbox pull requests in order to mitigate against malicious pull requests. In order to protect against a malicious pull request itself modifying the Jenkinsfile to remove the protections, you can define the trust policy for pull requests from forks.
Other plugins can extend the available trust policies. The default policies are:
Jenkinsfile) the contents of that file will be retrieved from the target branch on the origin repository and not from the pull request branch on the fork repository.
jenkins.scm.api.SCMRevision>
$class: 'com.cloudbees.jenkins.plugins.bitbucket.OriginPullRequestDiscoveryTrait'strategyId
int$class: 'com.cloudbees.jenkins.plugins.bitbucket.SSHCheckoutTrait'https:// protocol for the Git / Mercurial repository.
This behaviour allows you to select the SSH private key to be used for checking out sources, which will consequently force the checkout to use the ssh:// protocol.
credentialsId
String$class: 'com.cloudbees.jenkins.plugins.bitbucket.TagDiscoveryTrait'$class: 'com.cloudbees.jenkins.plugins.bitbucket.WebhookRegistrationTrait'Overrides the defaults for webhook management.
Webhooks are used to inform Jenkins about changes to repositories. There are two ways webhooks can be configured:
The Manage Jenkins » Configure Jenkins › Bitbucket Endpoints allows defining the list of servers. Each server can be associated with credentials. If credentials are defined then the default behaviour is to use those credentials to automatically manage the webhooks of all repositories that Jenkins is interested in. If no credentials are defined then the default behaviour is to require the user to manually configure webhooks.
mode
String$class: 'jenkins.plugins.gerrit.ChangeDiscoveryTrait'strategyId
int$class: 'jenkins.plugins.gerrit.traits.ChangeDiscoveryTrait'gitBranchDiscoverygitTagDiscoveryheadRegexFilterregex
StringheadWildcardFilterincludes
* as a wildcard; for example:
master release*
Stringexcludes
release
StringheadRegexFilterWithPRregex
StringheadWildcardFilterWithPRincludes
* as a wildcard; for example:
master release*
Stringexcludes
release
String$class: 'org.jenkinsci.plugin.gitea.BranchDiscoveryTrait'strategyId
int$class: 'org.jenkinsci.plugin.gitea.ForkPullRequestDiscoveryTrait'strategyId
inttrust
One of the great powers of pull requests is that anyone with read access to a repository can fork it, commit some changes to their fork and then create a pull request against the original repository with their changes. There are some files stored in source control that are important. For example, a Jenkinsfile may contain configuration details to sandbox pull requests in order to mitigate against malicious pull requests. In order to protect against a malicious pull request itself modifying the Jenkinsfile to remove the protections, you can define the trust policy for pull requests from forks.
Other plugins can extend the available trust policies. The default policies are:
Jenkinsfile) the contents of that file will be retrieved from the target branch on the origin repository and not from the pull request branch on the fork repository.
Nobody.
jenkins.scm.api.SCMRevision>
$class: 'org.jenkinsci.plugin.gitea.OriginPullRequestDiscoveryTrait'strategyId
int$class: 'org.jenkinsci.plugin.gitea.SSHCheckoutTrait'https:// protocol for the Git repository.
This behaviour allows you to select the SSH private key to be used for checking out sources, which will consequently force the checkout to use the ssh:// protocol.
credentialsId
String$class: 'org.jenkinsci.plugin.gitea.WebhookRegistrationTrait'mode
StringgitHubBranchDiscoverystrategyId
intgitHubForkDiscoverystrategyId
inttrust
One of the great powers of pull requests is that anyone with read access to a repository can fork it, commit some changes to their fork and then create a pull request against the original repository with their changes. There are some files stored in source control that are important. For example, a Jenkinsfile may contain configuration details to sandbox pull requests in order to mitigate against malicious pull requests. In order to protect against a malicious pull request itself modifying the Jenkinsfile to remove the protections, you can define the trust policy for pull requests from forks.
Other plugins can extend the available trust policies. The default policies are:
Jenkinsfile) the contents of that file will be retrieved from the target branch on the origin repository and not from the pull request branch on the fork repository.
Nobody.
NOTE: all collaborators are trusted, even if they are only members of a team with read permission.
jenkins.scm.api.SCMRevision>
$class: 'org.jenkinsci.plugins.github_branch_source.OriginPullRequestDiscoveryTrait'strategyId
int$class: 'org.jenkinsci.plugins.github_branch_source.SSHCheckoutTrait'https:// protocol for the Git repository.
This behaviour allows you to select the SSH private key to be used for checking out sources, which will consequently force the checkout to use the ssh:// protocol.
credentialsId
StringgitHubTagDiscoverygitremote
Stringbrowser (optional)
$class: 'AssemblaWeb'repoUrl
String$class: 'BacklogGitRepositoryBrowser'repoName
StringrepoUrl
String$class: 'BitbucketWeb'repoUrl
String$class: 'CGit'repoUrl
String$class: 'FisheyeGitRepositoryBrowser'repoUrl
String$class: 'GitBlitRepositoryBrowser'repoUrl
StringprojectName
String$class: 'GitBucketBrowser'url
String$class: 'GitLab'repoUrl
Stringversion (optional)
String$class: 'GitList'repoUrl
String$class: 'GitWeb'repoUrl
String$class: 'GiteaBrowser'repoUrl
https://gitea.example.com then the URL for bob's skunkworks project repository might be
https://gitea.example.com/bob/skunkworks
String$class: 'GithubWeb'repoUrl
String$class: 'Gitiles'repoUrl
String$class: 'GitoriousWeb'repoUrl
String$class: 'GogsGit'repoUrl
String$class: 'KilnGit'repoUrl
String$class: 'Phabricator'repoUrl
Stringrepo
String$class: 'RedmineWeb'repoUrl
String$class: 'RhodeCode'repoUrl
String$class: 'Stash'repoUrl
String$class: 'TFS2013GitRepositoryBrowser'repoUrl
If TFS is also used as the repository server, this can usually be left blank.
String$class: 'TracGitRepositoryBrowser'$class: 'ViewGitWeb'repoUrl
StringprojectName
StringcredentialsId (optional)
Stringextensions (optional)
$class: 'AuthorInChangelog'$class: 'BuildChooserSetting'This extension point in Jenkins is used by many other plugins to control the job to build specific commits. When you activate those plugins, you may see them installing a custom strategy here.
buildChooser
$class: 'AlternativeBuildChooser'$class: 'AncestryBuildChooser'maximumAgeInDays
intancestorCommitSha1
String$class: 'DefaultBuildChooser'$class: 'DeflakeGitBuildChooser'$class: 'GerritTriggerBuildChooser'$class: 'InverseBuildChooser'$class: 'ChangelogToBranch'options
compareRemote
StringcompareTarget
String$class: 'CheckoutOption'timeout
int$class: 'CleanBeforeCheckout'$class: 'CleanCheckout'$class: 'CloneOption'shallow
booleannoTags
booleanreference
Stringtimeout
intdepth (optional)
inthonorRefspec (optional)
boolean$class: 'CodeCommitURLHelper'credentialId
OPTIONAL: Select the credentials to use.
If not specified, defaults to the DefaultAWSCredentialsProviderChain behaviour - *FROM THE JENKINS INSTANCE*
In the latter case, usage of IAM Role Profiles seems not to work, thus relying on environment variables / system properties or the ~/.aws/credentials file, thus not recommended.
StringrepositoryName
String$class: 'DisableRemotePoll'$class: 'GitLFSPull'$class: 'GitTagMessageExtension'useMostRecentTag (optional)
boolean$class: 'IgnoreNotifyCommit'$class: 'LocalBranch'If selected, and its 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/newfeature.
Please note that this has not been tested with submodules.
localBranch
String$class: 'MessageExclusion'excludedMessage
.*\[maven-release-plugin\].*The example above illustrates that if only revisions with "[maven-release-plugin]" message in first comment line have been committed to the SCM a build will not occur. You can create more complex patterns using embedded flag expressions.
(?s).*FOO.*This example will search FOO message in all comment lines.
String$class: 'PathRestriction'includedRegions
myapp/src/main/web/.*\.html
myapp/src/main/web/.*\.jpeg
myapp/src/main/web/.*\.gif
The example above illustrates that a build will only occur, if html/jpeg/gif files have been committed to the SCM. Exclusions take precedence over inclusions, if there is an overlap between included and excluded regions.
StringexcludedRegions
myapp/src/main/web/.*\.html
myapp/src/main/web/.*\.jpeg
myapp/src/main/web/.*\.gif
The example above illustrates that if only html/jpeg/gif files have been committed to the SCM a build will not occur.
String$class: 'PerBuildTag'$class: 'PreBuildMerge'options
mergeTarget
StringfastForwardMode (optional)
FF, FF_ONLY, NO_FFmergeRemote (optional)
StringmergeStrategy (optional)
DEFAULT, RESOLVE, RECURSIVE, OCTOPUS, OURS, SUBTREE, RECURSIVE_THEIRSpretestedIntegrationgitIntegrationStrategy
accumulatedshortCommitMessage (optional)
booleansquashintegrationBranch
The branch name must match your integration branch name. No trailing slash.
git checkout -B <Branch name> <Repository name>/<Branch name>
git merge --squash <Branch matched by git>
git commit -C <Branch matched by git>
git checkout -B <Branch name> <Repository name>/<Branch name>
git merge -m <commitMsg> <Branch matched by git> --no-ff
Changes are only ever pushed when the build results is SUCCESS
git push <Repository name> <Branch name>StringrepoName
The repository name. In git the repository is always the name of the remote. So if you have specified a repository name in your Git configuration. You need to specify the exact same name here, otherwise no integration will be performed. We do the merge based on this.
No trailing slash on repository name.
Remember to specify this when working with NAMED repositories in Git
String$class: 'PruneStaleBranch'$class: 'RelativeTargetDirectory'relativeTargetDir
String$class: 'ScmName'Unique name for this SCM. Needed when using Git within the Multi SCM plugin.
name
String$class: 'SparseCheckoutPaths'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
sparseCheckoutPaths
path
String$class: 'SubmoduleOption'disableSubmodules
booleanrecursiveSubmodules
booleantrackingSubmodules
booleanreference
git init --bare git remote add SubProject1 https://gitrepo.com/subproject1 git remote add SubProject2 https://gitrepo.com/subproject2 git fetch --all
Stringtimeout
intparentCredentials
booleandepth (optional)
intshallow (optional)
booleanthreads (optional)
int$class: 'UserExclusion'excludedUsers
auto_build_userThe example above illustrates that if only revisions by "auto_build_user" have been committed to the SCM a build will not occur.
String$class: 'UserIdentity'name
If given, "git config user.name [this]" is called before builds. This overrides whatever is in the global settings.
Stringemail
If given, "git config user.email [this]" is called before builds. This overrides whatever is in the global settings.
String$class: 'WipeWorkspace'gitTool (optional)
Stringtraits (optional)
$class: 'ApprovedPullRequestTrait'strategyId
int$class: 'AuthorInChangelogTrait'$class: 'BitbucketAgedRefsTrait'retentionDays
StringbitbucketBranchCommitSkipTraitbitbucketCommitSkipTrait$class: 'BitbucketJiraValidatorTrait'jiraServerIdx
int$class: 'CheckoutOptionTrait'extension
timeout
int$class: 'CleanAfterCheckoutTrait'$class: 'CleanBeforeCheckoutTrait'$class: 'CleanMercurialSCMSourceTrait'$class: 'CloneOptionTrait'extension
shallow
booleannoTags
booleanreference
Stringtimeout
intdepth (optional)
inthonorRefspec (optional)
boolean$class: 'DisableStatusUpdateTrait'$class: 'DiscoverOtherRefsTrait'ref
The pattern under /refs on the remote repository to discover, can contain a wildcard.
Example: test/*/merged
StringnameMapping (optional)
Mapping for how the ref can be named in for example the @Library.
Example: test-@{1}
Where @{1} replaces the first wildcard in the ref when discovered.
By default it will be "namespace_before_wildcard-@{1}". E.g. if ref is "test/*/merged" the default mapping would be "test-@{1}".
String$class: 'GitBrowserSCMSourceTrait'browser
$class: 'AssemblaWeb'repoUrl
String$class: 'BacklogGitRepositoryBrowser'repoName
StringrepoUrl
String$class: 'BitbucketWeb'repoUrl
String$class: 'CGit'repoUrl
String$class: 'FisheyeGitRepositoryBrowser'repoUrl
String$class: 'GitBlitRepositoryBrowser'repoUrl
StringprojectName
String$class: 'GitBucketBrowser'url
String$class: 'GitLab'repoUrl
Stringversion (optional)
String$class: 'GitList'repoUrl
String$class: 'GitWeb'repoUrl
String$class: 'GiteaBrowser'repoUrl
https://gitea.example.com then the URL for bob's skunkworks project repository might be
https://gitea.example.com/bob/skunkworks
String$class: 'GithubWeb'repoUrl
String$class: 'Gitiles'repoUrl
String$class: 'GitoriousWeb'repoUrl
String$class: 'GogsGit'repoUrl
String$class: 'KilnGit'repoUrl
String$class: 'Phabricator'repoUrl
Stringrepo
String$class: 'RedmineWeb'repoUrl
String$class: 'RhodeCode'repoUrl
String$class: 'Stash'repoUrl
String$class: 'TFS2013GitRepositoryBrowser'repoUrl
If TFS is also used as the repository server, this can usually be left blank.
String$class: 'TracGitRepositoryBrowser'$class: 'ViewGitWeb'repoUrl
StringprojectName
String$class: 'GitHubAgedRefsTrait'retentionDays
StringgitHubBranchCommitSkipTraitgitHubCommitSkipTrait$class: 'GitHubJiraValidatorTrait'jiraServerIdx
int$class: 'GitLFSPullTrait'$class: 'GitToolSCMSourceTrait'gitTool
String$class: 'IgnoreOnPushNotificationTrait'$class: 'LocalBranchTrait'$class: 'MercurialBrowserSCMSourceTrait'browser
$class: 'BitBucket'url
String$class: 'FishEye'url
String$class: 'GoogleCode'url
String$class: 'HgWeb'url
String$class: 'Kallithea'url
String$class: 'KilnHG'url
String$class: 'RhodeCode'url
String$class: 'RhodeCodeLegacy'url
String$class: 'MercurialInstallationSCMSourceTrait'installation
String$class: 'NotificationContextTrait'contextLabel
StringtypeSuffix
Appends the relevant suffix to the context label based on the build type. '/pr-merge', '/pr-head' or '/branch'
boolean$class: 'PreBuildMergeTrait'extension
options
mergeTarget
StringfastForwardMode (optional)
FF, FF_ONLY, NO_FFmergeRemote (optional)
StringmergeStrategy (optional)
DEFAULT, RESOLVE, RECURSIVE, OCTOPUS, OURS, SUBTREE, RECURSIVE_THEIRS$class: 'PretestedIntegrationSCMTrait'extension
gitIntegrationStrategy
accumulatedshortCommitMessage (optional)
booleansquashintegrationBranch
The branch name must match your integration branch name. No trailing slash.
git checkout -B <Branch name> <Repository name>/<Branch name>
git merge --squash <Branch matched by git>
git commit -C <Branch matched by git>
git checkout -B <Branch name> <Repository name>/<Branch name>
git merge -m <commitMsg> <Branch matched by git> --no-ff
Changes are only ever pushed when the build results is SUCCESS
git push <Repository name> <Branch name>StringrepoName
The repository name. In git the repository is always the name of the remote. So if you have specified a repository name in your Git configuration. You need to specify the exact same name here, otherwise no integration will be performed. We do the merge based on this.
No trailing slash on repository name.
Remember to specify this when working with NAMED repositories in Git
String$class: 'PruneStaleBranchTrait'$class: 'PublicRepoPullRequestFilterTrait'$class: 'RefSpecsSCMSourceTrait'templates
value
@{remote} will be replaced by the remote name (which defaults to
origin) before use.
String$class: 'RemoteNameSCMSourceTrait'remoteName
StringskipNotifications$class: 'SubmoduleOptionTrait'extension
disableSubmodules
booleanrecursiveSubmodules
booleantrackingSubmodules
booleanreference
git init --bare git remote add SubProject1 https://gitrepo.com/subproject1 git remote add SubProject2 https://gitrepo.com/subproject2 git fetch --all
Stringtimeout
intparentCredentials
booleandepth (optional)
intshallow (optional)
booleanthreads (optional)
int$class: 'UserIdentityTrait'extension
name
If given, "git config user.name [this]" is called before builds. This overrides whatever is in the global settings.
Stringemail
If given, "git config user.email [this]" is called before builds. This overrides whatever is in the global settings.
String$class: 'WipeWorkspaceTrait'$class: 'com.cloudbees.jenkins.plugins.bitbucket.BranchDiscoveryTrait'strategyId
int$class: 'com.cloudbees.jenkins.plugins.bitbucket.ForkPullRequestDiscoveryTrait'strategyId
inttrust
One of the great powers of pull requests is that anyone with read access to a repository can fork it, commit some changes to their fork and then create a pull request against the original repository with their changes. There are some files stored in source control that are important. For example, a Jenkinsfile may contain configuration details to sandbox pull requests in order to mitigate against malicious pull requests. In order to protect against a malicious pull request itself modifying the Jenkinsfile to remove the protections, you can define the trust policy for pull requests from forks.
Other plugins can extend the available trust policies. The default policies are:
Jenkinsfile) the contents of that file will be retrieved from the target branch on the origin repository and not from the pull request branch on the fork repository.
jenkins.scm.api.SCMRevision>
$class: 'com.cloudbees.jenkins.plugins.bitbucket.OriginPullRequestDiscoveryTrait'strategyId
int$class: 'com.cloudbees.jenkins.plugins.bitbucket.SSHCheckoutTrait'https:// protocol for the Git / Mercurial repository.
This behaviour allows you to select the SSH private key to be used for checking out sources, which will consequently force the checkout to use the ssh:// protocol.
credentialsId
String$class: 'com.cloudbees.jenkins.plugins.bitbucket.TagDiscoveryTrait'$class: 'com.cloudbees.jenkins.plugins.bitbucket.WebhookRegistrationTrait'Overrides the defaults for webhook management.
Webhooks are used to inform Jenkins about changes to repositories. There are two ways webhooks can be configured:
The Manage Jenkins » Configure Jenkins › Bitbucket Endpoints allows defining the list of servers. Each server can be associated with credentials. If credentials are defined then the default behaviour is to use those credentials to automatically manage the webhooks of all repositories that Jenkins is interested in. If no credentials are defined then the default behaviour is to require the user to manually configure webhooks.
mode
String$class: 'jenkins.plugins.gerrit.ChangeDiscoveryTrait'strategyId
int$class: 'jenkins.plugins.gerrit.traits.ChangeDiscoveryTrait'gitBranchDiscoverygitTagDiscoveryheadRegexFilterregex
StringheadWildcardFilterincludes
* as a wildcard; for example:
master release*
Stringexcludes
release
StringheadRegexFilterWithPRregex
StringheadWildcardFilterWithPRincludes
* as a wildcard; for example:
master release*
Stringexcludes
release
String$class: 'org.jenkinsci.plugin.gitea.BranchDiscoveryTrait'strategyId
int$class: 'org.jenkinsci.plugin.gitea.ForkPullRequestDiscoveryTrait'strategyId
inttrust
One of the great powers of pull requests is that anyone with read access to a repository can fork it, commit some changes to their fork and then create a pull request against the original repository with their changes. There are some files stored in source control that are important. For example, a Jenkinsfile may contain configuration details to sandbox pull requests in order to mitigate against malicious pull requests. In order to protect against a malicious pull request itself modifying the Jenkinsfile to remove the protections, you can define the trust policy for pull requests from forks.
Other plugins can extend the available trust policies. The default policies are:
Jenkinsfile) the contents of that file will be retrieved from the target branch on the origin repository and not from the pull request branch on the fork repository.
Nobody.
jenkins.scm.api.SCMRevision>
$class: 'org.jenkinsci.plugin.gitea.OriginPullRequestDiscoveryTrait'strategyId
int$class: 'org.jenkinsci.plugin.gitea.SSHCheckoutTrait'https:// protocol for the Git repository.
This behaviour allows you to select the SSH private key to be used for checking out sources, which will consequently force the checkout to use the ssh:// protocol.
credentialsId
String$class: 'org.jenkinsci.plugin.gitea.WebhookRegistrationTrait'mode
StringgitHubBranchDiscoverystrategyId
intgitHubForkDiscoverystrategyId
inttrust
One of the great powers of pull requests is that anyone with read access to a repository can fork it, commit some changes to their fork and then create a pull request against the original repository with their changes. There are some files stored in source control that are important. For example, a Jenkinsfile may contain configuration details to sandbox pull requests in order to mitigate against malicious pull requests. In order to protect against a malicious pull request itself modifying the Jenkinsfile to remove the protections, you can define the trust policy for pull requests from forks.
Other plugins can extend the available trust policies. The default policies are:
Jenkinsfile) the contents of that file will be retrieved from the target branch on the origin repository and not from the pull request branch on the fork repository.
Nobody.
NOTE: all collaborators are trusted, even if they are only members of a team with read permission.
jenkins.scm.api.SCMRevision>
$class: 'org.jenkinsci.plugins.github_branch_source.OriginPullRequestDiscoveryTrait'strategyId
int$class: 'org.jenkinsci.plugins.github_branch_source.SSHCheckoutTrait'https:// protocol for the Git repository.
This behaviour allows you to select the SSH private key to be used for checking out sources, which will consequently force the checkout to use the ssh:// protocol.
credentialsId
StringgitHubTagDiscovery$class: 'GiteaSCMSource'serverUrl
StringrepoOwner
Stringrepository
StringcredentialsId (optional)
Stringtraits (optional)
$class: 'ApprovedPullRequestTrait'strategyId
int$class: 'AuthorInChangelogTrait'$class: 'BitbucketAgedRefsTrait'retentionDays
StringbitbucketBranchCommitSkipTraitbitbucketCommitSkipTrait$class: 'BitbucketJiraValidatorTrait'jiraServerIdx
int$class: 'CheckoutOptionTrait'extension
timeout
int$class: 'CleanAfterCheckoutTrait'$class: 'CleanBeforeCheckoutTrait'$class: 'CleanMercurialSCMSourceTrait'$class: 'CloneOptionTrait'extension
shallow
booleannoTags
booleanreference
Stringtimeout
intdepth (optional)
inthonorRefspec (optional)
boolean$class: 'DisableStatusUpdateTrait'$class: 'DiscoverOtherRefsTrait'ref
The pattern under /refs on the remote repository to discover, can contain a wildcard.
Example: test/*/merged
StringnameMapping (optional)
Mapping for how the ref can be named in for example the @Library.
Example: test-@{1}
Where @{1} replaces the first wildcard in the ref when discovered.
By default it will be "namespace_before_wildcard-@{1}". E.g. if ref is "test/*/merged" the default mapping would be "test-@{1}".
String$class: 'GitBrowserSCMSourceTrait'browser
$class: 'AssemblaWeb'repoUrl
String$class: 'BacklogGitRepositoryBrowser'repoName
StringrepoUrl
String$class: 'BitbucketWeb'repoUrl
String$class: 'CGit'repoUrl
String$class: 'FisheyeGitRepositoryBrowser'repoUrl
String$class: 'GitBlitRepositoryBrowser'repoUrl
StringprojectName
String$class: 'GitBucketBrowser'url
String$class: 'GitLab'repoUrl
Stringversion (optional)
String$class: 'GitList'repoUrl
String$class: 'GitWeb'repoUrl
String$class: 'GiteaBrowser'repoUrl
https://gitea.example.com then the URL for bob's skunkworks project repository might be
https://gitea.example.com/bob/skunkworks
String$class: 'GithubWeb'repoUrl
String$class: 'Gitiles'repoUrl
String$class: 'GitoriousWeb'repoUrl
String$class: 'GogsGit'repoUrl
String$class: 'KilnGit'repoUrl
String$class: 'Phabricator'repoUrl
Stringrepo
String$class: 'RedmineWeb'repoUrl
String$class: 'RhodeCode'repoUrl
String$class: 'Stash'repoUrl
String$class: 'TFS2013GitRepositoryBrowser'repoUrl
If TFS is also used as the repository server, this can usually be left blank.
String$class: 'TracGitRepositoryBrowser'$class: 'ViewGitWeb'repoUrl
StringprojectName
String$class: 'GitHubAgedRefsTrait'retentionDays
StringgitHubBranchCommitSkipTraitgitHubCommitSkipTrait$class: 'GitHubJiraValidatorTrait'jiraServerIdx
int$class: 'GitLFSPullTrait'$class: 'GitToolSCMSourceTrait'gitTool
String$class: 'IgnoreOnPushNotificationTrait'$class: 'LocalBranchTrait'$class: 'MercurialBrowserSCMSourceTrait'browser
$class: 'BitBucket'url
String$class: 'FishEye'url
String$class: 'GoogleCode'url
String$class: 'HgWeb'url
String$class: 'Kallithea'url
String$class: 'KilnHG'url
String$class: 'RhodeCode'url
String$class: 'RhodeCodeLegacy'url
String$class: 'MercurialInstallationSCMSourceTrait'installation
String$class: 'NotificationContextTrait'contextLabel
StringtypeSuffix
Appends the relevant suffix to the context label based on the build type. '/pr-merge', '/pr-head' or '/branch'
boolean$class: 'PreBuildMergeTrait'extension
options
mergeTarget
StringfastForwardMode (optional)
FF, FF_ONLY, NO_FFmergeRemote (optional)
StringmergeStrategy (optional)
DEFAULT, RESOLVE, RECURSIVE, OCTOPUS, OURS, SUBTREE, RECURSIVE_THEIRS$class: 'PretestedIntegrationSCMTrait'extension
gitIntegrationStrategy
accumulatedshortCommitMessage (optional)
booleansquashintegrationBranch
The branch name must match your integration branch name. No trailing slash.
git checkout -B <Branch name> <Repository name>/<Branch name>
git merge --squash <Branch matched by git>
git commit -C <Branch matched by git>
git checkout -B <Branch name> <Repository name>/<Branch name>
git merge -m <commitMsg> <Branch matched by git> --no-ff
Changes are only ever pushed when the build results is SUCCESS
git push <Repository name> <Branch name>StringrepoName
The repository name. In git the repository is always the name of the remote. So if you have specified a repository name in your Git configuration. You need to specify the exact same name here, otherwise no integration will be performed. We do the merge based on this.
No trailing slash on repository name.
Remember to specify this when working with NAMED repositories in Git
String$class: 'PruneStaleBranchTrait'$class: 'PublicRepoPullRequestFilterTrait'$class: 'RefSpecsSCMSourceTrait'templates
value
@{remote} will be replaced by the remote name (which defaults to
origin) before use.
String$class: 'RemoteNameSCMSourceTrait'remoteName
StringskipNotifications$class: 'SubmoduleOptionTrait'extension
disableSubmodules
booleanrecursiveSubmodules
booleantrackingSubmodules
booleanreference
git init --bare git remote add SubProject1 https://gitrepo.com/subproject1 git remote add SubProject2 https://gitrepo.com/subproject2 git fetch --all
Stringtimeout
intparentCredentials
booleandepth (optional)
intshallow (optional)
booleanthreads (optional)
int$class: 'UserIdentityTrait'extension
name
If given, "git config user.name [this]" is called before builds. This overrides whatever is in the global settings.
Stringemail
If given, "git config user.email [this]" is called before builds. This overrides whatever is in the global settings.
String$class: 'WipeWorkspaceTrait'$class: 'com.cloudbees.jenkins.plugins.bitbucket.BranchDiscoveryTrait'strategyId
int$class: 'com.cloudbees.jenkins.plugins.bitbucket.ForkPullRequestDiscoveryTrait'strategyId
inttrust
One of the great powers of pull requests is that anyone with read access to a repository can fork it, commit some changes to their fork and then create a pull request against the original repository with their changes. There are some files stored in source control that are important. For example, a Jenkinsfile may contain configuration details to sandbox pull requests in order to mitigate against malicious pull requests. In order to protect against a malicious pull request itself modifying the Jenkinsfile to remove the protections, you can define the trust policy for pull requests from forks.
Other plugins can extend the available trust policies. The default policies are:
Jenkinsfile) the contents of that file will be retrieved from the target branch on the origin repository and not from the pull request branch on the fork repository.
jenkins.scm.api.SCMRevision>
$class: 'com.cloudbees.jenkins.plugins.bitbucket.OriginPullRequestDiscoveryTrait'strategyId
int$class: 'com.cloudbees.jenkins.plugins.bitbucket.SSHCheckoutTrait'https:// protocol for the Git / Mercurial repository.
This behaviour allows you to select the SSH private key to be used for checking out sources, which will consequently force the checkout to use the ssh:// protocol.
credentialsId
String$class: 'com.cloudbees.jenkins.plugins.bitbucket.TagDiscoveryTrait'$class: 'com.cloudbees.jenkins.plugins.bitbucket.WebhookRegistrationTrait'Overrides the defaults for webhook management.
Webhooks are used to inform Jenkins about changes to repositories. There are two ways webhooks can be configured:
The Manage Jenkins » Configure Jenkins › Bitbucket Endpoints allows defining the list of servers. Each server can be associated with credentials. If credentials are defined then the default behaviour is to use those credentials to automatically manage the webhooks of all repositories that Jenkins is interested in. If no credentials are defined then the default behaviour is to require the user to manually configure webhooks.
mode
String$class: 'jenkins.plugins.gerrit.ChangeDiscoveryTrait'strategyId
int$class: 'jenkins.plugins.gerrit.traits.ChangeDiscoveryTrait'gitBranchDiscoverygitTagDiscoveryheadRegexFilterregex
StringheadWildcardFilterincludes
* as a wildcard; for example:
master release*
Stringexcludes
release
StringheadRegexFilterWithPRregex
StringheadWildcardFilterWithPRincludes
* as a wildcard; for example:
master release*
Stringexcludes
release
String$class: 'org.jenkinsci.plugin.gitea.BranchDiscoveryTrait'strategyId
int$class: 'org.jenkinsci.plugin.gitea.ForkPullRequestDiscoveryTrait'strategyId
inttrust
One of the great powers of pull requests is that anyone with read access to a repository can fork it, commit some changes to their fork and then create a pull request against the original repository with their changes. There are some files stored in source control that are important. For example, a Jenkinsfile may contain configuration details to sandbox pull requests in order to mitigate against malicious pull requests. In order to protect against a malicious pull request itself modifying the Jenkinsfile to remove the protections, you can define the trust policy for pull requests from forks.
Other plugins can extend the available trust policies. The default policies are:
Jenkinsfile) the contents of that file will be retrieved from the target branch on the origin repository and not from the pull request branch on the fork repository.
Nobody.
jenkins.scm.api.SCMRevision>
$class: 'org.jenkinsci.plugin.gitea.OriginPullRequestDiscoveryTrait'strategyId
int$class: 'org.jenkinsci.plugin.gitea.SSHCheckoutTrait'https:// protocol for the Git repository.
This behaviour allows you to select the SSH private key to be used for checking out sources, which will consequently force the checkout to use the ssh:// protocol.
credentialsId
String$class: 'org.jenkinsci.plugin.gitea.WebhookRegistrationTrait'mode
StringgitHubBranchDiscoverystrategyId
intgitHubForkDiscoverystrategyId
inttrust
One of the great powers of pull requests is that anyone with read access to a repository can fork it, commit some changes to their fork and then create a pull request against the original repository with their changes. There are some files stored in source control that are important. For example, a Jenkinsfile may contain configuration details to sandbox pull requests in order to mitigate against malicious pull requests. In order to protect against a malicious pull request itself modifying the Jenkinsfile to remove the protections, you can define the trust policy for pull requests from forks.
Other plugins can extend the available trust policies. The default policies are:
Jenkinsfile) the contents of that file will be retrieved from the target branch on the origin repository and not from the pull request branch on the fork repository.
Nobody.
NOTE: all collaborators are trusted, even if they are only members of a team with read permission.
jenkins.scm.api.SCMRevision>
$class: 'org.jenkinsci.plugins.github_branch_source.OriginPullRequestDiscoveryTrait'strategyId
int$class: 'org.jenkinsci.plugins.github_branch_source.SSHCheckoutTrait'https:// protocol for the Git repository.
This behaviour allows you to select the SSH private key to be used for checking out sources, which will consequently force the checkout to use the ssh:// protocol.
credentialsId
StringgitHubTagDiscoveryglobalLibcredential
Stringpath
A Perforce Depot path to the library.
For example: //depot/myLibrary/...
Stringcharset (optional)
Stringfilter (optional)
pathFilterpath
Changes can be filtered to not trigger a build; if all the files within a change match the specified path, the build is filtered.
For example, with a Filter of " //depot/main/tests ":
Case A (change will be filtered):
Files:
//depot/main/tests/index.xml //depot/main/tests/001/test.xml //depot/main/tests/002/test.xml Case B (change will not be filtered, as build.xml is outside of the filter):
Files:
//depot/main/src/build.xml //depot/main/tests/004/test.xml //depot/main/tests/005/test.xml This is not Perforce syntax. Use of ... and * patterns are not supported. Only paths to directories are supported.
StringviewPatternpatternText
Changes can be filtered to not trigger a build; if none of the files within a change match a Java pattern (regular expression) listed, the build is filtered.
For example, with the following regular expressions:
//depot/main/tests.*
//depot/main/src/.*\.cpp
//depot/main/build/.*(?:\.rb|\.py|\.bat|Jenkinsfile)
//depot/main/lib/(?!Lib1|Lib2).*
Case A (change will not be filtered, as these files match our first pattern on "tests"):
Files:
//depot/main/tests/CONTRIUBTING.md //depot/main/tests/001/index.xml Case B (Be careful with incomplete file paths! Change will NOT be filtered,
as this file matches a pattern which was likely intended as describing a "tests/" directory.)
Files:
//depot/main/tests.doc Case C (change will NOT be filtered, as all files match our fourth pattern looking for script files in 'build/'):
Files:
//depot/main/build/rbs/deploy_server.rb //depot/main/build/deploy/deploy.bat //depot/main/build/Jenkinsfile Case D (change will be filtered, as no file matches our second pattern for ".cpp" files under "main/src"):
Files:
//depot/main/src/howto.doc //depot/main/src/oldmain.c //depot/main/src/art/splash.bmp //depot/main/src/bt/funnelcake.php Case E (change will be filtered. Lib1 is included in a negative lookahead, and thus is excluded.)
Files:
//depot/main/lib/Lib1/build.xml StringcaseSensitive
booleanincrementalperChange
booleanuserFilteruser
Changes can be filtered to not trigger a build; if the owner of a change matches the specified name, the build is filtered.
StringviewFilterviewMask
Changes can be filtered to not trigger a build; if none of the files within a change are contained in the view mask, the build is filtered.
For example, with a View Mask Filter of:
//depot/main/tests
-//depot/main/tests/001
Case A (change will not be filtered, as index.xml is in the view mask):
Files:
//depot/main/tests/index.xml //depot/main/tests/001/test.xml Case B (change will not be filtered, as index.xml is in the view mask):
Files:
//depot/main/test/index.xml //depot/main/src/build.xml Case C (change will be filtered, as no file is in the view mask):
Files:
//depot/main/src/build.xml Case D (change will be filtered, as no file is in the view mask):
Files:
//depot/main/src/build.xml //depot/main/tests/001/test.xml Stringformat (optional)
Stringincludes (optional)
Stringpopulate (optional)
autoCleanreplace
Perforce will check out and overwrite any depot files which are either missing from workspace, or have been modified locally.
booleandelete
Perforce will delete any local files that are not in the depot.
booleantidy
booleanmodtime
booleanquiet
Enables the -q flag for all applicable Perforce operations. Summary details will still be displayed.
booleanpin
When a build is triggered by Polling, Build Now or an external Action, the workspace will sync only to the specified label. Any other specified change or label will be ignored.
Supports variable expansion e.g. ${VAR}. If 'now' is used, or a variable that expands to 'now', then the latest change is used (within the scope of the workspace view).
Stringparallel
enable
booleanpath
Stringthreads
Stringminfiles
Stringminbytes
StringpreviewOnlyquiet
Enables the -q flag for all applicable Perforce operations. Summary details will still be displayed.
booleanpin
StringflushOnlyquiet
booleanpin
When a build is triggered by Polling, Build Now or an external Action, the workspace will flush only to the specified label or changelist number. Any other specified change or label will be ignored.
Supports variable expansion e.g. ${VAR}. If 'now' is used, or a variable that expands to 'now', then the latest change is used (within the scope of the workspace view).
StringforceCleanhave
booleanquiet
Enables the -q flag for all applicable Perforce operations. Summary details will still be displayed.
booleanpin
When a build is triggered by Polling, Build Now or an external Action, the workspace will sync only to the specified label. Any other specified change or label will be ignored.
Supports variable expansion e.g. ${VAR}. If 'now' is used, or a variable that expands to 'now', then the latest change is used (within the scope of the workspace view).
Stringparallel
enable
booleanpath
Stringthreads
Stringminfiles
Stringminbytes
StringgraphCleanquiet
Enables the -q flag for all applicable Perforce operations. Summary details will still be displayed.
booleanpin
When a build is triggered by Polling, Build Now or an external Action, the workspace will sync only to the specified label. Any other specified change or label will be ignored.
Supports variable expansion e.g. ${VAR}. If 'now' is used, or a variable that expands to 'now', then the latest change is used (within the scope of the workspace view).
Stringparallel
enable
booleanpath
Stringthreads
Stringminfiles
Stringminbytes
StringsyncOnlyrevert
booleanhave
booleanforce
booleanmodtime
booleanquiet
Enables the -q flag for all applicable Perforce operations. Summary details will still be displayed.
booleanpin
When a build is triggered by Polling, Build Now or an external Action, the workspace will sync only to the specified label. Any other specified change or label will be ignored.
Supports variable expansion e.g. ${VAR}. If 'now' is used, or a variable that expands to 'now', then the latest change is used (within the scope of the workspace view).
Stringparallel
enable
booleanpath
Stringthreads
Stringminfiles
Stringminbytes
Stringtraits (optional)
$class: 'ApprovedPullRequestTrait'strategyId
int$class: 'AuthorInChangelogTrait'$class: 'BitbucketAgedRefsTrait'retentionDays
StringbitbucketBranchCommitSkipTraitbitbucketCommitSkipTrait$class: 'BitbucketJiraValidatorTrait'jiraServerIdx
int$class: 'CheckoutOptionTrait'extension
timeout
int$class: 'CleanAfterCheckoutTrait'$class: 'CleanBeforeCheckoutTrait'$class: 'CleanMercurialSCMSourceTrait'$class: 'CloneOptionTrait'extension
shallow
booleannoTags
booleanreference
Stringtimeout
intdepth (optional)
inthonorRefspec (optional)
boolean$class: 'DisableStatusUpdateTrait'$class: 'DiscoverOtherRefsTrait'ref
The pattern under /refs on the remote repository to discover, can contain a wildcard.
Example: test/*/merged
StringnameMapping (optional)
Mapping for how the ref can be named in for example the @Library.
Example: test-@{1}
Where @{1} replaces the first wildcard in the ref when discovered.
By default it will be "namespace_before_wildcard-@{1}". E.g. if ref is "test/*/merged" the default mapping would be "test-@{1}".
String$class: 'GitBrowserSCMSourceTrait'browser
$class: 'AssemblaWeb'repoUrl
String$class: 'BacklogGitRepositoryBrowser'repoName
StringrepoUrl
String$class: 'BitbucketWeb'repoUrl
String$class: 'CGit'repoUrl
String$class: 'FisheyeGitRepositoryBrowser'repoUrl
String$class: 'GitBlitRepositoryBrowser'repoUrl
StringprojectName
String$class: 'GitBucketBrowser'url
String$class: 'GitLab'repoUrl
Stringversion (optional)
String$class: 'GitList'repoUrl
String$class: 'GitWeb'repoUrl
String$class: 'GiteaBrowser'repoUrl
https://gitea.example.com then the URL for bob's skunkworks project repository might be
https://gitea.example.com/bob/skunkworks
String$class: 'GithubWeb'repoUrl
String$class: 'Gitiles'repoUrl
String$class: 'GitoriousWeb'repoUrl
String$class: 'GogsGit'repoUrl
String$class: 'KilnGit'repoUrl
String$class: 'Phabricator'repoUrl
Stringrepo
String$class: 'RedmineWeb'repoUrl
String$class: 'RhodeCode'repoUrl
String$class: 'Stash'repoUrl
String$class: 'TFS2013GitRepositoryBrowser'repoUrl
If TFS is also used as the repository server, this can usually be left blank.
String$class: 'TracGitRepositoryBrowser'$class: 'ViewGitWeb'repoUrl
StringprojectName
String$class: 'GitHubAgedRefsTrait'retentionDays
StringgitHubBranchCommitSkipTraitgitHubCommitSkipTrait$class: 'GitHubJiraValidatorTrait'jiraServerIdx
int$class: 'GitLFSPullTrait'$class: 'GitToolSCMSourceTrait'gitTool
String$class: 'IgnoreOnPushNotificationTrait'$class: 'LocalBranchTrait'$class: 'MercurialBrowserSCMSourceTrait'browser
$class: 'BitBucket'url
String$class: 'FishEye'url
String$class: 'GoogleCode'url
String$class: 'HgWeb'url
String$class: 'Kallithea'url
String$class: 'KilnHG'url
String$class: 'RhodeCode'url
String$class: 'RhodeCodeLegacy'url
String$class: 'MercurialInstallationSCMSourceTrait'installation
String$class: 'NotificationContextTrait'contextLabel
StringtypeSuffix
Appends the relevant suffix to the context label based on the build type. '/pr-merge', '/pr-head' or '/branch'
boolean$class: 'PreBuildMergeTrait'extension
options
mergeTarget
StringfastForwardMode (optional)
FF, FF_ONLY, NO_FFmergeRemote (optional)
StringmergeStrategy (optional)
DEFAULT, RESOLVE, RECURSIVE, OCTOPUS, OURS, SUBTREE, RECURSIVE_THEIRS$class: 'PretestedIntegrationSCMTrait'extension
gitIntegrationStrategy
accumulatedshortCommitMessage (optional)
booleansquashintegrationBranch
The branch name must match your integration branch name. No trailing slash.
git checkout -B <Branch name> <Repository name>/<Branch name>
git merge --squash <Branch matched by git>
git commit -C <Branch matched by git>
git checkout -B <Branch name> <Repository name>/<Branch name>
git merge -m <commitMsg> <Branch matched by git> --no-ff
Changes are only ever pushed when the build results is SUCCESS
git push <Repository name> <Branch name>StringrepoName
The repository name. In git the repository is always the name of the remote. So if you have specified a repository name in your Git configuration. You need to specify the exact same name here, otherwise no integration will be performed. We do the merge based on this.
No trailing slash on repository name.
Remember to specify this when working with NAMED repositories in Git
String$class: 'PruneStaleBranchTrait'$class: 'PublicRepoPullRequestFilterTrait'$class: 'RefSpecsSCMSourceTrait'templates
value
@{remote} will be replaced by the remote name (which defaults to
origin) before use.
String$class: 'RemoteNameSCMSourceTrait'remoteName
StringskipNotifications$class: 'SubmoduleOptionTrait'extension
disableSubmodules
booleanrecursiveSubmodules
booleantrackingSubmodules
booleanreference
git init --bare git remote add SubProject1 https://gitrepo.com/subproject1 git remote add SubProject2 https://gitrepo.com/subproject2 git fetch --all
Stringtimeout
intparentCredentials
booleandepth (optional)
intshallow (optional)
booleanthreads (optional)
int$class: 'UserIdentityTrait'extension
name
If given, "git config user.name [this]" is called before builds. This overrides whatever is in the global settings.
Stringemail
If given, "git config user.email [this]" is called before builds. This overrides whatever is in the global settings.
String$class: 'WipeWorkspaceTrait'$class: 'com.cloudbees.jenkins.plugins.bitbucket.BranchDiscoveryTrait'strategyId
int$class: 'com.cloudbees.jenkins.plugins.bitbucket.ForkPullRequestDiscoveryTrait'strategyId
inttrust
One of the great powers of pull requests is that anyone with read access to a repository can fork it, commit some changes to their fork and then create a pull request against the original repository with their changes. There are some files stored in source control that are important. For example, a Jenkinsfile may contain configuration details to sandbox pull requests in order to mitigate against malicious pull requests. In order to protect against a malicious pull request itself modifying the Jenkinsfile to remove the protections, you can define the trust policy for pull requests from forks.
Other plugins can extend the available trust policies. The default policies are:
Jenkinsfile) the contents of that file will be retrieved from the target branch on the origin repository and not from the pull request branch on the fork repository.
jenkins.scm.api.SCMRevision>
$class: 'com.cloudbees.jenkins.plugins.bitbucket.OriginPullRequestDiscoveryTrait'strategyId
int$class: 'com.cloudbees.jenkins.plugins.bitbucket.SSHCheckoutTrait'https:// protocol for the Git / Mercurial repository.
This behaviour allows you to select the SSH private key to be used for checking out sources, which will consequently force the checkout to use the ssh:// protocol.
credentialsId
String$class: 'com.cloudbees.jenkins.plugins.bitbucket.TagDiscoveryTrait'$class: 'com.cloudbees.jenkins.plugins.bitbucket.WebhookRegistrationTrait'Overrides the defaults for webhook management.
Webhooks are used to inform Jenkins about changes to repositories. There are two ways webhooks can be configured:
The Manage Jenkins » Configure Jenkins › Bitbucket Endpoints allows defining the list of servers. Each server can be associated with credentials. If credentials are defined then the default behaviour is to use those credentials to automatically manage the webhooks of all repositories that Jenkins is interested in. If no credentials are defined then the default behaviour is to require the user to manually configure webhooks.
mode
String$class: 'jenkins.plugins.gerrit.ChangeDiscoveryTrait'strategyId
int$class: 'jenkins.plugins.gerrit.traits.ChangeDiscoveryTrait'gitBranchDiscoverygitTagDiscoveryheadRegexFilterregex
StringheadWildcardFilterincludes
* as a wildcard; for example:
master release*
Stringexcludes
release
StringheadRegexFilterWithPRregex
StringheadWildcardFilterWithPRincludes
* as a wildcard; for example:
master release*
Stringexcludes
release
String$class: 'org.jenkinsci.plugin.gitea.BranchDiscoveryTrait'strategyId
int$class: 'org.jenkinsci.plugin.gitea.ForkPullRequestDiscoveryTrait'strategyId
inttrust
One of the great powers of pull requests is that anyone with read access to a repository can fork it, commit some changes to their fork and then create a pull request against the original repository with their changes. There are some files stored in source control that are important. For example, a Jenkinsfile may contain configuration details to sandbox pull requests in order to mitigate against malicious pull requests. In order to protect against a malicious pull request itself modifying the Jenkinsfile to remove the protections, you can define the trust policy for pull requests from forks.
Other plugins can extend the available trust policies. The default policies are:
Jenkinsfile) the contents of that file will be retrieved from the target branch on the origin repository and not from the pull request branch on the fork repository.
Nobody.
jenkins.scm.api.SCMRevision>
$class: 'org.jenkinsci.plugin.gitea.OriginPullRequestDiscoveryTrait'strategyId
int$class: 'org.jenkinsci.plugin.gitea.SSHCheckoutTrait'https:// protocol for the Git repository.
This behaviour allows you to select the SSH private key to be used for checking out sources, which will consequently force the checkout to use the ssh:// protocol.
credentialsId
String$class: 'org.jenkinsci.plugin.gitea.WebhookRegistrationTrait'mode
StringgitHubBranchDiscoverystrategyId
intgitHubForkDiscoverystrategyId
inttrust
One of the great powers of pull requests is that anyone with read access to a repository can fork it, commit some changes to their fork and then create a pull request against the original repository with their changes. There are some files stored in source control that are important. For example, a Jenkinsfile may contain configuration details to sandbox pull requests in order to mitigate against malicious pull requests. In order to protect against a malicious pull request itself modifying the Jenkinsfile to remove the protections, you can define the trust policy for pull requests from forks.
Other plugins can extend the available trust policies. The default policies are:
Jenkinsfile) the contents of that file will be retrieved from the target branch on the origin repository and not from the pull request branch on the fork repository.
Nobody.
NOTE: all collaborators are trusted, even if they are only members of a team with read permission.
jenkins.scm.api.SCMRevision>
$class: 'org.jenkinsci.plugins.github_branch_source.OriginPullRequestDiscoveryTrait'strategyId
int$class: 'org.jenkinsci.plugins.github_branch_source.SSHCheckoutTrait'https:// protocol for the Git repository.
This behaviour allows you to select the SSH private key to be used for checking out sources, which will consequently force the checkout to use the ssh:// protocol.
credentialsId
StringgitHubTagDiscoverymultiGraphcredential
Stringincludes (optional)
A List of Perforce Graph repos (separated by new lines). The plugin will recursively search for a Jenkinsfile (or defined item) using the last directory name for the multi-branch name.
For example: //graph/...
Stringcharset (optional)
Stringformat (optional)
Stringbrowser (optional)
fishEyeurl
StringrootModule
StringopenGrokurl
StringdepotPath
StringprojectName
Stringp4Weburl
Stringswarmurl
Stringfilter (optional)
pathFilterpath
Changes can be filtered to not trigger a build; if all the files within a change match the specified path, the build is filtered.
For example, with a Filter of " //depot/main/tests ":
Case A (change will be filtered):
Files:
//depot/main/tests/index.xml //depot/main/tests/001/test.xml //depot/main/tests/002/test.xml Case B (change will not be filtered, as build.xml is outside of the filter):
Files:
//depot/main/src/build.xml //depot/main/tests/004/test.xml //depot/main/tests/005/test.xml This is not Perforce syntax. Use of ... and * patterns are not supported. Only paths to directories are supported.
StringviewPatternpatternText
Changes can be filtered to not trigger a build; if none of the files within a change match a Java pattern (regular expression) listed, the build is filtered.
For example, with the following regular expressions:
//depot/main/tests.*
//depot/main/src/.*\.cpp
//depot/main/build/.*(?:\.rb|\.py|\.bat|Jenkinsfile)
//depot/main/lib/(?!Lib1|Lib2).*
Case A (change will not be filtered, as these files match our first pattern on "tests"):
Files:
//depot/main/tests/CONTRIUBTING.md //depot/main/tests/001/index.xml Case B (Be careful with incomplete file paths! Change will NOT be filtered,
as this file matches a pattern which was likely intended as describing a "tests/" directory.)
Files:
//depot/main/tests.doc Case C (change will NOT be filtered, as all files match our fourth pattern looking for script files in 'build/'):
Files:
//depot/main/build/rbs/deploy_server.rb //depot/main/build/deploy/deploy.bat //depot/main/build/Jenkinsfile Case D (change will be filtered, as no file matches our second pattern for ".cpp" files under "main/src"):
Files:
//depot/main/src/howto.doc //depot/main/src/oldmain.c //depot/main/src/art/splash.bmp //depot/main/src/bt/funnelcake.php Case E (change will be filtered. Lib1 is included in a negative lookahead, and thus is excluded.)
Files:
//depot/main/lib/Lib1/build.xml StringcaseSensitive
booleanincrementalperChange
booleanuserFilteruser
Changes can be filtered to not trigger a build; if the owner of a change matches the specified name, the build is filtered.
StringviewFilterviewMask
Changes can be filtered to not trigger a build; if none of the files within a change are contained in the view mask, the build is filtered.
For example, with a View Mask Filter of:
//depot/main/tests
-//depot/main/tests/001
Case A (change will not be filtered, as index.xml is in the view mask):
Files:
//depot/main/tests/index.xml //depot/main/tests/001/test.xml Case B (change will not be filtered, as index.xml is in the view mask):
Files:
//depot/main/test/index.xml //depot/main/src/build.xml Case C (change will be filtered, as no file is in the view mask):
Files:
//depot/main/src/build.xml Case D (change will be filtered, as no file is in the view mask):
Files:
//depot/main/src/build.xml //depot/main/tests/001/test.xml Stringpopulate (optional)
autoCleanreplace
Perforce will check out and overwrite any depot files which are either missing from workspace, or have been modified locally.
booleandelete
Perforce will delete any local files that are not in the depot.
booleantidy
booleanmodtime
booleanquiet
Enables the -q flag for all applicable Perforce operations. Summary details will still be displayed.
booleanpin
When a build is triggered by Polling, Build Now or an external Action, the workspace will sync only to the specified label. Any other specified change or label will be ignored.
Supports variable expansion e.g. ${VAR}. If 'now' is used, or a variable that expands to 'now', then the latest change is used (within the scope of the workspace view).
Stringparallel
enable
booleanpath
Stringthreads
Stringminfiles
Stringminbytes
StringpreviewOnlyquiet
Enables the -q flag for all applicable Perforce operations. Summary details will still be displayed.
booleanpin
StringflushOnlyquiet
booleanpin
When a build is triggered by Polling, Build Now or an external Action, the workspace will flush only to the specified label or changelist number. Any other specified change or label will be ignored.
Supports variable expansion e.g. ${VAR}. If 'now' is used, or a variable that expands to 'now', then the latest change is used (within the scope of the workspace view).
StringforceCleanhave
booleanquiet
Enables the -q flag for all applicable Perforce operations. Summary details will still be displayed.
booleanpin
When a build is triggered by Polling, Build Now or an external Action, the workspace will sync only to the specified label. Any other specified change or label will be ignored.
Supports variable expansion e.g. ${VAR}. If 'now' is used, or a variable that expands to 'now', then the latest change is used (within the scope of the workspace view).
Stringparallel
enable
booleanpath
Stringthreads
Stringminfiles
Stringminbytes
StringgraphCleanquiet
Enables the -q flag for all applicable Perforce operations. Summary details will still be displayed.
booleanpin
When a build is triggered by Polling, Build Now or an external Action, the workspace will sync only to the specified label. Any other specified change or label will be ignored.
Supports variable expansion e.g. ${VAR}. If 'now' is used, or a variable that expands to 'now', then the latest change is used (within the scope of the workspace view).
Stringparallel
enable
booleanpath
Stringthreads
Stringminfiles
Stringminbytes
StringsyncOnlyrevert
booleanhave
booleanforce
booleanmodtime
booleanquiet
Enables the -q flag for all applicable Perforce operations. Summary details will still be displayed.
booleanpin
When a build is triggered by Polling, Build Now or an external Action, the workspace will sync only to the specified label. Any other specified change or label will be ignored.
Supports variable expansion e.g. ${VAR}. If 'now' is used, or a variable that expands to 'now', then the latest change is used (within the scope of the workspace view).
Stringparallel
enable
booleanpath
Stringthreads
Stringminfiles
Stringminbytes
Stringtraits (optional)
$class: 'ApprovedPullRequestTrait'strategyId
int$class: 'AuthorInChangelogTrait'$class: 'BitbucketAgedRefsTrait'retentionDays
StringbitbucketBranchCommitSkipTraitbitbucketCommitSkipTrait$class: 'BitbucketJiraValidatorTrait'jiraServerIdx
int$class: 'CheckoutOptionTrait'extension
timeout
int$class: 'CleanAfterCheckoutTrait'$class: 'CleanBeforeCheckoutTrait'$class: 'CleanMercurialSCMSourceTrait'$class: 'CloneOptionTrait'extension
shallow
booleannoTags
booleanreference
Stringtimeout
intdepth (optional)
inthonorRefspec (optional)
boolean$class: 'DisableStatusUpdateTrait'$class: 'DiscoverOtherRefsTrait'ref
The pattern under /refs on the remote repository to discover, can contain a wildcard.
Example: test/*/merged
StringnameMapping (optional)
Mapping for how the ref can be named in for example the @Library.
Example: test-@{1}
Where @{1} replaces the first wildcard in the ref when discovered.
By default it will be "namespace_before_wildcard-@{1}". E.g. if ref is "test/*/merged" the default mapping would be "test-@{1}".
String$class: 'GitBrowserSCMSourceTrait'browser
$class: 'AssemblaWeb'repoUrl
String$class: 'BacklogGitRepositoryBrowser'repoName
StringrepoUrl
String$class: 'BitbucketWeb'repoUrl
String$class: 'CGit'repoUrl
String$class: 'FisheyeGitRepositoryBrowser'repoUrl
String$class: 'GitBlitRepositoryBrowser'repoUrl
StringprojectName
String$class: 'GitBucketBrowser'url
String$class: 'GitLab'repoUrl
Stringversion (optional)
String$class: 'GitList'repoUrl
String$class: 'GitWeb'repoUrl
String$class: 'GiteaBrowser'repoUrl
https://gitea.example.com then the URL for bob's skunkworks project repository might be
https://gitea.example.com/bob/skunkworks
String$class: 'GithubWeb'repoUrl
String$class: 'Gitiles'repoUrl
String$class: 'GitoriousWeb'repoUrl
String$class: 'GogsGit'repoUrl
String$class: 'KilnGit'repoUrl
String$class: 'Phabricator'repoUrl
Stringrepo
String$class: 'RedmineWeb'repoUrl
String$class: 'RhodeCode'repoUrl
String$class: 'Stash'repoUrl
String$class: 'TFS2013GitRepositoryBrowser'repoUrl
If TFS is also used as the repository server, this can usually be left blank.
String$class: 'TracGitRepositoryBrowser'$class: 'ViewGitWeb'repoUrl
StringprojectName
String$class: 'GitHubAgedRefsTrait'retentionDays
StringgitHubBranchCommitSkipTraitgitHubCommitSkipTrait$class: 'GitHubJiraValidatorTrait'jiraServerIdx
int$class: 'GitLFSPullTrait'$class: 'GitToolSCMSourceTrait'gitTool
String$class: 'IgnoreOnPushNotificationTrait'$class: 'LocalBranchTrait'$class: 'MercurialBrowserSCMSourceTrait'browser
$class: 'BitBucket'url
String$class: 'FishEye'url
String$class: 'GoogleCode'url
String$class: 'HgWeb'url
String$class: 'Kallithea'url
String$class: 'KilnHG'url
String$class: 'RhodeCode'url
String$class: 'RhodeCodeLegacy'url
String$class: 'MercurialInstallationSCMSourceTrait'installation
String$class: 'NotificationContextTrait'contextLabel
StringtypeSuffix
Appends the relevant suffix to the context label based on the build type. '/pr-merge', '/pr-head' or '/branch'
boolean$class: 'PreBuildMergeTrait'extension
options
mergeTarget
StringfastForwardMode (optional)
FF, FF_ONLY, NO_FFmergeRemote (optional)
StringmergeStrategy (optional)
DEFAULT, RESOLVE, RECURSIVE, OCTOPUS, OURS, SUBTREE, RECURSIVE_THEIRS$class: 'PretestedIntegrationSCMTrait'extension
gitIntegrationStrategy
accumulatedshortCommitMessage (optional)
booleansquashintegrationBranch
The branch name must match your integration branch name. No trailing slash.
git checkout -B <Branch name> <Repository name>/<Branch name>
git merge --squash <Branch matched by git>
git commit -C <Branch matched by git>
git checkout -B <Branch name> <Repository name>/<Branch name>
git merge -m <commitMsg> <Branch matched by git> --no-ff
Changes are only ever pushed when the build results is SUCCESS
git push <Repository name> <Branch name>StringrepoName
The repository name. In git the repository is always the name of the remote. So if you have specified a repository name in your Git configuration. You need to specify the exact same name here, otherwise no integration will be performed. We do the merge based on this.
No trailing slash on repository name.
Remember to specify this when working with NAMED repositories in Git
String$class: 'PruneStaleBranchTrait'$class: 'PublicRepoPullRequestFilterTrait'$class: 'RefSpecsSCMSourceTrait'templates
value
@{remote} will be replaced by the remote name (which defaults to
origin) before use.
String$class: 'RemoteNameSCMSourceTrait'remoteName
StringskipNotifications$class: 'SubmoduleOptionTrait'extension
disableSubmodules
booleanrecursiveSubmodules
booleantrackingSubmodules
booleanreference
git init --bare git remote add SubProject1 https://gitrepo.com/subproject1 git remote add SubProject2 https://gitrepo.com/subproject2 git fetch --all
Stringtimeout
intparentCredentials
booleandepth (optional)
intshallow (optional)
booleanthreads (optional)
int$class: 'UserIdentityTrait'extension
name
If given, "git config user.name [this]" is called before builds. This overrides whatever is in the global settings.
Stringemail
If given, "git config user.email [this]" is called before builds. This overrides whatever is in the global settings.
String$class: 'WipeWorkspaceTrait'$class: 'com.cloudbees.jenkins.plugins.bitbucket.BranchDiscoveryTrait'strategyId
int$class: 'com.cloudbees.jenkins.plugins.bitbucket.ForkPullRequestDiscoveryTrait'strategyId
inttrust
One of the great powers of pull requests is that anyone with read access to a repository can fork it, commit some changes to their fork and then create a pull request against the original repository with their changes. There are some files stored in source control that are important. For example, a Jenkinsfile may contain configuration details to sandbox pull requests in order to mitigate against malicious pull requests. In order to protect against a malicious pull request itself modifying the Jenkinsfile to remove the protections, you can define the trust policy for pull requests from forks.
Other plugins can extend the available trust policies. The default policies are:
Jenkinsfile) the contents of that file will be retrieved from the target branch on the origin repository and not from the pull request branch on the fork repository.
jenkins.scm.api.SCMRevision>
$class: 'com.cloudbees.jenkins.plugins.bitbucket.OriginPullRequestDiscoveryTrait'strategyId
int$class: 'com.cloudbees.jenkins.plugins.bitbucket.SSHCheckoutTrait'https:// protocol for the Git / Mercurial repository.
This behaviour allows you to select the SSH private key to be used for checking out sources, which will consequently force the checkout to use the ssh:// protocol.
credentialsId
String$class: 'com.cloudbees.jenkins.plugins.bitbucket.TagDiscoveryTrait'$class: 'com.cloudbees.jenkins.plugins.bitbucket.WebhookRegistrationTrait'Overrides the defaults for webhook management.
Webhooks are used to inform Jenkins about changes to repositories. There are two ways webhooks can be configured:
The Manage Jenkins » Configure Jenkins › Bitbucket Endpoints allows defining the list of servers. Each server can be associated with credentials. If credentials are defined then the default behaviour is to use those credentials to automatically manage the webhooks of all repositories that Jenkins is interested in. If no credentials are defined then the default behaviour is to require the user to manually configure webhooks.
mode
String$class: 'jenkins.plugins.gerrit.ChangeDiscoveryTrait'strategyId
int$class: 'jenkins.plugins.gerrit.traits.ChangeDiscoveryTrait'gitBranchDiscoverygitTagDiscoveryheadRegexFilterregex
StringheadWildcardFilterincludes
* as a wildcard; for example:
master release*
Stringexcludes
release
StringheadRegexFilterWithPRregex
StringheadWildcardFilterWithPRincludes
* as a wildcard; for example:
master release*
Stringexcludes
release
String$class: 'org.jenkinsci.plugin.gitea.BranchDiscoveryTrait'strategyId
int$class: 'org.jenkinsci.plugin.gitea.ForkPullRequestDiscoveryTrait'strategyId
inttrust
One of the great powers of pull requests is that anyone with read access to a repository can fork it, commit some changes to their fork and then create a pull request against the original repository with their changes. There are some files stored in source control that are important. For example, a Jenkinsfile may contain configuration details to sandbox pull requests in order to mitigate against malicious pull requests. In order to protect against a malicious pull request itself modifying the Jenkinsfile to remove the protections, you can define the trust policy for pull requests from forks.
Other plugins can extend the available trust policies. The default policies are:
Jenkinsfile) the contents of that file will be retrieved from the target branch on the origin repository and not from the pull request branch on the fork repository.
Nobody.
jenkins.scm.api.SCMRevision>
$class: 'org.jenkinsci.plugin.gitea.OriginPullRequestDiscoveryTrait'strategyId
int$class: 'org.jenkinsci.plugin.gitea.SSHCheckoutTrait'https:// protocol for the Git repository.
This behaviour allows you to select the SSH private key to be used for checking out sources, which will consequently force the checkout to use the ssh:// protocol.
credentialsId
String$class: 'org.jenkinsci.plugin.gitea.WebhookRegistrationTrait'mode
StringgitHubBranchDiscoverystrategyId
intgitHubForkDiscoverystrategyId
inttrust
One of the great powers of pull requests is that anyone with read access to a repository can fork it, commit some changes to their fork and then create a pull request against the original repository with their changes. There are some files stored in source control that are important. For example, a Jenkinsfile may contain configuration details to sandbox pull requests in order to mitigate against malicious pull requests. In order to protect against a malicious pull request itself modifying the Jenkinsfile to remove the protections, you can define the trust policy for pull requests from forks.
Other plugins can extend the available trust policies. The default policies are:
Jenkinsfile) the contents of that file will be retrieved from the target branch on the origin repository and not from the pull request branch on the fork repository.
Nobody.
NOTE: all collaborators are trusted, even if they are only members of a team with read permission.
jenkins.scm.api.SCMRevision>
$class: 'org.jenkinsci.plugins.github_branch_source.OriginPullRequestDiscoveryTrait'strategyId
int$class: 'org.jenkinsci.plugins.github_branch_source.SSHCheckoutTrait'https:// protocol for the Git repository.
This behaviour allows you to select the SSH private key to be used for checking out sources, which will consequently force the checkout to use the ssh:// protocol.
credentialsId
StringgitHubTagDiscovery$class: 'MercurialSCMSource'source
StringcredentialsId (optional)
Stringtraits (optional)
$class: 'ApprovedPullRequestTrait'strategyId
int$class: 'AuthorInChangelogTrait'$class: 'BitbucketAgedRefsTrait'retentionDays
StringbitbucketBranchCommitSkipTraitbitbucketCommitSkipTrait$class: 'BitbucketJiraValidatorTrait'jiraServerIdx
int$class: 'CheckoutOptionTrait'extension
timeout
int$class: 'CleanAfterCheckoutTrait'$class: 'CleanBeforeCheckoutTrait'$class: 'CleanMercurialSCMSourceTrait'$class: 'CloneOptionTrait'extension
shallow
booleannoTags
booleanreference
Stringtimeout
intdepth (optional)
inthonorRefspec (optional)
boolean$class: 'DisableStatusUpdateTrait'$class: 'DiscoverOtherRefsTrait'ref
The pattern under /refs on the remote repository to discover, can contain a wildcard.
Example: test/*/merged
StringnameMapping (optional)
Mapping for how the ref can be named in for example the @Library.
Example: test-@{1}
Where @{1} replaces the first wildcard in the ref when discovered.
By default it will be "namespace_before_wildcard-@{1}". E.g. if ref is "test/*/merged" the default mapping would be "test-@{1}".
String$class: 'GitBrowserSCMSourceTrait'browser
$class: 'AssemblaWeb'repoUrl
String$class: 'BacklogGitRepositoryBrowser'repoName
StringrepoUrl
String$class: 'BitbucketWeb'repoUrl
String$class: 'CGit'repoUrl
String$class: 'FisheyeGitRepositoryBrowser'repoUrl
String$class: 'GitBlitRepositoryBrowser'repoUrl
StringprojectName
String$class: 'GitBucketBrowser'url
String$class: 'GitLab'repoUrl
Stringversion (optional)
String$class: 'GitList'repoUrl
String$class: 'GitWeb'repoUrl
String$class: 'GiteaBrowser'repoUrl
https://gitea.example.com then the URL for bob's skunkworks project repository might be
https://gitea.example.com/bob/skunkworks
String$class: 'GithubWeb'repoUrl
String$class: 'Gitiles'repoUrl
String$class: 'GitoriousWeb'repoUrl
String$class: 'GogsGit'repoUrl
String$class: 'KilnGit'repoUrl
String$class: 'Phabricator'repoUrl
Stringrepo
String$class: 'RedmineWeb'repoUrl
String$class: 'RhodeCode'repoUrl
String$class: 'Stash'repoUrl
String$class: 'TFS2013GitRepositoryBrowser'repoUrl
If TFS is also used as the repository server, this can usually be left blank.
String$class: 'TracGitRepositoryBrowser'$class: 'ViewGitWeb'repoUrl
StringprojectName
String$class: 'GitHubAgedRefsTrait'retentionDays
StringgitHubBranchCommitSkipTraitgitHubCommitSkipTrait$class: 'GitHubJiraValidatorTrait'jiraServerIdx
int$class: 'GitLFSPullTrait'$class: 'GitToolSCMSourceTrait'gitTool
String$class: 'IgnoreOnPushNotificationTrait'$class: 'LocalBranchTrait'$class: 'MercurialBrowserSCMSourceTrait'browser
$class: 'BitBucket'url
String$class: 'FishEye'url
String$class: 'GoogleCode'url
String$class: 'HgWeb'url
String$class: 'Kallithea'url
String$class: 'KilnHG'url
String$class: 'RhodeCode'url
String$class: 'RhodeCodeLegacy'url
String$class: 'MercurialInstallationSCMSourceTrait'installation
String$class: 'NotificationContextTrait'contextLabel
StringtypeSuffix
Appends the relevant suffix to the context label based on the build type. '/pr-merge', '/pr-head' or '/branch'
boolean$class: 'PreBuildMergeTrait'extension
options
mergeTarget
StringfastForwardMode (optional)
FF, FF_ONLY, NO_FFmergeRemote (optional)
StringmergeStrategy (optional)
DEFAULT, RESOLVE, RECURSIVE, OCTOPUS, OURS, SUBTREE, RECURSIVE_THEIRS$class: 'PretestedIntegrationSCMTrait'extension
gitIntegrationStrategy
accumulatedshortCommitMessage (optional)
booleansquashintegrationBranch
The branch name must match your integration branch name. No trailing slash.
git checkout -B <Branch name> <Repository name>/<Branch name>
git merge --squash <Branch matched by git>
git commit -C <Branch matched by git>
git checkout -B <Branch name> <Repository name>/<Branch name>
git merge -m <commitMsg> <Branch matched by git> --no-ff
Changes are only ever pushed when the build results is SUCCESS
git push <Repository name> <Branch name>StringrepoName
The repository name. In git the repository is always the name of the remote. So if you have specified a repository name in your Git configuration. You need to specify the exact same name here, otherwise no integration will be performed. We do the merge based on this.
No trailing slash on repository name.
Remember to specify this when working with NAMED repositories in Git
String$class: 'PruneStaleBranchTrait'$class: 'PublicRepoPullRequestFilterTrait'$class: 'RefSpecsSCMSourceTrait'templates
value
@{remote} will be replaced by the remote name (which defaults to
origin) before use.
String$class: 'RemoteNameSCMSourceTrait'remoteName
StringskipNotifications$class: 'SubmoduleOptionTrait'extension
disableSubmodules
booleanrecursiveSubmodules
booleantrackingSubmodules
booleanreference
git init --bare git remote add SubProject1 https://gitrepo.com/subproject1 git remote add SubProject2 https://gitrepo.com/subproject2 git fetch --all
Stringtimeout
intparentCredentials
booleandepth (optional)
intshallow (optional)
booleanthreads (optional)
int$class: 'UserIdentityTrait'extension
name
If given, "git config user.name [this]" is called before builds. This overrides whatever is in the global settings.
Stringemail
If given, "git config user.email [this]" is called before builds. This overrides whatever is in the global settings.
String$class: 'WipeWorkspaceTrait'$class: 'com.cloudbees.jenkins.plugins.bitbucket.BranchDiscoveryTrait'strategyId
int$class: 'com.cloudbees.jenkins.plugins.bitbucket.ForkPullRequestDiscoveryTrait'strategyId
inttrust
One of the great powers of pull requests is that anyone with read access to a repository can fork it, commit some changes to their fork and then create a pull request against the original repository with their changes. There are some files stored in source control that are important. For example, a Jenkinsfile may contain configuration details to sandbox pull requests in order to mitigate against malicious pull requests. In order to protect against a malicious pull request itself modifying the Jenkinsfile to remove the protections, you can define the trust policy for pull requests from forks.
Other plugins can extend the available trust policies. The default policies are:
Jenkinsfile) the contents of that file will be retrieved from the target branch on the origin repository and not from the pull request branch on the fork repository.
jenkins.scm.api.SCMRevision>
$class: 'com.cloudbees.jenkins.plugins.bitbucket.OriginPullRequestDiscoveryTrait'strategyId
int$class: 'com.cloudbees.jenkins.plugins.bitbucket.SSHCheckoutTrait'https:// protocol for the Git / Mercurial repository.
This behaviour allows you to select the SSH private key to be used for checking out sources, which will consequently force the checkout to use the ssh:// protocol.
credentialsId
String$class: 'com.cloudbees.jenkins.plugins.bitbucket.TagDiscoveryTrait'$class: 'com.cloudbees.jenkins.plugins.bitbucket.WebhookRegistrationTrait'Overrides the defaults for webhook management.
Webhooks are used to inform Jenkins about changes to repositories. There are two ways webhooks can be configured:
The Manage Jenkins » Configure Jenkins › Bitbucket Endpoints allows defining the list of servers. Each server can be associated with credentials. If credentials are defined then the default behaviour is to use those credentials to automatically manage the webhooks of all repositories that Jenkins is interested in. If no credentials are defined then the default behaviour is to require the user to manually configure webhooks.
mode
String$class: 'jenkins.plugins.gerrit.ChangeDiscoveryTrait'strategyId
int$class: 'jenkins.plugins.gerrit.traits.ChangeDiscoveryTrait'gitBranchDiscoverygitTagDiscoveryheadRegexFilterregex
StringheadWildcardFilterincludes
* as a wildcard; for example:
master release*
Stringexcludes
release
StringheadRegexFilterWithPRregex
StringheadWildcardFilterWithPRincludes
* as a wildcard; for example:
master release*
Stringexcludes
release
String$class: 'org.jenkinsci.plugin.gitea.BranchDiscoveryTrait'strategyId
int$class: 'org.jenkinsci.plugin.gitea.ForkPullRequestDiscoveryTrait'strategyId
inttrust
One of the great powers of pull requests is that anyone with read access to a repository can fork it, commit some changes to their fork and then create a pull request against the original repository with their changes. There are some files stored in source control that are important. For example, a Jenkinsfile may contain configuration details to sandbox pull requests in order to mitigate against malicious pull requests. In order to protect against a malicious pull request itself modifying the Jenkinsfile to remove the protections, you can define the trust policy for pull requests from forks.
Other plugins can extend the available trust policies. The default policies are:
Jenkinsfile) the contents of that file will be retrieved from the target branch on the origin repository and not from the pull request branch on the fork repository.
Nobody.
jenkins.scm.api.SCMRevision>
$class: 'org.jenkinsci.plugin.gitea.OriginPullRequestDiscoveryTrait'strategyId
int$class: 'org.jenkinsci.plugin.gitea.SSHCheckoutTrait'https:// protocol for the Git repository.
This behaviour allows you to select the SSH private key to be used for checking out sources, which will consequently force the checkout to use the ssh:// protocol.
credentialsId
String$class: 'org.jenkinsci.plugin.gitea.WebhookRegistrationTrait'mode
StringgitHubBranchDiscoverystrategyId
intgitHubForkDiscoverystrategyId
inttrust
One of the great powers of pull requests is that anyone with read access to a repository can fork it, commit some changes to their fork and then create a pull request against the original repository with their changes. There are some files stored in source control that are important. For example, a Jenkinsfile may contain configuration details to sandbox pull requests in order to mitigate against malicious pull requests. In order to protect against a malicious pull request itself modifying the Jenkinsfile to remove the protections, you can define the trust policy for pull requests from forks.
Other plugins can extend the available trust policies. The default policies are:
Jenkinsfile) the contents of that file will be retrieved from the target branch on the origin repository and not from the pull request branch on the fork repository.
Nobody.
NOTE: all collaborators are trusted, even if they are only members of a team with read permission.
jenkins.scm.api.SCMRevision>
$class: 'org.jenkinsci.plugins.github_branch_source.OriginPullRequestDiscoveryTrait'strategyId
int$class: 'org.jenkinsci.plugins.github_branch_source.SSHCheckoutTrait'https:// protocol for the Git repository.
This behaviour allows you to select the SSH private key to be used for checking out sources, which will consequently force the checkout to use the ssh:// protocol.
credentialsId
StringgitHubTagDiscovery$class: 'SingleSCMSource'id
Stringname
Stringscm
$class: 'AWSCodePipelineSCM'name
StringclearWorkspace
booleanregion
StringawsAccessKey
In order to integrate with AWS CodePipeline, you must authorize access to the pipeline and its related artifacts. If you installed Jenkins on a supported Amazon EC2 instance type, such as Amazon Linux, you can install the AWS CLI and configure a profile with the required credentials. This is the preferred method. In all other cases, you can store AWS credentials in these fields. You should securely configure your Jenkins instance to use HTTPS so that these credentials are not sent unencrypted. For more information, see AWS CodePipeline Integration for Other Products and Services.
StringawsSecretKey
>In order to integrate with AWS CodePipeline, you must authorize access to the pipeline and its related artifacts. If you installed Jenkins on a supported Amazon EC2 instance type, such as Amazon Linux, you can install the AWS CLI and configure a profile with the required credentials. This is the preferred method. In all other cases, you can store AWS credentials in these fields. You should securely configure your Jenkins instance to use HTTPS so that these credentials are not sent unencrypted. For more information, see AWS CodePipeline Integration for Other Products and Services.
StringproxyHost
You might need a proxy host address if you are hosting Jenkins on a private network. The proxy name can be an IP address or DNS address. The AWS CodePipeline Plugin for Jenkins requires internet access. If access is not configured, you might see errors in the AWS CodePipeline Polling Log.
StringproxyPort
You might need a proxy port for your proxy host address if you are hosting Jenkins on a private network. The proxy port is a number, might be on port 8080, 3128, or 8443, depending on your network protocols and security settings. If access is not configured, you might see errors in the AWS CodePipeline Polling Log.
Stringcategory
This is the category of the action type in AWS CodePipeline, and is usually either Build or Test. To see an example usage, see Install and Configure the AWS CodePipeline Plugin for Jenkins.
Stringprovider
This is the provider name of the action type in AWS CodePipeline. You must provide this exact string when adding an action for Jenkins in AWS CodePipeline. To see an example usage, see Install and Configure the AWS CodePipeline Plugin for Jenkins.
Stringversion
Leave the default as 1.
Stringaccurevdepot
Stringstream
StringserverName (optional)
StringserverUUID (optional)
StringaccurevTool (optional)
Stringcleanreftree (optional)
booleandirectoryOffset (optional)
StringdontPopContent (optional)
booleanfilterForPollSCM (optional)
StringignoreStreamParent (optional)
booleanreftree (optional)
StringsnapshotNameFormat (optional)
StringsubPath (optional)
Stringsynctime (optional)
booleanuseSnapshot (optional)
booleanworkspace (optional)
StringwspaceORreftree (optional)
String$class: 'BazaarSCM'source
Stringcleantree
booleanbrowser
$class: 'Loggerhead'url
String$class: 'OpenGrok'url
StringrootModule
Stringcheckout
boolean$class: 'BitKeeperSCM'parent
StringlocalRepository
StringusePull
booleanquiet
boolean$class: 'BlameSubversionSCM'if it is false and the build is not triggered by upstream job,
the plugin will not collect any svn info from upstream job.
else the plugin will collect svn info from latest upstream job
alwaysCollectSVNInfo
boolean$class: 'CCUCMScm'loadModule
Stringnewest
booleanmode
$class: 'PollChildMode'levelToPoll
Stringcomponent (optional)
StringcreateBaseline (optional)
Check this if you want create a baseline after a completed deliver.
This is only applicable for child and sibling poll mode.
booleannewest (optional)
boolean$class: 'PollRebaseMode'levelToPoll
Stringcomponent (optional)
StringcreateBaseline (optional)
booleanexcludeList (optional)
String$class: 'PollSelfMode'levelToPoll
Stringcomponent (optional)
Stringnewest (optional)
boolean$class: 'PollSiblingMode'levelToPoll
Stringcomponent (optional)
StringcreateBaseline (optional)
Check this if you want create a baseline after a completed deliver.
This is only applicable for child and sibling poll mode.
booleannewest (optional)
booleanuseHyperLinkForPolling (optional)
boolean$class: 'PollSubscribeMode'levelToPoll
StringcomponentsToMonitor
componentSelection
StringjobsToMonitor
jobname
Stringignores
StringjobName (optional)
StringcascadePromotion (optional)
booleancomponent (optional)
Stringnewest (optional)
booleanstream
StringtreatUnstable
StringnameTemplate
StringforceDeliver
booleanrecommend
booleanmakeTag
booleansetDescription
booleanbuildProject
StringremoveViewPrivateFiles
booleantrimmedChangeSet
booleandiscard
boolean$class: 'CVSSCM'repositories
cvsRoot
StringpasswordRequired
booleanpassword
StringrepositoryItems
location
$class: 'BranchRepositoryLocation'branchName
StringuseHeadIfNotFound
boolean$class: 'HeadRepositoryLocation'$class: 'TagRepositoryLocation'tagName
StringuseHeadIfNotFound
booleanmodules
remoteName
StringlocalName
StringprojectsetFileName
StringexcludedRegions
src/main/web/.*\.html src/main/web/.*\.jpeg src/main/web/.*\.gifThe example above illustrates that if only html/jpeg/gif files have been committed to the SCM a build will not occur. More information on regular expressions can be found here.
pattern
StringcompressionLevel
intrepositoryBrowser
$class: 'FishEyeCVS'url
String$class: 'OpenGrok'url
String$class: 'ViewCVS'url
StringcanUseUpdate
booleanlegacy
If you have multiple modules to check out, this option is forced (otherwise they'll overlap.)
This affects other path specifiers, such as artifact archivers --- you now specify "build/foo.jar" instead of "foo/build/foo.jar".
booleanskipChangeLog
booleanpruneEmptyDirectories
booleandisableCvsQuiet
booleancleanOnFailedUpdate
booleanforceCleanCopy
booleancheckoutCurrentTimestamp
The build quiet period is designed to assist with CVS checkouts by waiting for a specific period of time without commits. Normally you want the checkout to reflect the time when the quiet period was exited successfully. Select this option if you need to re-enable the legacy behaviour of Jenkins, i.e. using the time that the build started checking out as the timestamp for the checkout operation. Note: enabling this option can result in the quiet period being defeated especially in those cases where the build is not able to start immediately after exiting the quiet period.
boolean$class: 'ClearCaseSCM'branch
Stringlabel
StringextractConfigSpec
booleanconfigSpecFileName
StringrefreshConfigSpec
booleanrefreshConfigSpecCommand
StringconfigSpec
StringviewTag
Stringuseupdate
booleanextractLoadRules
booleanloadRules
StringuseOtherLoadRulesForPolling
booleanloadRulesForPolling
Stringusedynamicview
booleanviewdrive
Stringmkviewoptionalparam
StringfilterOutDestroySubBranchEvent
booleandoNotUpdateConfigSpec
booleanrmviewonrename
booleanexcludedRegions
StringmultiSitePollBuffer
StringuseTimeRule
booleancreateDynView
booleanviewPath
Stringchangeset
ALL, BRANCH, NONE, UPDTviewStorage
Three strategies are currently available to manage view storage location.
$class: 'DefaultViewStorage'$class: 'ServerViewStorage'assignedLabelString
Label expression used to populate view storage location dropdown.
Stringserver
The view storage location that will be passed to the -stgloc option.
The list of available servers is retrieved using cleartool lsstgloc -view
Note that auto is always available.
String$class: 'SpecificViewStorage'winStorageDir
StringunixStorageDir
String$class: 'ClearCaseUcmBaselineSCM'$class: 'ClearCaseUcmSCM'stream
Stringloadrules
StringviewTag
Stringusedynamicview
booleanviewdrive
Stringmkviewoptionalparam
StringfilterOutDestroySubBranchEvent
booleanuseUpdate
booleanrmviewonrename
booleanexcludedRegions
StringmultiSitePollBuffer
StringoverrideBranchName
StringcreateDynView
booleanfreezeCode
booleanrecreateView
booleanallocateViewName
booleanviewPath
StringuseManualLoadRules
booleanchangeset
ALL, BRANCH, NONE, UPDTviewStorage
Three strategies are currently available to manage view storage location.
$class: 'DefaultViewStorage'$class: 'ServerViewStorage'assignedLabelString
Label expression used to populate view storage location dropdown.
Stringserver
The view storage location that will be passed to the -stgloc option.
The list of available servers is retrieved using cleartool lsstgloc -view
Note that auto is always available.
String$class: 'SpecificViewStorage'winStorageDir
StringunixStorageDir
StringbuildFoundationBaseline
If checked, instead of creating a view on the current stream, the job will look up the current foundation baselines for the given stream and work in readonly on these baselines. If polling is enabled, the build will be triggered every time a new foundation baseline is detected on the given stream.
boolean$class: 'CloneWorkspaceSCM'parentJobName
Stringcriteria
String$class: 'CmvcSCM'family
Stringbecome
Stringreleases
StringcheckoutScript
StringtrackViewReportWhereClause
String$class: 'ConfigurationRotator'acrs
$class: 'ClearCaseUCM'pvobName
Stringcontribute
Contribute data to a global database. Defined in the Compatibility Action Storage Plugin.
booleantargets
baselineName
Stringlevel
INITIAL, BUILT, TESTED, RELEASED, REJECTEDfixed
booleanuseNewest (optional)
boolean$class: 'Git'targets
name
Stringrepository
Stringbranch
StringcommitId
Stringfixed
booleanuseNewest (optional)
boolean$class: 'CvsProjectset'repositories
cvsRoot
StringpasswordRequired
booleanpassword
StringrepositoryItems
location
$class: 'BranchRepositoryLocation'branchName
StringuseHeadIfNotFound
boolean$class: 'HeadRepositoryLocation'$class: 'TagRepositoryLocation'tagName
StringuseHeadIfNotFound
booleanmodules
remoteName
StringlocalName
StringprojectsetFileName
StringexcludedRegions
src/main/web/.*\.html src/main/web/.*\.jpeg src/main/web/.*\.gifThe example above illustrates that if only html/jpeg/gif files have been committed to the SCM a build will not occur. More information on regular expressions can be found here.
pattern
StringcompressionLevel
intrepositoryBrowser
$class: 'FishEyeCVS'url
String$class: 'OpenGrok'url
String$class: 'ViewCVS'url
StringcanUseUpdate
booleanusername
Stringpassword
Stringbrowser
$class: 'FishEyeCVS'url
String$class: 'OpenGrok'url
String$class: 'ViewCVS'url
StringskipChangeLog
booleanpruneEmptyDirectories
booleandisableCvsQuiet
booleancleanOnFailedUpdate
booleanforceCleanCopy
boolean$class: 'DarcsScm'source
StringlocalDir
Stringclean
booleanbrowser
$class: 'DarcsWeb'url
Stringrepo
String$class: 'Darcsden'url
String$class: 'DelegateSCM'clazz
String$class: 'DimensionsSCM'project
Stringfolders
StringpathsToExclude
Stringworkarea
StringcanJobDelete
booleancanJobForce
booleancanJobRevert
booleanjobUserName
StringjobPasswd
StringjobServer
StringjobDatabase
StringcanJobUpdate
booleanjobTimeZone
StringjobWebUrl
Stringdirectory
Stringpermissions
Stringeol
StringcanJobExpand
booleancanJobNoMetadata
booleancanJobNoTouch
booleanforceAsSlave
boolean$class: 'DrushMakefileSCM'makefile
Specify the content of the Makefile. Support for YAML Makefiles depends on the version of Drush you have installed.
This example will generate a vanilla Drupal 7.38:
api=2
core=7.x
projects[drupal][version]=7.38
Stringroot
String$class: 'EndevorConfiguration'connectionId
StringfilterPattern
StringfileExtension
StringcredentialsId
StringtargetFolder
Stringfilesystempath
The file path for the source code.
e.g. \\Server1\project1\src or c:\myproject\src
Note for distributed build environment, please make sure the path is accessible on remote node(s)
StringclearWorkspace
If true, the system will delete all existing files/sub-folders in workspace before checking-out. Poll changes will not be affected by this setting.
booleancopyHidden
If true, the system will copy hidden files and folders as well. Default is false.
booleanfilterSettings
includeFilter
booleanselectors
You can apply wildcard filter(s) when detecting changes and copying files. By default, the system will filter out hidden files, on Unix, that means files/folder starting with ".", on Windows, that means files/folders with "hidden" attribute. You may want to filter out, e.g. files with ".tmp" extension.
Note: filters are applied on both sides, source and destination (i.e. the workspace). E.g. if you filter out ".tmp" files, all ".tmp" files currently in workspace will not be removed.
wildcard
ANT style wildcard.
To include just *.java, set filter type to "Include" and type add "*.java" (without quote) in the wildcard. To exclude *.exe" and all JUnit test cases, set filter type to "Exclude" and add two wildcard, one for "*.dll" and one for "*Test*"
To exclude a directory, set filter to "**/dir_to_exclude/**"
Note: (1) the wildcard is case insensitive, (2) all backslashes (\) will be replaced with slashes (/)
String$class: 'FeatureBranchAwareMercurialSCM'installation
Stringsource
Stringbranch
Stringmodules
Stringsubdir
my/sources (use forward slashes). If changing this entry, you probably want to clean the workspace first.
Stringbrowser
$class: 'BitBucket'url
String$class: 'FishEye'url
String$class: 'GoogleCode'url
String$class: 'HgWeb'url
String$class: 'Kallithea'url
String$class: 'KilnHG'url
String$class: 'RhodeCode'url
String$class: 'RhodeCodeLegacy'url
Stringclean
booleanbranchPattern
String$class: 'GeneXusServerSCM'gxInstallationId
StringserverURL
StringcredentialsId
StringkbName
StringkbVersion
StringlocalKbPath
StringlocalKbVersion
StringkbDbServerInstance
StringkbDbCredentialsId
StringkbDbName
StringkbDbInSameFolder
boolean$class: 'GitSCM'userRemoteConfigs
${SUPER_PROJECT_URL}/${SUBMODULE}, rather than relying on information from .gitmodules.url
Stringname
You normally want to specify this when you have multiple remote repositories.
Stringrefspec
In other words, the default refspec is "+refs/heads/*:refs/remotes/REPOSITORYNAME/*" where REPOSITORYNAME is the value you specify in the above "name of repository" textbox.
When do you want to modify this value? A good example is when you want to just retrieve one branch. For example, +refs/heads/master:refs/remotes/origin/master would only retrieve the master branch and nothing else.
The plugin uses a default refspec for its initial fetch, unless the "Advanced Clone Option" is set to honor refspec. This keeps 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. +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.
See the term definition in Git user manual for more details.
StringcredentialsId
Stringbranches
name
Specify the branches if you'd like to track a specific branch in a repository. If left blank, all branches will be examined for changes and built.
The safest way is to use the refs/heads/<branchName> syntax. This way the expected branch is unambiguous.
If your branch name has a / in it make sure to use the full reference above. When not presented with a full path the plugin will only use the part of the string right of the last slash. Meaning foo/bar will actually match bar
.If you use a wildcard branch specifier, with a slash (e.g. release/), you'll need to specify the origin repository in the branch names to make sure changes are picked up. So e.g. origin/release/
Possible options:
StringdoGenerateSubmoduleConfigurations
booleansubmoduleCfg
hudson.plugins.git.SubmoduleConfig
browser
$class: 'AssemblaWeb'repoUrl
String$class: 'BacklogGitRepositoryBrowser'repoName
StringrepoUrl
String$class: 'BitbucketWeb'repoUrl
String$class: 'CGit'repoUrl
String$class: 'FisheyeGitRepositoryBrowser'repoUrl
String$class: 'GitBlitRepositoryBrowser'repoUrl
StringprojectName
String$class: 'GitBucketBrowser'url
String$class: 'GitLab'repoUrl
Stringversion (optional)
String$class: 'GitList'repoUrl
String$class: 'GitWeb'repoUrl
String$class: 'GiteaBrowser'repoUrl
https://gitea.example.com then the URL for bob's skunkworks project repository might be
https://gitea.example.com/bob/skunkworks
String$class: 'GithubWeb'repoUrl
String$class: 'Gitiles'repoUrl
String$class: 'GitoriousWeb'repoUrl
String$class: 'GogsGit'repoUrl
String$class: 'KilnGit'repoUrl
String$class: 'Phabricator'repoUrl
Stringrepo
String$class: 'RedmineWeb'repoUrl
String$class: 'RhodeCode'repoUrl
String$class: 'Stash'repoUrl
String$class: 'TFS2013GitRepositoryBrowser'repoUrl
If TFS is also used as the repository server, this can usually be left blank.
String$class: 'TracGitRepositoryBrowser'$class: 'ViewGitWeb'repoUrl
StringprojectName
StringgitTool
Stringextensions
$class: 'AuthorInChangelog'$class: 'BuildChooserSetting'This extension point in Jenkins is used by many other plugins to control the job to build specific commits. When you activate those plugins, you may see them installing a custom strategy here.
buildChooser
$class: 'AlternativeBuildChooser'$class: 'AncestryBuildChooser'maximumAgeInDays
intancestorCommitSha1
String$class: 'DefaultBuildChooser'$class: 'DeflakeGitBuildChooser'$class: 'GerritTriggerBuildChooser'$class: 'InverseBuildChooser'$class: 'ChangelogToBranch'options
compareRemote
StringcompareTarget
String$class: 'CheckoutOption'timeout
int$class: 'CleanBeforeCheckout'$class: 'CleanCheckout'$class: 'CloneOption'shallow
booleannoTags
booleanreference
Stringtimeout
intdepth (optional)
inthonorRefspec (optional)
boolean$class: 'CodeCommitURLHelper'credentialId
OPTIONAL: Select the credentials to use.
If not specified, defaults to the DefaultAWSCredentialsProviderChain behaviour - *FROM THE JENKINS INSTANCE*
In the latter case, usage of IAM Role Profiles seems not to work, thus relying on environment variables / system properties or the ~/.aws/credentials file, thus not recommended.
StringrepositoryName
String$class: 'DisableRemotePoll'$class: 'GitLFSPull'$class: 'GitTagMessageExtension'useMostRecentTag (optional)
boolean$class: 'IgnoreNotifyCommit'$class: 'LocalBranch'If selected, and its 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/newfeature.
Please note that this has not been tested with submodules.
localBranch
String$class: 'MessageExclusion'excludedMessage
.*\[maven-release-plugin\].*The example above illustrates that if only revisions with "[maven-release-plugin]" message in first comment line have been committed to the SCM a build will not occur. You can create more complex patterns using embedded flag expressions.
(?s).*FOO.*This example will search FOO message in all comment lines.
String$class: 'PathRestriction'includedRegions
myapp/src/main/web/.*\.html
myapp/src/main/web/.*\.jpeg
myapp/src/main/web/.*\.gif
The example above illustrates that a build will only occur, if html/jpeg/gif files have been committed to the SCM. Exclusions take precedence over inclusions, if there is an overlap between included and excluded regions.
StringexcludedRegions
myapp/src/main/web/.*\.html
myapp/src/main/web/.*\.jpeg
myapp/src/main/web/.*\.gif
The example above illustrates that if only html/jpeg/gif files have been committed to the SCM a build will not occur.
String$class: 'PerBuildTag'$class: 'PreBuildMerge'options
mergeTarget
StringfastForwardMode (optional)
FF, FF_ONLY, NO_FFmergeRemote (optional)
StringmergeStrategy (optional)
DEFAULT, RESOLVE, RECURSIVE, OCTOPUS, OURS, SUBTREE, RECURSIVE_THEIRSpretestedIntegrationgitIntegrationStrategy
accumulatedshortCommitMessage (optional)
booleansquashintegrationBranch
The branch name must match your integration branch name. No trailing slash.
git checkout -B <Branch name> <Repository name>/<Branch name>
git merge --squash <Branch matched by git>
git commit -C <Branch matched by git>
git checkout -B <Branch name> <Repository name>/<Branch name>
git merge -m <commitMsg> <Branch matched by git> --no-ff
Changes are only ever pushed when the build results is SUCCESS
git push <Repository name> <Branch name>StringrepoName
The repository name. In git the repository is always the name of the remote. So if you have specified a repository name in your Git configuration. You need to specify the exact same name here, otherwise no integration will be performed. We do the merge based on this.
No trailing slash on repository name.
Remember to specify this when working with NAMED repositories in Git
String$class: 'PruneStaleBranch'$class: 'RelativeTargetDirectory'relativeTargetDir
String$class: 'ScmName'Unique name for this SCM. Needed when using Git within the Multi SCM plugin.
name
String$class: 'SparseCheckoutPaths'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
sparseCheckoutPaths
path
String$class: 'SubmoduleOption'disableSubmodules
booleanrecursiveSubmodules
booleantrackingSubmodules
booleanreference
git init --bare git remote add SubProject1 https://gitrepo.com/subproject1 git remote add SubProject2 https://gitrepo.com/subproject2 git fetch --all
Stringtimeout
intparentCredentials
booleandepth (optional)
intshallow (optional)
booleanthreads (optional)
int$class: 'UserExclusion'excludedUsers
auto_build_userThe example above illustrates that if only revisions by "auto_build_user" have been committed to the SCM a build will not occur.
String$class: 'UserIdentity'name
If given, "git config user.name [this]" is called before builds. This overrides whatever is in the global settings.
Stringemail
If given, "git config user.email [this]" is called before builds. This overrides whatever is in the global settings.
String$class: 'WipeWorkspace'$class: 'HarvestSCM'broker
StringpasswordFile
StringuserId
Stringpassword
StringprojectName
Stringstate
StringviewPath
StringclientPath
StringprocessName
StringrecursiveSearch
StringuseSynchronize
booleanextraOptions
String$class: 'IspwConfiguration'connectionId
StringcredentialsId
StringserverConfig
StringserverStream
StringserverApplication
StringserverLevel
StringlevelOption
StringcomponentType
StringfolderName
StringispwDownloadAll
boolean$class: 'IspwContainerConfiguration'connectionId
StringcredentialsId
StringserverConfig
StringcontainerName
StringcontainerType
StringserverLevel
StringcomponentType
StringispwDownloadAll
boolean$class: 'MercurialSCM'source
Stringbrowser (optional)
$class: 'BitBucket'url
String$class: 'FishEye'url
String$class: 'GoogleCode'url
String$class: 'HgWeb'url
String$class: 'Kallithea'url
String$class: 'KilnHG'url
String$class: 'RhodeCode'url
String$class: 'RhodeCodeLegacy'url
Stringclean (optional)
booleancredentialsId (optional)
StringdisableChangeLog (optional)
booleaninstallation (optional)
Stringmodules (optional)
Stringrevision (optional)
default branch.)
StringrevisionType (optional)
BRANCH, TAG, CHANGESET, REVSETsubdir (optional)
my/sources (use forward slashes). If changing this entry, you probably want to clean the workspace first.
String$class: 'MergeBotUpdater'$class: 'MultiSCM'scmList
$class: 'AWSCodePipelineSCM'name
StringclearWorkspace
booleanregion
StringawsAccessKey
In order to integrate with AWS CodePipeline, you must authorize access to the pipeline and its related artifacts. If you installed Jenkins on a supported Amazon EC2 instance type, such as Amazon Linux, you can install the AWS CLI and configure a profile with the required credentials. This is the preferred method. In all other cases, you can store AWS credentials in these fields. You should securely configure your Jenkins instance to use HTTPS so that these credentials are not sent unencrypted. For more information, see AWS CodePipeline Integration for Other Products and Services.
StringawsSecretKey
>In order to integrate with AWS CodePipeline, you must authorize access to the pipeline and its related artifacts. If you installed Jenkins on a supported Amazon EC2 instance type, such as Amazon Linux, you can install the AWS CLI and configure a profile with the required credentials. This is the preferred method. In all other cases, you can store AWS credentials in these fields. You should securely configure your Jenkins instance to use HTTPS so that these credentials are not sent unencrypted. For more information, see AWS CodePipeline Integration for Other Products and Services.
StringproxyHost
You might need a proxy host address if you are hosting Jenkins on a private network. The proxy name can be an IP address or DNS address. The AWS CodePipeline Plugin for Jenkins requires internet access. If access is not configured, you might see errors in the AWS CodePipeline Polling Log.
StringproxyPort
You might need a proxy port for your proxy host address if you are hosting Jenkins on a private network. The proxy port is a number, might be on port 8080, 3128, or 8443, depending on your network protocols and security settings. If access is not configured, you might see errors in the AWS CodePipeline Polling Log.
Stringcategory
This is the category of the action type in AWS CodePipeline, and is usually either Build or Test. To see an example usage, see Install and Configure the AWS CodePipeline Plugin for Jenkins.
Stringprovider
This is the provider name of the action type in AWS CodePipeline. You must provide this exact string when adding an action for Jenkins in AWS CodePipeline. To see an example usage, see Install and Configure the AWS CodePipeline Plugin for Jenkins.
Stringversion
Leave the default as 1.
Stringaccurevdepot
Stringstream
StringserverName (optional)
StringserverUUID (optional)
StringaccurevTool (optional)
Stringcleanreftree (optional)
booleandirectoryOffset (optional)
StringdontPopContent (optional)
booleanfilterForPollSCM (optional)
StringignoreStreamParent (optional)
booleanreftree (optional)
StringsnapshotNameFormat (optional)
StringsubPath (optional)
Stringsynctime (optional)
booleanuseSnapshot (optional)
booleanworkspace (optional)
StringwspaceORreftree (optional)
String$class: 'BazaarSCM'source
Stringcleantree
booleanbrowser
$class: 'Loggerhead'url
String$class: 'OpenGrok'url
StringrootModule
Stringcheckout
boolean$class: 'BitKeeperSCM'parent
StringlocalRepository
StringusePull
booleanquiet
boolean$class: 'BlameSubversionSCM'if it is false and the build is not triggered by upstream job,
the plugin will not collect any svn info from upstream job.
else the plugin will collect svn info from latest upstream job
alwaysCollectSVNInfo
boolean$class: 'CCUCMScm'loadModule
Stringnewest
booleanmode
$class: 'PollChildMode'levelToPoll
Stringcomponent (optional)
StringcreateBaseline (optional)
Check this if you want create a baseline after a completed deliver.
This is only applicable for child and sibling poll mode.
booleannewest (optional)
boolean$class: 'PollRebaseMode'levelToPoll
Stringcomponent (optional)
StringcreateBaseline (optional)
booleanexcludeList (optional)
String$class: 'PollSelfMode'levelToPoll
Stringcomponent (optional)
Stringnewest (optional)
boolean$class: 'PollSiblingMode'levelToPoll
Stringcomponent (optional)
StringcreateBaseline (optional)
Check this if you want create a baseline after a completed deliver.
This is only applicable for child and sibling poll mode.
booleannewest (optional)
booleanuseHyperLinkForPolling (optional)
boolean$class: 'PollSubscribeMode'levelToPoll
StringcomponentsToMonitor
componentSelection
StringjobsToMonitor
jobname
Stringignores
StringjobName (optional)
StringcascadePromotion (optional)
booleancomponent (optional)
Stringnewest (optional)
booleanstream
StringtreatUnstable
StringnameTemplate
StringforceDeliver
booleanrecommend
booleanmakeTag
booleansetDescription
booleanbuildProject
StringremoveViewPrivateFiles
booleantrimmedChangeSet
booleandiscard
boolean$class: 'CVSSCM'repositories
cvsRoot
StringpasswordRequired
booleanpassword
StringrepositoryItems
location
$class: 'BranchRepositoryLocation'branchName
StringuseHeadIfNotFound
boolean$class: 'HeadRepositoryLocation'$class: 'TagRepositoryLocation'tagName
StringuseHeadIfNotFound
booleanmodules
remoteName
StringlocalName
StringprojectsetFileName
StringexcludedRegions
src/main/web/.*\.html src/main/web/.*\.jpeg src/main/web/.*\.gifThe example above illustrates that if only html/jpeg/gif files have been committed to the SCM a build will not occur. More information on regular expressions can be found here.
pattern
StringcompressionLevel
intrepositoryBrowser
$class: 'FishEyeCVS'url
String$class: 'OpenGrok'url
String$class: 'ViewCVS'url
StringcanUseUpdate
booleanlegacy
If you have multiple modules to check out, this option is forced (otherwise they'll overlap.)
This affects other path specifiers, such as artifact archivers --- you now specify "build/foo.jar" instead of "foo/build/foo.jar".
booleanskipChangeLog
booleanpruneEmptyDirectories
booleandisableCvsQuiet
booleancleanOnFailedUpdate
booleanforceCleanCopy
booleancheckoutCurrentTimestamp
The build quiet period is designed to assist with CVS checkouts by waiting for a specific period of time without commits. Normally you want the checkout to reflect the time when the quiet period was exited successfully. Select this option if you need to re-enable the legacy behaviour of Jenkins, i.e. using the time that the build started checking out as the timestamp for the checkout operation. Note: enabling this option can result in the quiet period being defeated especially in those cases where the build is not able to start immediately after exiting the quiet period.
boolean$class: 'ClearCaseSCM'branch
Stringlabel
StringextractConfigSpec
booleanconfigSpecFileName
StringrefreshConfigSpec
booleanrefreshConfigSpecCommand
StringconfigSpec
StringviewTag
Stringuseupdate
booleanextractLoadRules
booleanloadRules
StringuseOtherLoadRulesForPolling
booleanloadRulesForPolling
Stringusedynamicview
booleanviewdrive
Stringmkviewoptionalparam
StringfilterOutDestroySubBranchEvent
booleandoNotUpdateConfigSpec
booleanrmviewonrename
booleanexcludedRegions
StringmultiSitePollBuffer
StringuseTimeRule
booleancreateDynView
booleanviewPath
Stringchangeset
ALL, BRANCH, NONE, UPDTviewStorage
Three strategies are currently available to manage view storage location.
$class: 'DefaultViewStorage'$class: 'ServerViewStorage'assignedLabelString
Label expression used to populate view storage location dropdown.
Stringserver
The view storage location that will be passed to the -stgloc option.
The list of available servers is retrieved using cleartool lsstgloc -view
Note that auto is always available.
String$class: 'SpecificViewStorage'winStorageDir
StringunixStorageDir
String$class: 'ClearCaseUcmBaselineSCM'$class: 'ClearCaseUcmSCM'stream
Stringloadrules
StringviewTag
Stringusedynamicview
booleanviewdrive
Stringmkviewoptionalparam
StringfilterOutDestroySubBranchEvent
booleanuseUpdate
booleanrmviewonrename
booleanexcludedRegions
StringmultiSitePollBuffer
StringoverrideBranchName
StringcreateDynView
booleanfreezeCode
booleanrecreateView
booleanallocateViewName
booleanviewPath
StringuseManualLoadRules
booleanchangeset
ALL, BRANCH, NONE, UPDTviewStorage
Three strategies are currently available to manage view storage location.
$class: 'DefaultViewStorage'$class: 'ServerViewStorage'assignedLabelString
Label expression used to populate view storage location dropdown.
Stringserver
The view storage location that will be passed to the -stgloc option.
The list of available servers is retrieved using cleartool lsstgloc -view
Note that auto is always available.
String$class: 'SpecificViewStorage'winStorageDir
StringunixStorageDir
StringbuildFoundationBaseline
If checked, instead of creating a view on the current stream, the job will look up the current foundation baselines for the given stream and work in readonly on these baselines. If polling is enabled, the build will be triggered every time a new foundation baseline is detected on the given stream.
boolean$class: 'CloneWorkspaceSCM'parentJobName
Stringcriteria
String$class: 'CmvcSCM'family
Stringbecome
Stringreleases
StringcheckoutScript
StringtrackViewReportWhereClause
String$class: 'ConfigurationRotator'acrs
$class: 'ClearCaseUCM'pvobName
Stringcontribute
Contribute data to a global database. Defined in the Compatibility Action Storage Plugin.
booleantargets
baselineName
Stringlevel
INITIAL, BUILT, TESTED, RELEASED, REJECTEDfixed
booleanuseNewest (optional)
boolean$class: 'Git'targets
name
Stringrepository
Stringbranch
StringcommitId
Stringfixed
booleanuseNewest (optional)
boolean$class: 'CvsProjectset'repositories
cvsRoot
StringpasswordRequired
booleanpassword
StringrepositoryItems
location
$class: 'BranchRepositoryLocation'branchName
StringuseHeadIfNotFound
boolean$class: 'HeadRepositoryLocation'$class: 'TagRepositoryLocation'tagName
StringuseHeadIfNotFound
booleanmodules
remoteName
StringlocalName
StringprojectsetFileName
StringexcludedRegions
src/main/web/.*\.html src/main/web/.*\.jpeg src/main/web/.*\.gifThe example above illustrates that if only html/jpeg/gif files have been committed to the SCM a build will not occur. More information on regular expressions can be found here.
pattern
StringcompressionLevel
intrepositoryBrowser
$class: 'FishEyeCVS'url
String$class: 'OpenGrok'url
String$class: 'ViewCVS'url
StringcanUseUpdate
booleanusername
Stringpassword
Stringbrowser
$class: 'FishEyeCVS'url
String$class: 'OpenGrok'url
String$class: 'ViewCVS'url
StringskipChangeLog
booleanpruneEmptyDirectories
booleandisableCvsQuiet
booleancleanOnFailedUpdate
booleanforceCleanCopy
boolean$class: 'DarcsScm'source
StringlocalDir
Stringclean
booleanbrowser
$class: 'DarcsWeb'url
Stringrepo
String$class: 'Darcsden'url
String$class: 'DelegateSCM'clazz
String$class: 'DimensionsSCM'project
Stringfolders
StringpathsToExclude
Stringworkarea
StringcanJobDelete
booleancanJobForce
booleancanJobRevert
booleanjobUserName
StringjobPasswd
StringjobServer
StringjobDatabase
StringcanJobUpdate
booleanjobTimeZone
StringjobWebUrl
Stringdirectory
Stringpermissions
Stringeol
StringcanJobExpand
booleancanJobNoMetadata
booleancanJobNoTouch
booleanforceAsSlave
boolean$class: 'DrushMakefileSCM'makefile
Specify the content of the Makefile. Support for YAML Makefiles depends on the version of Drush you have installed.
This example will generate a vanilla Drupal 7.38:
api=2
core=7.x
projects[drupal][version]=7.38
Stringroot
String$class: 'EndevorConfiguration'connectionId
StringfilterPattern
StringfileExtension
StringcredentialsId
StringtargetFolder
Stringfilesystempath
The file path for the source code.
e.g. \\Server1\project1\src or c:\myproject\src
Note for distributed build environment, please make sure the path is accessible on remote node(s)
StringclearWorkspace
If true, the system will delete all existing files/sub-folders in workspace before checking-out. Poll changes will not be affected by this setting.
booleancopyHidden
If true, the system will copy hidden files and folders as well. Default is false.
booleanfilterSettings
includeFilter
booleanselectors
You can apply wildcard filter(s) when detecting changes and copying files. By default, the system will filter out hidden files, on Unix, that means files/folder starting with ".", on Windows, that means files/folders with "hidden" attribute. You may want to filter out, e.g. files with ".tmp" extension.
Note: filters are applied on both sides, source and destination (i.e. the workspace). E.g. if you filter out ".tmp" files, all ".tmp" files currently in workspace will not be removed.
wildcard
ANT style wildcard.
To include just *.java, set filter type to "Include" and type add "*.java" (without quote) in the wildcard. To exclude *.exe" and all JUnit test cases, set filter type to "Exclude" and add two wildcard, one for "*.dll" and one for "*Test*"
To exclude a directory, set filter to "**/dir_to_exclude/**"
Note: (1) the wildcard is case insensitive, (2) all backslashes (\) will be replaced with slashes (/)
String$class: 'FeatureBranchAwareMercurialSCM'installation
Stringsource
Stringbranch
Stringmodules
Stringsubdir
my/sources (use forward slashes). If changing this entry, you probably want to clean the workspace first.
Stringbrowser
$class: 'BitBucket'url
String$class: 'FishEye'url
String$class: 'GoogleCode'url
String$class: 'HgWeb'url
String$class: 'Kallithea'url
String$class: 'KilnHG'url
String$class: 'RhodeCode'url
String$class: 'RhodeCodeLegacy'url
Stringclean
booleanbranchPattern
String$class: 'GeneXusServerSCM'gxInstallationId
StringserverURL
StringcredentialsId
StringkbName
StringkbVersion
StringlocalKbPath
StringlocalKbVersion
StringkbDbServerInstance
StringkbDbCredentialsId
StringkbDbName
StringkbDbInSameFolder
boolean$class: 'GitSCM'userRemoteConfigs
${SUPER_PROJECT_URL}/${SUBMODULE}, rather than relying on information from .gitmodules.url
Stringname
You normally want to specify this when you have multiple remote repositories.
Stringrefspec
In other words, the default refspec is "+refs/heads/*:refs/remotes/REPOSITORYNAME/*" where REPOSITORYNAME is the value you specify in the above "name of repository" textbox.
When do you want to modify this value? A good example is when you want to just retrieve one branch. For example, +refs/heads/master:refs/remotes/origin/master would only retrieve the master branch and nothing else.
The plugin uses a default refspec for its initial fetch, unless the "Advanced Clone Option" is set to honor refspec. This keeps 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. +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.
See the term definition in Git user manual for more details.
StringcredentialsId
Stringbranches
name
Specify the branches if you'd like to track a specific branch in a repository. If left blank, all branches will be examined for changes and built.
The safest way is to use the refs/heads/<branchName> syntax. This way the expected branch is unambiguous.
If your branch name has a / in it make sure to use the full reference above. When not presented with a full path the plugin will only use the part of the string right of the last slash. Meaning foo/bar will actually match bar
.If you use a wildcard branch specifier, with a slash (e.g. release/), you'll need to specify the origin repository in the branch names to make sure changes are picked up. So e.g. origin/release/
Possible options:
StringdoGenerateSubmoduleConfigurations
booleansubmoduleCfg
hudson.plugins.git.SubmoduleConfig
browser
$class: 'AssemblaWeb'repoUrl
String$class: 'BacklogGitRepositoryBrowser'repoName
StringrepoUrl
String$class: 'BitbucketWeb'repoUrl
String$class: 'CGit'repoUrl
String$class: 'FisheyeGitRepositoryBrowser'repoUrl
String$class: 'GitBlitRepositoryBrowser'repoUrl
StringprojectName
String$class: 'GitBucketBrowser'url
String$class: 'GitLab'repoUrl
Stringversion (optional)
String$class: 'GitList'repoUrl
String$class: 'GitWeb'repoUrl
String$class: 'GiteaBrowser'repoUrl
https://gitea.example.com then the URL for bob's skunkworks project repository might be
https://gitea.example.com/bob/skunkworks
String$class: 'GithubWeb'repoUrl
String$class: 'Gitiles'repoUrl
String$class: 'GitoriousWeb'repoUrl
String$class: 'GogsGit'repoUrl
String$class: 'KilnGit'repoUrl
String$class: 'Phabricator'repoUrl
Stringrepo
String$class: 'RedmineWeb'repoUrl
String$class: 'RhodeCode'repoUrl
String$class: 'Stash'repoUrl
String$class: 'TFS2013GitRepositoryBrowser'repoUrl
If TFS is also used as the repository server, this can usually be left blank.
String$class: 'TracGitRepositoryBrowser'$class: 'ViewGitWeb'repoUrl
StringprojectName
StringgitTool
Stringextensions
$class: 'AuthorInChangelog'$class: 'BuildChooserSetting'This extension point in Jenkins is used by many other plugins to control the job to build specific commits. When you activate those plugins, you may see them installing a custom strategy here.
buildChooser
$class: 'AlternativeBuildChooser'$class: 'AncestryBuildChooser'maximumAgeInDays
intancestorCommitSha1
String$class: 'DefaultBuildChooser'$class: 'DeflakeGitBuildChooser'$class: 'GerritTriggerBuildChooser'$class: 'InverseBuildChooser'$class: 'ChangelogToBranch'options
compareRemote
StringcompareTarget
String$class: 'CheckoutOption'timeout
int$class: 'CleanBeforeCheckout'$class: 'CleanCheckout'$class: 'CloneOption'shallow
booleannoTags
booleanreference
Stringtimeout
intdepth (optional)
inthonorRefspec (optional)
boolean$class: 'CodeCommitURLHelper'credentialId
OPTIONAL: Select the credentials to use.
If not specified, defaults to the DefaultAWSCredentialsProviderChain behaviour - *FROM THE JENKINS INSTANCE*
In the latter case, usage of IAM Role Profiles seems not to work, thus relying on environment variables / system properties or the ~/.aws/credentials file, thus not recommended.
StringrepositoryName
String$class: 'DisableRemotePoll'$class: 'GitLFSPull'$class: 'GitTagMessageExtension'useMostRecentTag (optional)
boolean$class: 'IgnoreNotifyCommit'$class: 'LocalBranch'If selected, and its 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/newfeature.
Please note that this has not been tested with submodules.
localBranch
String$class: 'MessageExclusion'excludedMessage
.*\[maven-release-plugin\].*The example above illustrates that if only revisions with "[maven-release-plugin]" message in first comment line have been committed to the SCM a build will not occur. You can create more complex patterns using embedded flag expressions.
(?s).*FOO.*This example will search FOO message in all comment lines.
String$class: 'PathRestriction'includedRegions
myapp/src/main/web/.*\.html
myapp/src/main/web/.*\.jpeg
myapp/src/main/web/.*\.gif
The example above illustrates that a build will only occur, if html/jpeg/gif files have been committed to the SCM. Exclusions take precedence over inclusions, if there is an overlap between included and excluded regions.
StringexcludedRegions
myapp/src/main/web/.*\.html
myapp/src/main/web/.*\.jpeg
myapp/src/main/web/.*\.gif
The example above illustrates that if only html/jpeg/gif files have been committed to the SCM a build will not occur.
String$class: 'PerBuildTag'$class: 'PreBuildMerge'options
mergeTarget
StringfastForwardMode (optional)
FF, FF_ONLY, NO_FFmergeRemote (optional)
StringmergeStrategy (optional)
DEFAULT, RESOLVE, RECURSIVE, OCTOPUS, OURS, SUBTREE, RECURSIVE_THEIRSpretestedIntegrationgitIntegrationStrategy
accumulatedshortCommitMessage (optional)
booleansquashintegrationBranch
The branch name must match your integration branch name. No trailing slash.
git checkout -B <Branch name> <Repository name>/<Branch name>
git merge --squash <Branch matched by git>
git commit -C <Branch matched by git>
git checkout -B <Branch name> <Repository name>/<Branch name>
git merge -m <commitMsg> <Branch matched by git> --no-ff
Changes are only ever pushed when the build results is SUCCESS
git push <Repository name> <Branch name>StringrepoName
The repository name. In git the repository is always the name of the remote. So if you have specified a repository name in your Git configuration. You need to specify the exact same name here, otherwise no integration will be performed. We do the merge based on this.
No trailing slash on repository name.
Remember to specify this when working with NAMED repositories in Git
String$class: 'PruneStaleBranch'$class: 'RelativeTargetDirectory'relativeTargetDir
String$class: 'ScmName'Unique name for this SCM. Needed when using Git within the Multi SCM plugin.
name
String$class: 'SparseCheckoutPaths'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
sparseCheckoutPaths
path
String$class: 'SubmoduleOption'disableSubmodules
booleanrecursiveSubmodules
booleantrackingSubmodules
booleanreference
git init --bare git remote add SubProject1 https://gitrepo.com/subproject1 git remote add SubProject2 https://gitrepo.com/subproject2 git fetch --all
Stringtimeout
intparentCredentials
booleandepth (optional)
intshallow (optional)
booleanthreads (optional)
int$class: 'UserExclusion'excludedUsers
auto_build_userThe example above illustrates that if only revisions by "auto_build_user" have been committed to the SCM a build will not occur.
String$class: 'UserIdentity'name
If given, "git config user.name [this]" is called before builds. This overrides whatever is in the global settings.
Stringemail
If given, "git config user.email [this]" is called before builds. This overrides whatever is in the global settings.
String$class: 'WipeWorkspace'$class: 'HarvestSCM'broker
StringpasswordFile
StringuserId
Stringpassword
StringprojectName
Stringstate
StringviewPath
StringclientPath
StringprocessName
StringrecursiveSearch
StringuseSynchronize
booleanextraOptions
String$class: 'IspwConfiguration'connectionId
StringcredentialsId
StringserverConfig
StringserverStream
StringserverApplication
StringserverLevel
StringlevelOption
StringcomponentType
StringfolderName
StringispwDownloadAll
boolean$class: 'IspwContainerConfiguration'connectionId
StringcredentialsId
StringserverConfig
StringcontainerName
StringcontainerType
StringserverLevel
StringcomponentType
StringispwDownloadAll
boolean$class: 'MercurialSCM'source
Stringbrowser (optional)
$class: 'BitBucket'url
String$class: 'FishEye'url
String$class: 'GoogleCode'url
String$class: 'HgWeb'url
String$class: 'Kallithea'url
String$class: 'KilnHG'url
String$class: 'RhodeCode'url
String$class: 'RhodeCodeLegacy'url
Stringclean (optional)
booleancredentialsId (optional)
StringdisableChangeLog (optional)
booleaninstallation (optional)
Stringmodules (optional)
Stringrevision (optional)
default branch.)
StringrevisionType (optional)
BRANCH, TAG, CHANGESET, REVSETsubdir (optional)
my/sources (use forward slashes). If changing this entry, you probably want to clean the workspace first.
String$class: 'MergeBotUpdater'$class: 'MultiSCM'$class: 'OpenShiftImageStreams'imageStreamName
Stringtag
StringapiURL
Stringnamespace
StringauthToken
Stringverbose
String$class: 'PdsConfiguration'connectionId
StringfilterPattern
StringfileExtension
StringcredentialsId
StringtargetFolder
String$class: 'PerforceSCM'p4User
Stringp4Passwd
Stringp4Client
Stringp4Port
StringprojectOptions
Stringp4Tool
Stringp4SysRoot
Stringp4SysDrive
Stringp4Label
Stringp4Counter
Stringp4UpstreamProject
StringlineEndValue
Stringp4Charset
Stringp4CommandCharset
StringclientOwner
StringupdateCounterValue
booleanforceSync
booleandontUpdateServer
booleanalwaysForceSync
booleancreateWorkspace
booleanupdateView
booleandisableChangeLogOnly
booleandisableSyncOnly
booleanshowIntegChanges
booleandontUpdateClient
booleanexposeP4Passwd
booleanpollOnlyOnMaster
booleanslaveClientNameFormat
StringfirstChange
intfileLimit
intbrowser
$class: 'FishEyePerforce'url
StringrootModule
String$class: 'P4Web'url
String$class: 'Perfbrowse'url
StringexcludedUsers
StringexcludedFiles
StringexcludedFilesCaseSensitivity
booleandepotType
value
Stringp4Stream
StringclientSpec
StringprojectPath
StringcleanWorkspace
cleanType
value
StringrestoreChangedDeletedFiles
booleanwipeRepoBeforeBuild
booleanuseViewMask
viewMask
StringuseViewMaskForPolling
booleanuseViewMaskForSyncing
booleanuseViewMaskForChangeLog
booleanperforcecredential
Select the appropriate credential for the Perforce connection. Perforce Credentials are defined in the Jenkins Credentials plugin here.
There are two types:
Stringworkspace
Select the appropriate Perforce workspace behaviour from the list. Not all modes will suit all Jenkins Job build types.
There are five types:
manualSpeccharset
The character set used by Jenkins when syncing files from the Perforce server. This should be set to 'none' unless connected to a Unicode enabled Perforce server.
StringpinHost
booleanname
Specify the name of the Perforce workspace to be used as the Jenkins build workspace. If the workspace does not yet exist, the configuration will be saved in Jenkins; the workspace is created only when it is to be used. If the workspace exists and you are connected to a Perforce server the auto-text fill should list suitable workspaces; updates are only applied when the workspace is used.
Stringspec
allwrite
booleanclobber
booleancompress
booleanlocked
booleanmodtime
booleanrmdir
booleanstreamName
Stringline
Set line-ending character(s) for client text files.
linefeed: UNIX style.
carriage return: Macintosh style. (obsolete)
carriage return-linefeed: Windows style.
hybrid: writes UNIX style but reads UNIX, Mac or Windows style.
Stringview
Lines to map depot files into the client workspace.
Maps files in the depot to files in your client workspace. Defines the files that you want in your client workspace and specifies where you want them to reside. The default view maps all depot files onto the client. See 'p4 help views' for view syntax. A new view takes effect on the next 'p4 sync'.
StringchangeView
Stringtype
Type of client: writeable/readonly/partitioned/graph
By default all clients are 'writeable', certain clients are short lived and perform long sync and build cycles. Over time these build clients can fragment the 'db.have' table which is used to track what files a client has synced. Setting a type of 'readonly' gives the client its own personal 'db.have' database table. A 'readonly' client cannot 'edit' or 'submit' files, however for build automation this is not usually a requirement and the performance tradeoff is worth considering if your build automation is causing issues with the 'db.have' table. This option requires that an administrator has first configured the 'client.readonly.dir' setting. If it is necessary to submit changes as part of your build, you may specify a 'partitioned' client: like a 'reaonly' client, this type also has a separate 'db.have' table under the 'client.readonly.dir' directory, but allows journalled 'edit' and 'submit' of files.
StringserverID
Stringbackup
Client's participation in backup enable/disable. If not specified backup of a writable client defaults to enabled.
booleancleanup
booleansyncID (optional)
StringspecFileSpeccharset
The character set used by Jenkins when syncing files from the Perforce server. This should be set to 'none' unless connected to a Unicode enabled Perforce server.
StringpinHost
booleanname
Specify the name of the Perforce workspace to be used as the Jenkins build workspace. If the workspace does not yet exist, the configuration will be saved in Jenkins; the workspace is created only when it is to be used. If the workspace exists and you are connected to a Perforce server the auto-text fill should list suitable workspaces; updates are only applied when the workspace is used.
StringspecPath
StringsyncID (optional)
StringstaticSpeccharset
The character set used by Jenkins when syncing files from the Perforce server. This should be set to 'none' unless connected to a Unicode enabled Perforce server.
StringpinHost
booleanname
Specify the name of an existing workspace in Perforce to be used as the Jenkins build workspace. If connected to a Perforce server the auto-text fill should list suitable workspaces
StringsyncID (optional)
StringstreamSpeccharset
The character set used by Jenkins when syncing files from the Perforce server. This should be set to 'none' unless connected to a Unicode enabled Perforce server.
StringpinHost
booleanstreamName
Specify the full Perforce depot path for the given stream. If connected to a Perforce server the auto-text fill should list possible streams.
For example: //stream-depot/main-streamStringformat
Jenklin slave nodes must each use a unique Perforce workspace. The format string configures the workspace name by substituting the specified variables: (at least one variable must be used)
Variables can be taken from the Jenkins Environment or Parameterized builds
StringsyncID (optional)
StringtemplateSpeccharset
The character set used by Jenkins when syncing files from the Perforce server. This should be set to 'none' unless connected to a Unicode enabled Perforce server.
StringpinHost
booleantemplateName
Specify the name of an existing workspace in Perforce used to create or update a Jenkins build workspace. If connected to a Perforce server the auto-text fill should list suitable workspaces
Stringformat
Jenklin slave nodes must each use a unique Perforce workspace. The format string configures the workspace name by substituting the specified variables: (at least one variable must be used)
Variables can be taken from the Jenkins Environment or Parameterized builds
StringsyncID (optional)
Stringfilter
pathFilterpath
Changes can be filtered to not trigger a build; if all the files within a change match the specified path, the build is filtered.
For example, with a Filter of " //depot/main/tests ":
Case A (change will be filtered):
Files:
//depot/main/tests/index.xml //depot/main/tests/001/test.xml //depot/main/tests/002/test.xml Case B (change will not be filtered, as build.xml is outside of the filter):
Files:
//depot/main/src/build.xml //depot/main/tests/004/test.xml //depot/main/tests/005/test.xml This is not Perforce syntax. Use of ... and * patterns are not supported. Only paths to directories are supported.
StringviewPatternpatternText
Changes can be filtered to not trigger a build; if none of the files within a change match a Java pattern (regular expression) listed, the build is filtered.
For example, with the following regular expressions:
//depot/main/tests.*
//depot/main/src/.*\.cpp
//depot/main/build/.*(?:\.rb|\.py|\.bat|Jenkinsfile)
//depot/main/lib/(?!Lib1|Lib2).*
Case A (change will not be filtered, as these files match our first pattern on "tests"):
Files:
//depot/main/tests/CONTRIUBTING.md //depot/main/tests/001/index.xml Case B (Be careful with incomplete file paths! Change will NOT be filtered,
as this file matches a pattern which was likely intended as describing a "tests/" directory.)
Files:
//depot/main/tests.doc Case C (change will NOT be filtered, as all files match our fourth pattern looking for script files in 'build/'):
Files:
//depot/main/build/rbs/deploy_server.rb //depot/main/build/deploy/deploy.bat //depot/main/build/Jenkinsfile Case D (change will be filtered, as no file matches our second pattern for ".cpp" files under "main/src"):
Files:
//depot/main/src/howto.doc //depot/main/src/oldmain.c //depot/main/src/art/splash.bmp //depot/main/src/bt/funnelcake.php Case E (change will be filtered. Lib1 is included in a negative lookahead, and thus is excluded.)
Files:
//depot/main/lib/Lib1/build.xml StringcaseSensitive
booleanincrementalperChange
booleanuserFilteruser
Changes can be filtered to not trigger a build; if the owner of a change matches the specified name, the build is filtered.
StringviewFilterviewMask
Changes can be filtered to not trigger a build; if none of the files within a change are contained in the view mask, the build is filtered.
For example, with a View Mask Filter of:
//depot/main/tests
-//depot/main/tests/001
Case A (change will not be filtered, as index.xml is in the view mask):
Files:
//depot/main/tests/index.xml //depot/main/tests/001/test.xml Case B (change will not be filtered, as index.xml is in the view mask):
Files:
//depot/main/test/index.xml //depot/main/src/build.xml Case C (change will be filtered, as no file is in the view mask):
Files:
//depot/main/src/build.xml Case D (change will be filtered, as no file is in the view mask):
Files:
//depot/main/src/build.xml //depot/main/tests/001/test.xml Stringpopulate
Perforce will populate the workspace with the file revisions needed for the build. The different options effect the way the workspace is cleaned and the file revisions are updated.
There are three options:
autoCleanreplace
Perforce will check out and overwrite any depot files which are either missing from workspace, or have been modified locally.
booleandelete
Perforce will delete any local files that are not in the depot.
booleantidy
booleanmodtime
booleanquiet
Enables the -q flag for all applicable Perforce operations. Summary details will still be displayed.
booleanpin
When a build is triggered by Polling, Build Now or an external Action, the workspace will sync only to the specified label. Any other specified change or label will be ignored.
Supports variable expansion e.g. ${VAR}. If 'now' is used, or a variable that expands to 'now', then the latest change is used (within the scope of the workspace view).
Stringparallel
enable
booleanpath
Stringthreads
Stringminfiles
Stringminbytes
StringpreviewOnlyquiet
Enables the -q flag for all applicable Perforce operations. Summary details will still be displayed.
booleanpin
StringflushOnlyquiet
booleanpin
When a build is triggered by Polling, Build Now or an external Action, the workspace will flush only to the specified label or changelist number. Any other specified change or label will be ignored.
Supports variable expansion e.g. ${VAR}. If 'now' is used, or a variable that expands to 'now', then the latest change is used (within the scope of the workspace view).
StringforceCleanhave
booleanquiet
Enables the -q flag for all applicable Perforce operations. Summary details will still be displayed.
booleanpin
When a build is triggered by Polling, Build Now or an external Action, the workspace will sync only to the specified label. Any other specified change or label will be ignored.
Supports variable expansion e.g. ${VAR}. If 'now' is used, or a variable that expands to 'now', then the latest change is used (within the scope of the workspace view).
Stringparallel
enable
booleanpath
Stringthreads
Stringminfiles
Stringminbytes
StringgraphCleanquiet
Enables the -q flag for all applicable Perforce operations. Summary details will still be displayed.
booleanpin
When a build is triggered by Polling, Build Now or an external Action, the workspace will sync only to the specified label. Any other specified change or label will be ignored.
Supports variable expansion e.g. ${VAR}. If 'now' is used, or a variable that expands to 'now', then the latest change is used (within the scope of the workspace view).
Stringparallel
enable
booleanpath
Stringthreads
Stringminfiles
Stringminbytes
StringsyncOnlyrevert
booleanhave
booleanforce
booleanmodtime
booleanquiet
Enables the -q flag for all applicable Perforce operations. Summary details will still be displayed.
booleanpin
When a build is triggered by Polling, Build Now or an external Action, the workspace will sync only to the specified label. Any other specified change or label will be ignored.
Supports variable expansion e.g. ${VAR}. If 'now' is used, or a variable that expands to 'now', then the latest change is used (within the scope of the workspace view).
Stringparallel
enable
booleanpath
Stringthreads
Stringminfiles
Stringminbytes
Stringbrowser
fishEyeurl
StringrootModule
StringopenGrokurl
StringdepotPath
StringprojectName
Stringp4Weburl
Stringswarmurl
String$class: 'PlasticSCM'selector
StringworkspaceName
StringuseUpdate
booleanuseMultipleWorkspaces
booleanadditionalWorkspaces
selector
StringworkspaceName
StringuseUpdate
boolean$class: 'ProxySCM'projectName
String$class: 'PvcsScm'projectRoot
StringarchiveRoot
StringchangeLogPrefixFudge
StringmoduleDir
StringloginId
StringpvcsWorkspace
StringpromotionGroup
StringversionLabel
StringcleanCopy
boolean$class: 'RTCScm'overrideGlobal
The build toolkit location and Jazz Repository connection can be defined globally or overridden. If not defined globally, it must be overridden.
booleanbuildTool
The RTC build toolkit to use when performing builds. The toolkits available are defined in the system configuration (with the other tools like Ant and Java). The build toolkit is also necessary on the Master for polling and validating the job configuration unless the "Avoid using build toolkit on Master" option is enabled.
StringserverURI
The Jazz Repository connection URI for the Rational Team Concert (RTC) server
Stringtimeout
The timeout period in seconds for Jazz repository requests made during the build.
intuserId
The build user id. Either credentials or a user id and password information should be supplied.
Stringpassword
The Jazz Repository password for the build user. The use of a password is not secure, it can be easily discovered by anyone with access to this page. Credentials, a password file or a password should be supplied.
hudson.util.Secret
passwordFile
The path to the file containing the obfuscated Jazz Repository password for the build user. Credentials, a password file or a password should be supplied.
StringcredentialsId
Credentials to use for the build user. A user name and password credential for the Jazz Repository should be configured.
StringbuildType
value
StringbuildDefinition
StringbuildWorkspace
StringbuildSnapshot
StringbuildStream
StringacceptBeforeLoad (optional)
booleanbuildSnapshotContext (optional)
snapshotOwnerType
StringprocessAreaOfOwningStream
StringowningStream
StringowningWorkspace
StringclearLoadDirectory (optional)
booleancomponentLoadConfig (optional)
StringcomponentsToExclude (optional)
StringcreateFoldersForComponents (optional)
booleancurrentSnapshotOwnerType (optional)
StringcustomizedSnapshotName (optional)
StringgenerateChangelogWithGoodBuild (optional)
booleanloadDirectory (optional)
StringloadPolicy (optional)
StringoverrideDefaultSnapshotName (optional)
booleanpathToLoadRuleFile (optional)
StringprocessArea (optional)
StringuseDynamicLoadRules (optional)
booleanavoidUsingToolkit
Where possible avoid using the Build toolkit when performing tasks on the Master. This is still in the experimental stage. You will require an RTC 5.0 server which provides some of the services used.
The Build toolkit will not be used when polling RTC and terminating the RTC Build. The toolkit is still required though. It is used for other configuration tasks on the Master (i.e. validating the connection to RTC, the build definition or workspace). It is also used for checkout tasks typically performed on slave nodes.
boolean$class: 'SCLMSCM'server
Stringport
intcredentialsId
StringJESINTERFACELEVEL1
booleanproject
Stringalternate
Stringgroup
Stringtypes
StringcustJobStep
booleanJobStep
StringcustJobHeader
booleanJobHeader
String$class: 'ShellScriptSCM'checkoutShell
Stringpolling