COMPATIBILITY.md

Plugin Compatibility with Workflow

For architectural reasons, plugins providing various extensions of interest to builds cannot be made automatically compatible with Workflow. Typically they require use of some newer APIs, large or small. This document captures the ongoing status of plugins known to be compatible or incompatible.

Entries list the class name serving as the entry point to the relevant functionality of the plugin (generally an @Extension), the plugin short name, and implementation status.

SCMs

See this guide for making SCMs compatible.

• GitSCM (git): supported as of 2.3; native git step also bundled
• SubversionSCM (subversion): supported as of 2.5; native svn step also bundled
• MercurialSCM (mercurial): supported as of 1.51
• PerforceScm (p4, not the older perforce): supported as of 1.2.0
• DimensionsSCM (dimensionsscm): JENKINS-26165
• IntegritySCM (integrity-plugin): JENKINS-27140
• RepoScm (repo): JENKINS-26836
• teamconcert: JENKINS-27464

Build steps and post-build actions

See this guide for making Builders and Publishers compatible.

• ArtifactArchiver (core)
• Fingerprinter (core)
• JUnitResultArchiver (junit)
• JavadocArchiver (javadoc)
• Mailer (mailer)
• CopyArtifact (copyartifact): JENKINS-24887 in 1.34
• DeployPublisher (deployer-framework): JENKINS-25976
• FindBugsPublisher and similar (analysis-core and downstream): JENKINS-25977
• ExtendedEmailPublisher (email-ext): PR 97
• Ant (ant): JENKINS-26056
• Maven (home TBD): JENKINS-26057
• XShellBuilder (xshell): JENKINS-26169
• DockerBuilder (docker-build-step): JENKINS-26178
• CucumberTestResultArchiver (cucumber-testresult-plugin): JENKINS-26340
• HtmlPublisher (htmlpublisher): JENKINS-26343
• JaCoCoPublisher (jacoco): JENKINS-27120
• Publisher (testng): JENKINS-27121
• GroovyPostbuildRecorder (groovy-postbuild): JENKINS-26918
• Gradle (gradle): JENKINS-27393
• CloverPublisher (clover): JENKINS-27302
• MsBuildBuilder (msbuild): JENKINS-26948
• HipChatNotifier (hipchat): JENKINS-27202
• LogParserPublisher (log-parser): JENKINS-27208
• SlackNotifier (slack): JENKINS-27652
• DescriptionSetterPublisher (description-setter): PR 7

Build wrappers

• API to integrate these: JENKINS-24673
• ConfigFileBuildWrapper (config-file-provider): JENKINS-26339
• Xvnc (xvnc): JENKINS-26477
• BuildUser (build-user-vars): JENKINS-26953
• DashboardBuilder (environment-dashboard): PR 20
• TimestamperBuildWrapper (timestamper): JENKINS-27207
• MaskPasswordsBuildWrapper (mask-passwords): PR 3

Triggers

Implement Trigger<ParameterizedJobMixIn.ParameterizedJob> and implement TriggerDescriptor.isApplicable accordingly.

• gerrit-trigger: JENKINS-26010
• ghprb: JENKINS-26591
• github: JENKINS-27136
• xtrigger-plugin: JENKINS-27301

Clouds

Do not necessarily need any special integration, but are encouraged to use OnceRetentionStrategy from durable-task to allow flow builds to survive restarts.

• elasticbox: JENKINS-25978 (could also include build wrapper integration)
• mansion-cloud: JENKINS-24815
• mock-slave (for prototyping): JENKINS-25090
• docker: supported as of 0.8
• nectar-vmware (CloudBees Jenkins Enterprise): supported as of 4.3.2
• operations-center-cloud (CloudBees Jenkins Enterprise/Operations Center): RM-2642
• ec2: known to work as is

Miscellaneous

• rebuild: JENKINS-26024
• parameterized-trigger (to support a workflow as downstream): JENKINS-26050
• build-token-root: JENKINS-26693
• credentials-binding: withCredentials step as of 1.3
• build-failure-analyzer: JENKINS-27123
• shelve-project: JENKINS-26432
• job-dsl: implemented in 1.29
• zentimestamp: JENKINS-26958
• claim: JENKINS-27206
• ListSubversionTagsParameterValue (subversion): JENKINS-27718

Custom steps

For cases when a first-class Workflow step (rather than an adaptation of functionality applicable to freestyle projects) makes sense.

• parallel-test-executor: supported with splitTests step since 1.6
• gerrit-trigger: JENKINS-26102, JENKINS-26103
• mailer: JENKINS-26104 in Workflow 1.2