Extension Points defined in Pipeline: Groovy Plugin

Table of Contents

GlobalVariable
GlobalVariableSet
GroovySample
GroovyShellDecorator
GroovySourceFileAllowlist
OriginalLoadedScripts
SnippetizerLink
StepDescriptorCache

GlobalVariable

org.jenkinsci.plugins.workflow.cps.GlobalVariable in workflow-cps

Defines a provider of a global variable offered to flows. Within a given flow execution, the variable is assumed to be a singleton. It is created on demand if the script refers to it by name.

Note: This extension point was designed for a handful of variables defined by generic Pipeline plugins. If you find yourself implementing this in a domain-specific plugin, you are probably doing too much work and harming usability in the process. For example, there will be no Snippetizer integration except to list its name and help text. Variables will also not generally be compatible with Declarative Pipeline, and may not work at all in alternate FlowExecution implementations. It is also all too easy to introduce security vulnerabilities for variables implemented using Groovy code. Just because you can does not mean you should. If at all possible, limit your plugin to implementing plain Step s.

Should have a view named {@code help} offering usage. </p>

Implementations:

Alauda DevOps Pipeline Plugin: com.alauda.jenkins.plugins.pipeline.AlaudaDevOpsGlobalVariable (view on GitHub)
Alauda DevOps Pipeline Plugin: com.alauda.jenkins.plugins.pipeline.AlaudaPlatformGlobalVariable (view on GitHub)
Alauda DevOps Pipeline Plugin: com.alauda.jenkins.plugins.pipeline.StorageGlobalVariable (view on GitHub)
BTC DSL for Pipeline Plugin: com.btc.ep.plugins.embeddedplatform.EmbeddedPlatformDSL (view on GitHub)
BTC DSL for Pipeline Plugin: com.btc.ep.plugins.pipelinedsl.PipelineDSLGlobal (view on GitHub)
Datetime Constraint Plugin: org.jenkinsci.plugins.curfew.ScriptWrapper (view on GitHub)
Docker Pipeline Plugin: org.jenkinsci.plugins.docker.workflow.DockerDSL (view on GitHub)
Groovy Postbuild Plugin: org.jvnet.hudson.plugins.groovypostbuild.WorkflowManager (view on GitHub)
Job and Node ownership Plugin: org.jenkinsci.plugins.ownership.model.workflow.OwnershipGlobalVariable (view on GitHub)
JRedis Notifier Plugin: com.tsoft.jenkins.plugin.pipeline.RedisGlobalVariable (view on GitHub)
OpenShift Client Plugin: com.openshift.jenkins.plugins.pipeline.OpenShiftGlobalVariable (view on GitHub)
Pipeline Remote Loader Plugin: org.jenkinsci.plugins.workflow.remoteloader.FileLoaderDSL (view on GitHub)
Pipeline Remote Loader Plugin: org.jenkinsci.plugins.workflow.remoteloader.GroovyFileGlobalVariable (view on GitHub)
Pipeline: Declarative Plugin: org.jenkinsci.plugins.pipeline.modeldefinition.ModelStepLoader (view on GitHub)
Pipeline: GitHub Plugin: org.jenkinsci.plugins.pipeline.github.PullRequestGlobalVariable (view on GitHub)
Pipeline: Groovy Libraries Plugin: org.jenkinsci.plugins.workflow.cps.global.UserDefinedGlobalVariable (view on GitHub)
Pipeline: Groovy Plugin: org.jenkinsci.plugins.workflow.cps.EnvActionImpl.Binder (view on GitHub)
Pipeline: Groovy Plugin: org.jenkinsci.plugins.workflow.cps.ParamsVariable (view on GitHub)
Pipeline: Groovy Plugin: org.jenkinsci.plugins.workflow.cps.RunWrapperBinder (view on GitHub)
Pipeline: Multibranch Plugin: org.jenkinsci.plugins.workflow.multibranch.SCMVar (view on GitHub)
Simple Build DSL for Pipeline Plugin: org.jenkinsci.plugins.pipelinedsl.PipelineDSLGlobal (view on GitHub)
Simple Build DSL for Pipeline Plugin: org.jenkinsci.plugins.simplebuild.SimpleBuildDSL (view on GitHub)

GlobalVariableSet

org.jenkinsci.plugins.workflow.cps.GlobalVariableSet in workflow-cps

Extension point that defines a collection of global variables.

Implementations:

Pipeline: Deprecated Groovy Libraries Plugin: org.jenkinsci.plugins.workflow.cps.global.UserDefinedGlobalVariableList (view on GitHub)
Pipeline: GitHub Plugin: org.jenkinsci.plugins.pipeline.github.GitHubPipelineGlobalVariables (view on GitHub)
Pipeline: Groovy Libraries Plugin: org.jenkinsci.plugins.workflow.libs.LibraryAdder.GlobalVars (view on GitHub)
Pipeline: Groovy Plugin: org.jenkinsci.plugins.workflow.cps.GlobalVariableSet.GlobalVariableProvider (view on GitHub)

GroovySample

org.jenkinsci.plugins.workflow.cps.GroovySample in workflow-cps

A sample Pipeline Groovy script to appear in the {@code }.

Implementations:

Kubernetes Plugin: org.csanchez.jenkins.plugins.kubernetes.pipeline.KubernetesSamples.Declarative (view on GitHub)
Kubernetes Plugin: org.csanchez.jenkins.plugins.kubernetes.pipeline.KubernetesSamples.Maven (view on GitHub)
Kubernetes Plugin: org.csanchez.jenkins.plugins.kubernetes.pipeline.KubernetesSamples.Static (view on GitHub)
Kubernetes Plugin: org.csanchez.jenkins.plugins.kubernetes.pipeline.KubernetesSamples.Windows (view on GitHub)
Pipeline: Groovy Plugin: org.jenkinsci.plugins.workflow.cps.GroovySample.GitHubMaven (view on GitHub)
Pipeline: Groovy Plugin: org.jenkinsci.plugins.workflow.cps.GroovySample.Hello (view on GitHub)
Pipeline: Groovy Plugin: org.jenkinsci.plugins.workflow.cps.GroovySample.Scripted (view on GitHub)
Pipeline: Groovy Plugin: org.jenkinsci.plugins.workflow.cps.GroovySample.Static (view on GitHub)

GroovyShellDecorator

org.jenkinsci.plugins.workflow.cps.GroovyShellDecorator in workflow-cps

Hook to customize the behaviour of GroovyShell used to run workflow scripts.

Implementations:

OES Template Plugin: cn.opsbox.jenkinsci.plugins.cps.AttributeInjector (view on GitHub)
Pipeline Utility Steps Plugin: org.jenkinsci.plugins.pipeline.utility.steps.csv.ReadCSVStep.PackageAutoImporter (view on GitHub)
Pipeline Utility Steps Plugin: org.jenkinsci.plugins.pipeline.utility.steps.maven.ReadMavenPomStep.PackageAutoImporter (view on GitHub)
Pipeline: Declarative Plugin: org.jenkinsci.plugins.pipeline.modeldefinition.parser.GroovyShellDecoratorImpl (view on GitHub)
Pipeline: Deprecated Groovy Libraries Plugin: org.jenkinsci.plugins.workflow.cps.global.GroovyShellDecoratorImpl (view on GitHub)
Pipeline: Deprecated Groovy Libraries Plugin: Anonymous class in org.jenkinsci.plugins.workflow.cps.global.GroovyShellDecoratorImpl (view on GitHub)
Pipeline: Groovy Libraries Plugin: org.jenkinsci.plugins.workflow.libs.LibraryDecorator (view on GitHub)
Pipeline: Groovy Plugin: Anonymous class in org.jenkinsci.plugins.workflow.cps.GroovyShellDecorator (view on GitHub)

GroovySourceFileAllowlist

org.jenkinsci.plugins.workflow.cps.GroovySourceFileAllowlist in workflow-cps

Determines what Groovy source files can be loaded in Pipelines.

Implementations:

Docker Pipeline Plugin: org.jenkinsci.plugins.docker.workflow.declarative.AbstractDockerAgent.ChangelogConditionalScriptAllowlist (view on GitHub)
Docker Pipeline Plugin: org.jenkinsci.plugins.docker.workflow.DockerDSL.DockerDSLAllowlist (view on GitHub)
Pipeline: Declarative Extension Points API Plugin: org.jenkinsci.plugins.pipeline.modeldefinition.agent.DeclarativeAgent.CheckoutScriptAllowlist (view on GitHub)
Pipeline: Declarative Extension Points API Plugin: org.jenkinsci.plugins.pipeline.modeldefinition.withscript.WithScriptDescriptor.WithScriptAllowlist (view on GitHub)
Pipeline: Declarative Plugin: org.jenkinsci.plugins.pipeline.modeldefinition.when.impl.ChangeLogConditional.ChangelogConditionalScriptAllowlist (view on GitHub)
Pipeline: Declarative Plugin: org.jenkinsci.plugins.pipeline.modeldefinition.ModelStepLoader.ModelInterpreterAllowlist (view on GitHub)
Pipeline: Groovy Plugin: org.jenkinsci.plugins.workflow.cps.GroovySourceFileAllowlist.DefaultAllowlist (view on GitHub)

OriginalLoadedScripts

org.jenkinsci.plugins.workflow.cps.replay.OriginalLoadedScripts in workflow-cps

Defines which scripts are eligible to be replaced by ReplayAction#run .

Implementations:

Pipeline: Groovy Libraries Plugin: org.jenkinsci.plugins.workflow.libs.LibraryAdder.LoadedLibraries (view on GitHub)
Pipeline: Groovy Plugin: org.jenkinsci.plugins.workflow.cps.replay.ReplayFlowFactoryAction.StoredLoadedScripts (view on GitHub)

SnippetizerLink

org.jenkinsci.plugins.workflow.cps.SnippetizerLink in workflow-cps

A link that will show up on the side panel of the snippet generator and other similar pages. Display order is determined by extension ordinal - highest ordinal first.

Implementations:

Pipeline As YAML (Incubated) Plugin: io.jenkins.plugins.pipeline.PipelineAsYamlSnippetizer.LinkExtension (view on GitHub)
Pipeline: Declarative Plugin: org.jenkinsci.plugins.pipeline.modeldefinition.generator.DirectiveGenerator.DeclarativeDirectivesLink (view on GitHub)
Pipeline: Declarative Plugin: org.jenkinsci.plugins.pipeline.modeldefinition.generator.DirectiveGenerator.DeclarativeOnlineDocsLink (view on GitHub)
Pipeline: Groovy Plugin: org.jenkinsci.plugins.workflow.cps.SnippetizerLink.ExamplesLink (view on GitHub)
Pipeline: Groovy Plugin: org.jenkinsci.plugins.workflow.cps.SnippetizerLink.GDSLLink (view on GitHub)
Pipeline: Groovy Plugin: org.jenkinsci.plugins.workflow.cps.SnippetizerLink.GeneratorLink (view on GitHub)
Pipeline: Groovy Plugin: org.jenkinsci.plugins.workflow.cps.SnippetizerLink.GlobalsReferenceLink (view on GitHub)
Pipeline: Groovy Plugin: org.jenkinsci.plugins.workflow.cps.SnippetizerLink.OnlineDocsLink (view on GitHub)
Pipeline: Groovy Plugin: org.jenkinsci.plugins.workflow.cps.SnippetizerLink.StepReferenceLink (view on GitHub)

StepDescriptorCache

org.jenkinsci.plugins.workflow.cps.nodes.StepDescriptorCache in workflow-cps

Shared cacheSingleton for the StepDescriptors, extension-scoped to avoid test issues

Implementations:

(no known implementations)

Extension Points defined in Pipeline: Groovy Plugin

GlobalVariable

GlobalVariableSet

GroovySample

GroovyShellDecorator

GroovySourceFileAllowlist

OriginalLoadedScripts

SnippetizerLink

StepDescriptorCache

Resources

Project

Community

Other