class PipelineBuilder extends java.lang.Object
Modifiers | Name | Description |
---|---|---|
class |
PipelineBuilder.Validator |
Validates user provided configuration against the defined schema using a tool called ajv (Another JSON Validator). |
Type | Name and description |
---|---|
java.util.List |
allowedActions List of stage actions (publish, promote, trigger, etc.) allowed during this build. |
java.lang.String |
configPath Path to the project's pipeline configuration file. |
java.util.Map |
runnerOverrides Additional PipelineRunner properties to set. |
Constructor and description |
---|
PipelineBuilder
(java.util.Map overrides = [:], java.lang.String pipelineConfigPath, java.util.List allowedActions = null) Constructs a new {@PipelineBuilder} from the given YAML configuration. |
Type Params | Return Type | Name and description |
---|---|---|
|
void |
build(java.lang.Object ws, java.lang.Object pipelineName = "") Builds a single-node Jenkins workflow script for each of the configured pipelines. |
|
java.util.List |
pipelines(java.lang.Object cfg) Constructs and returns all pipelines from the given configuration. |
Methods inherited from class | Name |
---|---|
class java.lang.Object |
java.lang.Object#wait(long), java.lang.Object#wait(long, int), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll() |
List of stage actions (publish, promote, trigger, etc.) allowed during this build.
Path to the project's pipeline configuration file.
Additional PipelineRunner properties to set.
Constructs a new {@PipelineBuilder} from the given YAML configuration.
overrides
- Named parameters used to override properties of the
PipelineRunner during execution. See
runnerOverrides.pipelineConfigPath
- Path to the pipeline configuration relative to
the project's root directory.allowedActions
- List of stage actions allowed during this
build. If null is passed, all actions are allowed. Builds a single-node Jenkins workflow script for each of the configured
pipelines.
If a pipeline defines any branching arcs in its directed
execution
graph, they will be iterated over concurrently—in
the order that ExecutionGraph.executions returns—and their
stages defined as parallel
stages in the workflow script.
ws
- Jenkins Workflow Script (`this` when writing a Jenkinsfile)pipelineName
- Only build/run the given pipeline.Constructs and returns all pipelines from the given configuration.
Groovy Documentation