public class BuildTrigger extends Recorder implements DependencyDeclarer
Despite what the name suggests, this class doesn't actually trigger other jobs
as a part of perform(hudson.model.AbstractBuild, hudson.Launcher, hudson.model.BuildListener)
method. Its main job is to simply augment
DependencyGraph
. Jobs are responsible for triggering downstream jobs
on its own, because dependencies may come from other sources.
This class, however, does provide the execute(AbstractBuild, BuildListener, BuildTrigger)
method as a convenience method to invoke downstream builds.
Its counterpart is ReverseBuildTrigger
.
Modifier and Type | Class and Description |
---|---|
static class |
BuildTrigger.DescriptorImpl |
Publisher.DescriptorExtensionListImpl
ExtensionPoint.LegacyInstancesAreScopedToHudson
BuildStep.PublisherList
BUILDERS, PUBLISHERS
Constructor and Description |
---|
BuildTrigger(Collection<? extends AbstractProject> childProjects,
Result threshold) |
BuildTrigger(List<AbstractProject> childProjects,
Result threshold) |
BuildTrigger(String childProjects,
boolean evenIfUnstable) |
BuildTrigger(String childProjects,
Result threshold) |
BuildTrigger(String childProjects,
String threshold) |
Modifier and Type | Method and Description |
---|---|
void |
buildDependencyGraph(AbstractProject owner,
DependencyGraph graph)
Invoked from
AbstractProject.buildDependencyGraph(DependencyGraph) . |
static boolean |
execute(AbstractBuild build,
BuildListener listener)
Convenience method to trigger downstream builds.
|
static boolean |
execute(AbstractBuild build,
BuildListener listener,
BuildTrigger trigger)
Deprecated.
since 1.341; use
execute(AbstractBuild,BuildListener) |
List<Job<?,?>> |
getChildJobs(AbstractProject<?,?> owner) |
List<AbstractProject> |
getChildProjects()
Deprecated.
as of 1.406
Use
getChildProjects(ItemGroup) |
List<AbstractProject> |
getChildProjects(AbstractProject owner)
Deprecated.
|
List<AbstractProject> |
getChildProjects(ItemGroup base)
Deprecated.
|
String |
getChildProjectsValue() |
BuildStepMonitor |
getRequiredMonitorService()
Declares the scope of the synchronization monitor this
BuildStep expects from outside. |
Result |
getThreshold() |
boolean |
hasSame(AbstractProject owner,
Collection<? extends AbstractProject> projects)
Deprecated.
apparently unused
|
boolean |
hasSame(Collection<? extends AbstractProject> projects)
Deprecated.
as of 1.406
Use
hasSame(AbstractProject, Collection) |
boolean |
needsToRunAfterFinalized()
Return true if this
Publisher needs to run after the build result is
fully finalized. |
boolean |
onJobRenamed(String oldName,
String newName)
Deprecated.
Does not handle folder moves.
|
boolean |
perform(AbstractBuild build,
Launcher launcher,
BuildListener listener)
Runs the step over the given build and reports the progress to the listener.
|
getDescriptor
all, getProjectAction, prebuild
getProjectAction, getProjectActions, perform, prebuild
public BuildTrigger(String childProjects, boolean evenIfUnstable)
public BuildTrigger(List<AbstractProject> childProjects, Result threshold)
public BuildTrigger(Collection<? extends AbstractProject> childProjects, Result threshold)
public String getChildProjectsValue()
public Result getThreshold()
@Deprecated public List<AbstractProject> getChildProjects()
getChildProjects(ItemGroup)
@Deprecated public List<AbstractProject> getChildProjects(AbstractProject owner)
getChildJobs(hudson.model.AbstractProject<?, ?>)
@Deprecated public List<AbstractProject> getChildProjects(ItemGroup base)
@NonNull public List<Job<?,?>> getChildJobs(@NonNull AbstractProject<?,?> owner)
public BuildStepMonitor getRequiredMonitorService()
BuildStep
BuildStep
expects from outside.
This method is introduced for preserving compatibility with plugins written for earlier versions of Hudson, which never run multiple builds of the same job in parallel. Such plugins often assume that the outcome of the previous build is completely available, which is no longer true when we do concurrent builds.
To minimize the necessary code change for such plugins, BuildStep
implementations can request
Hudson to externally perform synchronization before executing them. This behavior is as follows:
BuildStepMonitor.BUILD
BuildStep
is only executed after the previous build is fully
completed (thus fully restoring the earlier semantics of one build at a time.)
BuildStepMonitor.STEP
BuildStep
is only executed after the same step in the previous build is completed.
For build steps that use a weaker assumption and only rely on the output from the same build step of
the early builds, this improves the concurrency.
BuildStepMonitor.NONE
CheckPoint
s
to perform necessary synchronizations.
If you are migrating BuildStep
implementations written for earlier versions of Hudson,
here's what you can do:
Run.getPreviousBuild()
), then you can return BuildStepMonitor.NONE
without making further
code changes and you are done with migration.
Action
s that you added in the previous build by yourself,
then you only need BuildStepMonitor.STEP
scope synchronization. Return it from this method
,and you are done with migration without any further code changes.
BuildStepMonitor.NONE
and use
CheckPoint
s directly in your code. The general idea is to call CheckPoint.block()
before
you try to access the state from the previous build.
getRequiredMonitorService
in interface BuildStep
@Deprecated public boolean hasSame(AbstractProject owner, Collection<? extends AbstractProject> projects)
@Deprecated public boolean hasSame(Collection<? extends AbstractProject> projects)
hasSame(AbstractProject, Collection)
public boolean perform(AbstractBuild build, Launcher launcher, BuildListener listener)
BuildStep
A plugin can contribute the action object to Actionable.getActions()
so that a 'report' becomes a part of the persisted data of Build
.
This is how JUnit plugin attaches the test report to a build page, for example.
When this build step needs to make (direct or indirect) permission checks to ACL
(for example, to locate other projects by name, build them, or access their artifacts)
then it must be run under a specific Authentication
.
In such a case, the implementation should check whether Jenkins.getAuthentication2()
is ACL.SYSTEM2
,
and if so, replace it for the duration of this step with Jenkins.ANONYMOUS
.
(Either using ACL.impersonate2(org.springframework.security.core.Authentication)
, or by making explicit calls to ACL.hasPermission2(Authentication, Permission)
.)
This would typically happen when no QueueItemAuthenticator
was available, configured, and active.
perform
in interface BuildStep
perform
in class BuildStepCompatibilityLayer
SimpleBuildStep.perform(Run, FilePath, Launcher, TaskListener)
if possible, always returning true or throwing an error.@Deprecated public static boolean execute(AbstractBuild build, BuildListener listener, BuildTrigger trigger)
execute(AbstractBuild,BuildListener)
public static boolean execute(AbstractBuild build, BuildListener listener)
build
- The current build. Its downstreams will be triggered.listener
- Receives the progress report.public void buildDependencyGraph(AbstractProject owner, DependencyGraph graph)
DependencyDeclarer
AbstractProject.buildDependencyGraph(DependencyGraph)
.buildDependencyGraph
in interface DependencyDeclarer
owner
- The project that owns the publishers, builders, etc.
This information is conceptually redundant, as those objects are
only configured against the single owner, but this information is
nevertheless passed in since often owner information is not recorded.
Never null.graph
- The dependency graph being built. Never null.public boolean needsToRunAfterFinalized()
Publisher
Publisher
needs to run after the build result is
fully finalized.
The execution of normal Publisher
s are considered within a part
of the build. This allows publishers to mark the build as a failure, or
to include their execution time in the total build time.
So normally, that is the preferable behavior, but in a few cases
this is problematic. One of such cases is when a publisher needs to
trigger other builds, which in turn need to see this build as a
completed build. Those plugins that need to do this can return true
from this method, so that the BuildStepCompatibilityLayer.perform(AbstractBuild, Launcher, BuildListener)
method is called after the build is marked as completed.
When Publisher
behaves this way, note that they can no longer
change the build status anymore.
needsToRunAfterFinalized
in class Publisher
@Deprecated public boolean onJobRenamed(String oldName, String newName)
Copyright © 2004–2021. All rights reserved.