public abstract class SCMListener extends Object implements ExtensionPoint
This is an abstract class so that methods added in the future won't break existing listeners.
Once instantiated, use the
register() method to start receiving events.
|Constructor and Description|
|Modifier and Type||Method and Description|
Called once the changelog is determined.
Should be called immediately after
public void onCheckout(Run<?,?> build, SCM scm, FilePath workspace, TaskListener listener, @CheckForNull File changelogFile, @CheckForNull SCMRevisionState pollingBaseline) throws Exception
SCM.checkout(Run, Launcher, FilePath, TaskListener, File, SCMRevisionState)is called.
pollingBaseline- information about what actually was checked out, if that is available, and this checkout is intended to be included in the build’s polling (if it does any at all)
Exception- if the checkout should be considered failed
public void onChangeLogParsed(Run<?,?> build, SCM scm, TaskListener listener, ChangeLogSet<?> changelog) throws Exception
During a build, Jenkins fetches the update of the workspace from SCM,
and determines the changelog (see
SCM.checkout(hudson.model.Run<?, ?>, hudson.Launcher, hudson.FilePath, hudson.model.TaskListener, java.io.File, hudson.scm.SCMRevisionState)). Immediately
after that, a build will invoke this method on all registered
If a build failed before we successfully determine changelog, this method will not be invoked (for example, if "cvs update" failed.) OTOH, this method is invoked before the actual build (like ant invocation) happens.
This is an opportunity for SCM-related plugins to act on changelog.
A typical usage includes parsing commit messages and do cross-referencing
between other systems. Implementations can also contribute
display additional data on build views.
TODO: once we have cvsnews plugin, refer to its usage.
build- The build in progress, which just finished determining changelog. At this point this build is still in progress. Never null.
BuildListenerfor on-going build. This can be used to report any errors or the general logging of what's going on. This will show up in the "console output" of the build. Never null.
changelog- Set of changes detected in this build. This is the same value returned from
AbstractBuild.getChangeSet()but passed separately for convenience.
Exception- If any exception is thrown from this method, it will be recorded and causes the build to fail.
@Deprecated public void onChangeLogParsed(AbstractBuild<?,?> build, BuildListener listener, ChangeLogSet<?> changelog) throws Exception
@Deprecated public final void register()
@Deprecated public final boolean unregister()
Copyright © 2004–2021. All rights reserved.