jenkins:syncworkspaces

Full name:

org.kuali.maven.plugins:jenkins-maven-plugin:1.1.13:syncworkspaces

Description:

Sync any workspaces from the Jenkins master to a workspace server. Only sync workspaces where the build number has incremented since the last sync call.

Attributes:

  • Requires a Maven project to be executed.

Required Parameters

Name Type Since Description
executable String - The rsync executable
Default value is: rsync.
localJobsDir File - The local directory where Jenkins stores job information and workspaces
Default value is: /var/lib/jenkins/jobs.
workspaceServerDir String - The directory on the workspace server containing workspaces
Default value is: /var/lib/jenkins/workspace.
workspaceServerHostname String - The hostname for the workspace server
Default value is: ws.rice.kuali.org.
workspaceServerUser String - The user to login to the workspace server with
Default value is: root.

Optional Parameters

Name Type Since Description
failOnError boolean - If true, the Maven build will fail if rsync returns a non-zero exit value
Default value is: true.
stats boolean - If true, rsync shows transfer statistics. Equivalent to passing rsync --stats
Default value is: false.
trackedBuildNumbers String - Properties file containing the jobs and buildNumbers the plugin has sync'd to the workspace server
Default value is: ${user.home}/.jenkins-maven-plugin/trackedBuildNumbers.properties.
verbose boolean - If true, rsync logs files that get transferred to the workspace server. Equivalent to passing rsync -v
Default value is: false.

Parameter Details

executable:

The rsync executable
  • Type: java.lang.String
  • Required: Yes
  • Expression: ${jenkins.executable}
  • Default: rsync

failOnError:

If true, the Maven build will fail if rsync returns a non-zero exit value
  • Type: boolean
  • Required: No
  • Expression: ${jenkins.failOnError}
  • Default: true

localJobsDir:

The local directory where Jenkins stores job information and workspaces
  • Type: java.io.File
  • Required: Yes
  • Expression: ${jenkins.localJobsDir}
  • Default: /var/lib/jenkins/jobs

stats:

If true, rsync shows transfer statistics. Equivalent to passing rsync --stats
  • Type: boolean
  • Required: No
  • Expression: ${jenkins.stats}
  • Default: false

trackedBuildNumbers:

Properties file containing the jobs and buildNumbers the plugin has sync'd to the workspace server
  • Type: java.lang.String
  • Required: No
  • Expression: ${jenkins.trackedBuildNumbers}
  • Default: ${user.home}/.jenkins-maven-plugin/trackedBuildNumbers.properties

verbose:

If true, rsync logs files that get transferred to the workspace server. Equivalent to passing rsync -v
  • Type: boolean
  • Required: No
  • Expression: ${jenkins.verbose}
  • Default: false

workspaceServerDir:

The directory on the workspace server containing workspaces
  • Type: java.lang.String
  • Required: Yes
  • Expression: ${jenkins.workspaceServerDir}
  • Default: /var/lib/jenkins/workspace

workspaceServerHostname:

The hostname for the workspace server
  • Type: java.lang.String
  • Required: Yes
  • Expression: ${jenkins.workspaceServerHostname}
  • Default: ws.rice.kuali.org

workspaceServerUser:

The user to login to the workspace server with
  • Type: java.lang.String
  • Required: Yes
  • Expression: ${jenkins.workspaceServerUser}
  • Default: root