jenkins:deletejobs

Full name:

org.kuali.maven.plugins:jenkins-maven-plugin:1.0.4-SNAPSHOT:deletejobs

Description:

Connect to a Jenkins server and delete one or more jobs

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: delete-job.
ignoreCodes String - Comma delimited list of result codes to ignore. Result code of 1 means the job we are trying to delete does not exist.
Default value is: 1.
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.
template String - The location of the jenkins job config template
Default value is: classpath:org/kuali/jenkins/jobs/template.xml.
timestampFormat String - The format for timestamp displays
Default value is: yyyy-MM-dd HH:mm:ss z.
types String - Comma delimited list of types to delete. Maven GAV info is combined with 'type' to derive the complete job name eg 'jenkins-maven-plugin-1.0-publish'
Default value is: publish,unit,license,release.
url String - The Jenkins instance to connect to.
Default value is: ${project.ciManagement.url}.
workingDir File - The working directory for the plugin
Default value is: ${project.build.directory}/jenkins.

Optional Parameters

Name Type Since Description
names List - The explicit list of jobs to delete. If names are provided, 'types' is ignored.

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: delete-job

ignoreCodes:

Comma delimited list of result codes to ignore. Result code of 1 means the job we are trying to delete does not exist.
  • Type: java.lang.String
  • Required: Yes
  • Expression: ${jenkins.ignoreCodes}
  • Default: 1

names:

The explicit list of jobs to delete. If names are provided, 'types' is ignored.
  • Type: java.util.List
  • Required: No

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

template:

The location of the jenkins job config template
  • Type: java.lang.String
  • Required: Yes
  • Expression: ${jenkins.template}
  • Default: classpath:org/kuali/jenkins/jobs/template.xml

timestampFormat:

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

types:

Comma delimited list of types to delete. Maven GAV info is combined with 'type' to derive the complete job name eg 'jenkins-maven-plugin-1.0-publish'
  • Type: java.lang.String
  • Required: Yes
  • Expression: ${jenkins.types}
  • Default: publish,unit,license,release

url:

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

workingDir:

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