jenkins:syncworkspaces

Full name:

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

Description:

Sync any workspaces from the Jenkins master to a workspace server. Only sync workspaces where the build number has changed 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.
User property is: jenkins.executable.
localJobsDir File - The local directory where Jenkins stores job information and workspaces
Default value is: /var/lib/jenkins/jobs.
User property is: jenkins.localJobsDir.
workspaceServerDir String - The directory on the workspace server containing workspaces
Default value is: /var/lib/jenkins/workspace.
User property is: jenkins.workspaceServerDir.
workspaceServerHostname String - The hostname for the workspace server
Default value is: ws.rice.kuali.org.
User property is: jenkins.workspaceServerHostname.
workspaceServerUser String - The user to login to the workspace server as
Default value is: root.
User property is: jenkins.workspaceServerUser.

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.
User property is: jenkins.failOnError.
forceSync boolean - If true, sync all jobs even if the job has not been re-run since the last sync
Default value is: false.
User property is: jenkins.forceSync.
ignoreJobs String - Comma separated list of jobs to ignore
User property is: jenkins.ignoreJobs.
stats boolean - If true, rsync shows transfer statistics. Equivalent to passing rsync --stats
Default value is: false.
User property is: jenkins.stats.
trackedBuildNumbers String - Properties file containing the jobs and build numbers the plugin has sync'd to the workspace server
Default value is: ${user.home}/.m2/jenkins-build-numbers.properties.
User property is: jenkins.trackedBuildNumbers.
verbose boolean - If true, rsync logs files that get transferred to the workspace server. Equivalent to passing rsync -v
Default value is: false.
User property is: jenkins.verbose.

Parameter Details

executable:

The rsync executable
  • Type: java.lang.String
  • Required: Yes
  • User Property: jenkins.executable
  • Default: rsync

failOnError:

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

forceSync:

If true, sync all jobs even if the job has not been re-run since the last sync
  • Type: boolean
  • Required: No
  • User Property: jenkins.forceSync
  • Default: false

ignoreJobs:

Comma separated list of jobs to ignore
  • Type: java.lang.String
  • Required: No
  • User Property: jenkins.ignoreJobs

localJobsDir:

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

stats:

If true, rsync shows transfer statistics. Equivalent to passing rsync --stats
  • Type: boolean
  • Required: No
  • User Property: jenkins.stats
  • Default: false

trackedBuildNumbers:

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

verbose:

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

workspaceServerDir:

The directory on the workspace server containing workspaces
  • Type: java.lang.String
  • Required: Yes
  • User Property: jenkins.workspaceServerDir
  • Default: /var/lib/jenkins/workspace

workspaceServerHostname:

The hostname for the workspace server
  • Type: java.lang.String
  • Required: Yes
  • User Property: jenkins.workspaceServerHostname
  • Default: ws.rice.kuali.org

workspaceServerUser:

The user to login to the workspace server as
  • Type: java.lang.String
  • Required: Yes
  • User Property: jenkins.workspaceServerUser
  • Default: root