jenkins:runjob

Full name:

org.kuali.maven.plugins:jenkins-maven-plugin:1.0.0:runjob

Description:

Connect to a Jenkins server and schedule a job to run

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: test.

Required Parameters

Name Type Since Description
classname String - The classname for Jenkins CLI
Default value is: hudson.cli.CLI.
cmd String - The command issued to Jenkins CLI
Default value is: build.
name String - The explicit name of a job to run. If name is provided, 'type' is ignored
server String - The Jenkins instance to connect to.
Default value is: ${project.ciManagement.url}.
stopOnError boolean - If set to true, the build will fail the first time it encounters an issue. When false, mojo's that issue multiple requests, will proceed through their list of requests and then fail at the end if an issue was encountered along the way.
Default value is: false.
timestampFormat String - The format for timestamp displays
Default value is: yyyy-MM-dd HH:mm:ss z.
type String - The type of job to run
Default value is: publish.
workingDir File - The working directory for the plugin
Default value is: ${project.build.directory}/jenkins.

Parameter Details

classname:

The classname for Jenkins CLI
  • Type: java.lang.String
  • Required: Yes
  • Expression: ${jenkins.classname}
  • Default: hudson.cli.CLI

cmd:

The command issued to Jenkins CLI
  • Type: java.lang.String
  • Required: Yes
  • Expression: ${jenkins.cmd}
  • Default: build

name:

The explicit name of a job to run. If name is provided, 'type' is ignored
  • Type: java.lang.String
  • Required: Yes
  • Expression: ${jenkins.name}

server:

The Jenkins instance to connect to.
  • Type: java.lang.String
  • Required: Yes
  • Expression: ${jenkins.server}
  • Default: ${project.ciManagement.url}

stopOnError:

If set to true, the build will fail the first time it encounters an issue. When false, mojo's that issue multiple requests, will proceed through their list of requests and then fail at the end if an issue was encountered along the way.
  • Type: boolean
  • Required: Yes
  • Expression: ${jenkins.stopOnError}
  • Default: false

timestampFormat:

The format for timestamp displays
  • Type: java.lang.String
  • Required: Yes
  • Expression: ${jenkins.timestampFormat}
  • Default: yyyy-MM-dd HH:mm:ss z

type:

The type of job to run
  • Type: java.lang.String
  • Required: Yes
  • Expression: ${jenkins.type}
  • Default: publish

workingDir:

The working directory for the plugin
  • Type: java.io.File
  • Required: Yes
  • Expression: ${jenkins.workingDir}
  • Default: ${project.build.directory}/jenkins