Field Detail

• private final java.lang.String gerritEndpoint

• private final java.lang.String gerritPermissions

• private final java.lang.String gerritPermissionsWithReview

• private final int gerritPort

• private final java.lang.String gerritUser

• private final java.lang.String scmCodeReviewEnabled

• private final java.lang.String scmGerritCloneUser

• private final java.lang.String scmGerritServerProfile

• private final java.lang.String scmHost

• private final int scmPort

• private final GerritSCMProtocol scmProtocol

Constructor Detail

• GerritSCMProvider(java.lang.String scmHost, int scmPort, GerritSCMProtocol scmProtocol, java.lang.String scmGerritServerProfile, java.lang.String scmGerritCloneUser, java.lang.String scmCodeReviewEnabled, java.lang.String gerritEndpoint, java.lang.String gerritUser, int gerritPort, java.lang.String gerritPermissions, java.lang.String gerritPermissionsWithReview)

  Constructor for class GerritSCMProvider.

  throws:

  IllegalArgumentException If SCM protocol is equal to GerritSCMProtocol.SSH and the Gerrit clone user has not been provided. If Gerrit server profile is not set.

  Parameters:

  scmHost - scm url e.g. 10.0.0.1, gerrit.adop.example

  scmPort - scm port

  scmProtocol - scm clone protocol

  scmGerritProfile - scm Gerrit profile

  scmGerritCloneUser - scm gerrit clone user. Must be set of the SCM protocol is set to SSH.

  scmCodeReviewEnabled - true if code reviewed enabled else false.

  gerritEndpoint - gerrit host endpoint.

  gerritUser - gerrit API user.

  gerritPort - gerrit API port.

  gerritPermissions - gerrit permissions repository name.

  gerritPermissionsWithReview - gerrit permissions with review repository name.

Method Detail

• void createScmRepos(java.lang.String workspace, java.lang.String repoNamespace, java.lang.String codeReviewEnabled, java.lang.String overwriteRepos)

  Creates relevant repositories defined by your cartridge in your chosen SCM provider

  Parameters:

  workspace - Workspace of the cartridge loader job

  namespace - Location in your SCM provider where your repositories will be created

  overwriteRepos - Whether the contents of your created repositories are over-written or not

• groovy.lang.Closure get(java.lang.String projectName, java.lang.String repoName, java.lang.String branchName, java.lang.String credentialId, groovy.lang.Closure extras)

  Return SCM section.

  Parameters:

  projectName - - name of the project.

  repoName - - name of the repository to clone.

  branchName - - name of branch.

  credentialId - - name of the credential in the Jenkins credential manager to use.

  extras - - extra closures to add to the SCM section.

  Returns:

  a closure representation of the SCM providers SCM section.

• @java.lang.Override groovy.lang.Closure getMultibranch(java.lang.String projectName, java.lang.String repoName, java.lang.String credentialId, groovy.lang.Closure extras)

  Return a closure representation of the SCM section for multibranch pipelines.

  Parameters:

  projectName - - name of the project.

  repoName - - name of the repository to checkout.

  credentialId - - name of the credential in the Jenkins credential manager to use.

  extras - - extra closures to add to the multibranch SCM section.

  Returns:

  a closure representation of the SCM providers multibranch SCM section.

• java.lang.String getScmGerritProfile()

  Returns a String representation of the Gerrit server profile name.

  Returns:

  a String representation of the Gerrit server profile name.

• java.lang.String getScmUrl()

  Return Gerrit SCM URL.

  throws:

  IllegalArgumentException If the SCM protocol type is not supported.

  Returns:

  SCM url for the provider. e.g. Gerrit-SSH ssh://jenkins@10.0.0.0:22/ Gerrit-HTTP http://10.0.0.0:80/

• groovy.lang.Closure trigger(java.lang.String projectName, java.lang.String repoName, java.lang.String branchName)

  Return a closure representation of the SCM providers trigger SCM section.

  Parameters:

  projectName - - project name.

  repoName - - repository name.

  branchName - - branch name to trigger.

  Returns:

  a closure representation of the SCM providers trigger SCM section.