hudson:checkStatusJobs

Full name:

de.smartics.ci:hudson-maven-plugin:0.2.4:checkStatusJobs

Description:

Check status of a job in hudson ci mojo.

Attributes:

  • Requires a Maven project to be executed.

Optional Parameters

Name Type Since Description
addScmElementWithFullContent boolean 1.0 Control whether the scm element is to be added to the generated Job config.xml with full content. The scm is an element in addition to the SCM configuration as an entry in the same document.

In some documents the element is expected to be stated redundantly. Some configurations allow to reference the SCM information of an entry element with an XPath expression. Adding an element with that expression is not controllable with this flag.


Default value is: false.
ciConfigurationFile File 1.0 The path to the configuration file for CI. Defaults to ${basedir}/src/etc/ci/ci-config.xml.
Default value is: ${basedir}/src/etc/ci/ci-config.xml.
ciServerId String 1.0 The name of the server configuration in the settings.xml that provides credentials to access the Hudson server. Only used if no server matches the POM's ciManagement/url and ciManagement/system.
Default value is: hudson.
hudsonConfigSourceLocations String[] 1.0 The path to the project local configuration files for CI. If ${basedir}/src/etc/ci exists, it is automatically added.
hudsonTargetLocation File 1.0 The path to the destination folder to write the Hudson configurations to. Defaults to ${project.build.directory}/hudson.
Default value is: ${project.build.directory}/hudson.
jobConfigFile String 1.0 Use this file as is and do not use the ci-config mechanism.
jobName String 1.0 Use this name as the job name and do not use the ci-config mechanism.
removeCascadingChildrenNamesElement boolean 1.0 Controls the removal of the cascadingChildrenNames element from the job configuration.

The element is added by Hudson if the config.xml is retrieved. The presence of the element rejects the configuration from being pushed on the server.


Default value is: true.
removeCascadingJobPropertiesElement boolean 1.0 Controls the removal of the cascading-job-properties element from the job configuration.

The element is added by Hudson if the config.xml is retrieved. The presence of the element rejects the configuration from being pushed on the server.


Default value is: true.
verbose String 1.0 Defines the verboseness of the output.
  • QUIET - prints no info messages.
  • NORMAL - only prints inormation to get known what happened, but without any details.
  • VERBOSE - adds information about the called service and parameters.
  • TRACE - provides the most verbose output with dumping the contents of the returned pages.

Default value is: NORMAL.
xmlQueryString String 1.0 The xmlQueryString to use for the xml api.
Default value is: tree=jobs[name]&xpath=hudson/job[name="${jobName}"]/name/text().

Parameter Details

addScmElementWithFullContent:

Control whether the scm element is to be added to the generated Job config.xml with full content. The scm is an element in addition to the SCM configuration as an entry in the same document.

In some documents the element is expected to be stated redundantly. Some configurations allow to reference the SCM information of an entry element with an XPath expression. Adding an element with that expression is not controllable with this flag.

  • Type: boolean
  • Since: 1.0
  • Required: No
  • Default: false

ciConfigurationFile:

The path to the configuration file for CI. Defaults to ${basedir}/src/etc/ci/ci-config.xml.
  • Type: java.io.File
  • Since: 1.0
  • Required: No
  • Default: ${basedir}/src/etc/ci/ci-config.xml

ciServerId:

The name of the server configuration in the settings.xml that provides credentials to access the Hudson server. Only used if no server matches the POM's ciManagement/url and ciManagement/system.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Default: hudson

hudsonConfigSourceLocations:

The path to the project local configuration files for CI. If ${basedir}/src/etc/ci exists, it is automatically added.
  • Type: java.lang.String[]
  • Since: 1.0
  • Required: No

hudsonTargetLocation:

The path to the destination folder to write the Hudson configurations to. Defaults to ${project.build.directory}/hudson.
  • Type: java.io.File
  • Since: 1.0
  • Required: No
  • Default: ${project.build.directory}/hudson

jobConfigFile:

Use this file as is and do not use the ci-config mechanism.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Expression: ${hudson-maven-plugin.jobConfigFile}

jobName:

Use this name as the job name and do not use the ci-config mechanism.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Expression: ${hudson-maven-plugin.jobName}

removeCascadingChildrenNamesElement:

Controls the removal of the cascadingChildrenNames element from the job configuration.

The element is added by Hudson if the config.xml is retrieved. The presence of the element rejects the configuration from being pushed on the server.

  • Type: boolean
  • Since: 1.0
  • Required: No
  • Default: true

removeCascadingJobPropertiesElement:

Controls the removal of the cascading-job-properties element from the job configuration.

The element is added by Hudson if the config.xml is retrieved. The presence of the element rejects the configuration from being pushed on the server.

  • Type: boolean
  • Since: 1.0
  • Required: No
  • Default: true

verbose:

Defines the verboseness of the output.
  • QUIET - prints no info messages.
  • NORMAL - only prints inormation to get known what happened, but without any details.
  • VERBOSE - adds information about the called service and parameters.
  • TRACE - provides the most verbose output with dumping the contents of the returned pages.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Expression: ${verbose}
  • Default: NORMAL

xmlQueryString:

The xmlQueryString to use for the xml api.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Expression: ${hudson-maven-plugin.xmlQueryString}
  • Default: tree=jobs[name]&xpath=hudson/job[name="${jobName}"]/name/text()