io.jenkins.plugins.checks.github

类 SCMFacade

java.lang.Object

io.jenkins.plugins.checks.github.SCMFacade

public class SCMFacade
extends Object

Facade to GitHubSCMSource and GitSCM in Jenkins. Used for finding a supported SCM of a job.

构造器概要

构造器

构造器和说明
SCMFacade()

方法概要

限定符和类型	方法和说明
Optional<org.jenkinsci.plugins.github_branch_source.GitHubAppCredentials>	findGitHubAppCredentials(Job<?,?> job, String credentialsId) Find GitHubAppCredentials with the credentialsId used by the job.
Optional<org.jenkinsci.plugins.github_branch_source.GitHubSCMSource>	findGitHubSCMSource(Job<?,?> job) Find GitHubSCMSource (or GitHub repository) used by the job.
Optional<hudson.plugins.git.GitSCM>	findGitSCM(Run<?,?> run) Finds the GitSCM used by the run.
Optional<String>	findHash(jenkins.scm.api.SCMRevision revision) Find the hash value in revision.
Optional<jenkins.scm.api.SCMHead>	findHead(Job<?,?> job) Find SCMHead (or branch) used by the job.
Optional<jenkins.scm.api.SCMRevision>	findRevision(org.jenkinsci.plugins.github_branch_source.GitHubSCMSource source, Run<?,?> run) Find the current SCMRevision of the source and run locally through SCMRevisionAction.
Optional<jenkins.scm.api.SCMRevision>	findRevision(jenkins.scm.api.SCMSource source, jenkins.scm.api.SCMHead head) Fetch the current SCMRevision used by the head of the source.
jenkins.scm.api.SCMSource	findSCMSource(Job<?,?> job) Find GitHubSCMSource (or GitHub repository) used by the job.
SCM	getScm(Job<?,?> job) Returns the SCM in a given job.
SCM	getScm(Run<?,?> run) Returns the SCM in a given build.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

SCMFacade

public SCMFacade()

方法详细资料

findSCMSource

@CheckForNull
public jenkins.scm.api.SCMSource findSCMSource(Job<?,?> job)

Find GitHubSCMSource (or GitHub repository) used by the job.

参数:

job - the Jenkins project

返回:

the found GitHub SCM source used or empty

findGitHubSCMSource

public Optional<org.jenkinsci.plugins.github_branch_source.GitHubSCMSource> findGitHubSCMSource(Job<?,?> job)

Find GitHubSCMSource (or GitHub repository) used by the job.

参数:

job - the Jenkins project

返回:

the found GitHub SCM source used or empty

findGitSCM

public Optional<hudson.plugins.git.GitSCM> findGitSCM(Run<?,?> run)

Finds the GitSCM used by the run.

参数:

run - the run to get the SCM from

返回:

the found GitSCM or empty

findGitHubAppCredentials

public Optional<org.jenkinsci.plugins.github_branch_source.GitHubAppCredentials> findGitHubAppCredentials(Job<?,?> job,
                                                                                                          String credentialsId)

Find GitHubAppCredentials with the credentialsId used by the job.

参数:

job - the Jenkins project

credentialsId - the id of the target credentials

返回:

the found GitHub App credentials or empty

findHead

public Optional<jenkins.scm.api.SCMHead> findHead(Job<?,?> job)

Find SCMHead (or branch) used by the job.

参数:

job - the Jenkins project

返回:

the found SCM head or empty

findRevision

public Optional<jenkins.scm.api.SCMRevision> findRevision(jenkins.scm.api.SCMSource source,
                                                          jenkins.scm.api.SCMHead head)

Fetch the current SCMRevision used by the head of the source.

参数:

source - the GitHub repository

head - the branch

返回:

the fetched revision or empty

findRevision

public Optional<jenkins.scm.api.SCMRevision> findRevision(org.jenkinsci.plugins.github_branch_source.GitHubSCMSource source,
                                                          Run<?,?> run)

Find the current SCMRevision of the source and run locally through SCMRevisionAction.

参数:

source - the GitHub repository

run - the Jenkins run

返回:

the found revision or empty

findHash

public Optional<String> findHash(jenkins.scm.api.SCMRevision revision)

Find the hash value in revision.

参数:

revision - the revision for a build

返回:

the found hash or empty

getScm

public SCM getScm(Run<?,?> run)

Returns the SCM in a given build. If no SCM can be determined, then a NullSCM instance will be returned.

参数:

run - the build to get the SCM from

返回:

the SCM

getScm

public SCM getScm(Job<?,?> job)

Returns the SCM in a given job. If no SCM can be determined, then a NullSCM instance will be returned.

参数:

job - the job to get the SCM from

返回:

the SCM