Difference between revisions of "Documentation/Nightly/Developers/Tutorials/DashboardSetup"

From Slicer Wiki
Jump to: navigation, search
 
(11 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
<noinclude>{{documentation/versioncheck}}</noinclude>
 
<noinclude>{{documentation/versioncheck}}</noinclude>
=Prerequisites=
 
  
Install prerequisites as described [[Documentation/{{documentation/version}}/Developers/Build_Instructions/Prerequisites|here]]:
+
= General Instruction =
* CMake (use the latest CMake stable release)
 
* git
 
* svn
 
* NSIS (only on Windows)
 
  
=Setup=
+
== Prerequisites==
  
Disable detachedHead warnings:
+
* Install recommended compiler for your system
 +
* Install/build prerequisites as described [[Documentation/{{documentation/version}}/Developers/Build_Instructions/Prerequisites|here]]:
 +
** CMake (use the latest CMake stable release)
 +
** git
 +
** svn
 +
** Qt
 +
** NSIS (only on Windows)
 +
** Docker (only on Linux to use [https://github.com/Slicer/SlicerBuildEnvironment#readme SlicerBuildEnvironment] docker image)
 +
 
 +
* Disable detachedHead warnings:
 
<pre>
 
<pre>
 
git config --global advice.detachedHead false
 
git config --global advice.detachedHead false
 
</pre>
 
</pre>
  
Follow these instructions to set up dashboard:
+
== Create dashboard client build directories ==
<!--The link referenced here was broken:
+
 
 +
<!--
 +
Follow these instructions to set up a dashboard client:
 +
The link referenced here was broken:
 
(by JC, from [http://massmail.spl.harvard.edu/public-archives/slicer-devel/2011/006703.html])
 
(by JC, from [http://massmail.spl.harvard.edu/public-archives/slicer-devel/2011/006703.html])
 
-->
 
-->
  
* Type the followings into a terminal window (on Windows use PowerShell)
+
 
 +
* On Linux, create the following directories:
  
 
<pre>
 
<pre>
$ cd ~
+
/home/username/Dashboards
$ mkdir Dashboards
+
/home/username/Dashboards/Logs
$ mkdir DashboardScripts
+
/home/username/Dashboards/DashboardScripts
$ cd DashboardScripts
 
 
</pre>
 
</pre>
  
Non-windows:
+
* On macOS, create a directory like
 +
 
 
<pre>
 
<pre>
$ wget http://svn.slicer.org/Slicer4/trunk/CMake/SlicerDashboardScript.TEMPLATE.cmake
+
/Users/username/Dashboards
$ mv SlicerDashboardScript.TEMPLATE.cmake <MachineName>_<OperatingSystem>-64bits_slicer_release_nightly.cmake
+
/Users/username/Dashboards/Logs
 +
/Users/username/Dashboards/DashboardScripts
 
</pre>
 
</pre>
Windows:
+
 
 +
* On windows, create a directory like
 +
 
 
<pre>
 
<pre>
$ wget http://svn.slicer.org/Slicer4/trunk/CMake/SlicerDashboardScript.TEMPLATE.cmake -OutFile <MachineName>_<OperatingSystem>-64bits_slicer_release_nightly.cmake
+
C:/D
 +
C:/D/Logs
 +
C:/D/DashboardScripts
 +
</pre>
 +
 
 +
Notes:
 +
* <tt>username</tt> should be changed to match your system.
 +
* On Windows, a short directory name is required to overcome [http://msdn.microsoft.com/en-us/library/aa365247%28VS.85%29.aspx#maxpath path length limitation].
 +
* The <tt>Dashboards</tt> directory will be used to set the <tt>DASHBOARDS_DIR</tt> variable in the client configuration script.
 +
 
 +
 
 +
== Customize template dashboard client script ==
 +
 
 +
=== Download template scripts ===
 +
 
 +
Download the template script: http://svn.slicer.org/Slicer4/trunk/CMake/SlicerDashboardScript.TEMPLATE.cmake
 +
 
 +
On Linux and macOS:
 +
 
 +
<pre>
 +
wget http://svn.slicer.org/Slicer4/trunk/CMake/SlicerDashboardScript.TEMPLATE.cmake
 +
mv SlicerDashboardScript.TEMPLATE.cmake <MachineName>_<OperatingSystem>-slicer_preview_nightly.cmake
 +
</pre>
 +
 
 +
On windows, from a powershell terminal:
 +
 
 +
<pre>
 +
wget http://svn.slicer.org/Slicer4/trunk/CMake/SlicerDashboardScript.TEMPLATE.cmake -OutFile <MachineName>_<OperatingSystem>-slicer_preview_nightly.cmake
 
</pre>
 
</pre>
  
Edit the file <code><MachineName>_<OperatingSystem>-64bits_slicer_release_nightly.cmake</code> to match
+
=== Customize script ===
your machine settings. You should update the following variables:
+
 
 +
Edit the file <code><MachineName>_<OperatingSystem>-slicer_preview_nightly.cmake</code> to match your machine settings.
 +
 
 +
* Example of windows script: [https://github.com/Slicer/DashboardScripts/blob/master/overload-vs2015-slicer_preview_nightly.cmake overload-vs2015-slicer_preview_nightly.cmake]
 +
* Example of macOS script: [https://github.com/Slicer/DashboardScripts/blob/master/factory-south-macos-slicer_preview_nightly.cmake factory-south-macos-slicer_preview_nightly.cmake]
 +
* Example of linux script: [https://github.com/Slicer/DashboardScripts/blob/master/metroplex-slicer_preview_nightly.cmake metroplex-slicer_preview_nightly.cmake]
 +
 
 +
 
 +
The following directories will be created by the dashboard script:
  
 
<pre>
 
<pre>
set(MY_OPERATING_SYSTEM   "<OperatingSystem>") # Windows, Linux, Darwin...
+
#   Source directory : <DASHBOARDS_DIR>/<Slicer_DASHBOARD_SUBDIR>/<Slicer_DIRECTORY_BASENAME>-<Slicer_DIRECTORY_IDENTIFIER>
set(MY_COMPILER          "g++4.4.3")
+
#  Build directory : <DASHBOARDS_DIR>/<Slicer_DASHBOARD_SUBDIR>/<Slicer_DIRECTORY_BASENAME>-<Slicer_DIRECTORY_IDENTIFIER>-build
set(MY_QT_VERSION        "4.7.4")
 
set(QT_QMAKE_EXECUTABLE  "$ENV{HOME}/Projects/QtSDK-1.2/Desktop/Qt/474/gcc/bin/qmake")
 
set(CTEST_SITE            "karakoram.kitware")
 
set(CTEST_DASHBOARD_ROOT "$ENV{HOME}/Dashboards/")
 
...
 
set(CTEST_BUILD_CONFIGURATION "Release")
 
...
 
set(SCRIPT_MODE "nightly")
 
 
</pre>
 
</pre>
  
If git and svn are not in the path, make sure to set the variables CTEST_SVN_COMMAND and CTEST_GIT_COMMAND.
+
To easily identify build options associated with source and build directories, the associated build options will be combined together to create an empty text file with the following name:
  
By default, the following directory will be created:
+
<pre>
  <CTEST_DASHBOARD_ROOT>/Slicer-<DIRECTORY_IDENTIFIER>       # Source directory
+
<DASHBOARDS_DIR>/<Slicer_DASHBOARD_SUBDIR>/<Slicer_DIRECTORY_BASENAME>-<Slicer_DIRECTORY_IDENTIFIER>-build - ${CTEST_BUILD_NAME}-${CTEST_BUILD_CONFIGURATION}-${SCRIPT_MODE}.txt
  <CTEST_DASHBOARD_ROOT>/Slicer-<DIRECTORY_IDENTIFIER>-build # Build directory
+
</pre>
  
The associated build options will be combined together to create an empty text file with the following name:
 
  <CTEST_DASHBOARD_ROOT>/Slicer-<DIRECTORY_IDENTIFIER>-build - <BUILD_OPTIONS_STRING>-<CTEST_BUILD_CONFIGURATION>-<SCRIPT_MODE>.txt"
 
  
This approach has been implemented to keep build directory short and overcome [http://msdn.microsoft.com/en-us/library/aa365247%28VS.85%29.aspx#maxpath path length limitation specific to windows].
+
=== Publish and version control the dashboard scripts ===
  
It means that if you setting up more than on client in a given <code><CTEST_DASHBOARD_ROOT></code> folder, you MUST increment the value associated with <code>DIRECTORY_IDENTIFIER</code> variable.
+
To backup your scripts and help the Slicer community setup additional dashboard clients by adapting your scripts, consider publishing your scripts in a GitHub repository.
  
Finally, you can use <code>CTEST_BUILD_FLAGS</code> to set the number of CPUs to be used by ''make'' (eg, -j4), and CTEST_PARALLEL_LEVEL to set the number of tests to run in parallel (see comments in the [http://svn.slicer.org/Slicer4/trunk/CMake/SlicerDashboardScript.TEMPLATE.cmake configuration script]).
+
Assuming your organization is named <tt>Awesome</tt>, you could create the Github project: <tt>Awesome/SlicerDashboardScripts</tt>.
 +
 
 +
For example, the official Slicer dashboard script are published here: https://github.com/Slicer/DashboardScripts
  
  
 
== Scheduling on Unix-like ==
 
== Scheduling on Unix-like ==
  
So that your dashboard can automatically start at 11pm daily, you could add an entry similar to the following one in your <code>[http://en.wikipedia.org/wiki/Cron crontab]</code>. (On ubuntu, I am running <code>crontab -e</code> to edit the current user cron list)
+
So that your dashboard can automatically start at 11pm daily, you could add an entry similar to the following one in your <code>[http://en.wikipedia.org/wiki/Cron crontab]</code>. (You could run <code>crontab -e</code> to edit the current user cron list and <code>crontab -l</code> to dislay the current list.)
  
 
<pre>
 
<pre>
0 23 * * * /path/to/cmake-2.8.7/bin/ctest -S /Users/JOE/DashboardScripts/<MachineName>_<OperatingSystem>-64bits_slicer_release_nightly.cmake -VV -O /Users/JOE/Dashboards/Logs/<MachineName>-<OperatingSystem>-64bits_slicer_release_nightly.log
+
0 23 * * * /path/to/cmake-3.13.4/bin/ctest -S /Users/username/DashboardScripts/<MachineName>_<OperatingSystem>-slicer_preview_nightly.cmake -VV -O /Users/username/Dashboards/Logs/<MachineName>_<OperatingSystem>-slicer_preview_nightly.cmake.log
 
</pre>
 
</pre>
  
==Scheduling on Mac OS X==
+
== Scheduling on Linux ==
Mac OS X is deprecating the use of cron in favor of launchd.   
+
 
 +
=== Install SlicerBuildEnvironment docker image ===
 +
 
 +
Read more details at https://github.com/Slicer/SlicerBuildEnvironment#readme
 +
 
 +
<pre>
 +
mdir /home/username/bin
 +
env_name=qt5-centos7
 +
script=/home/username/bin/slicer-buildenv-${env_name}
 +
docker run --rm slicer/buildenv-${env_name} > $script
 +
chmod +x $script
 +
</pre>
 +
 
 +
 
 +
=== Create a machinename.sh file that performs the build and use SlicerBuildEnvironment docker image ===
 +
 
 +
To use [https://github.com/Slicer/SlicerBuildEnvironment#readme SlicerBuildEnvironment] docker images, create a wrapper script like the following updating <tt>username</tt> and <tt>machinename</tt> to match your system:
 +
 
 +
FileName: <tt>/home/username/Dashboards/DashboardScripts/machinename.sh</tt>
 +
 
 +
<pre>
 +
export DISPLAY=:0.0
 +
 
 +
# Changing directory is required by "slicer-buildenv-qt5-centos7-latest" script
 +
cd  /home/username/Dashboards
 +
 
 +
# Download up-to-date slicer/buildenv-qt5-centos7:latest image
 +
/home/username/bin/slicer-buildenv-qt5-centos7-latest update
 +
 
 +
# Slicer dashboard settings
 +
docker_args="-e run_ctest_with_disable_clean=${run_ctest_with_disable_clean-FALSE}"
 +
docker_args+=" -e run_ctest_with_update=${run_ctest_with_update-TRUE}"
 +
docker_args+=" -e run_ctest_with_test=${run_ctest_with_test-FALSE}" # XXX Re-enable testing after slicer/slicer-test images have been updated
 +
 
 +
# Slicer 'Preview' release
 +
time /home/username/bin/slicer-buildenv-qt5-centos7-latest \
 +
  --args "${docker_args}" \
 +
ctest -S /work/DashboardScripts/machinename-slicer_preview_nightly.cmake -VV -O /work/Logs/machinename-slicer_preview_nightly.log
 +
</pre>
 +
 
 +
 
 +
== Scheduling on macOS ==
 +
macOS is deprecating the use of cron in favor of launchd.   
  
 
Create a file $HOME/Library/LaunchAgents/org.slicer.NightlyDashboard.plist
 
Create a file $HOME/Library/LaunchAgents/org.slicer.NightlyDashboard.plist
Line 139: Line 219:
  
  
==Scheduling on Windows==
+
== Scheduling on Windows ==
  
===Create a .bat file that performs the build===
+
=== Create a .bat file that performs the build ===
  
 
For example, a clean nightly build can be performed by a batch file like this:
 
For example, a clean nightly build can be performed by a batch file like this:
 
<pre>
 
<pre>
rmdir /S /Q c:\SAB\Slicer-build-64bit-nightly
+
 
"c:\Program Files (x86)\CMake 2.8\bin\ctest.exe" -S .\Windows7-64bits_Slicer_Release_Nightly.cmake -VV c:\SAB\Logs\Windows7-64bits_Slicer_Release_Nightly.log -C Release
+
rmdir /S /Q "C:\D\P\Slicer-0-build"
 +
"c:\Program Files (x86)\CMake\bin\ctest.exe" -S "C:\D\DashboardScripts\overload-vs2015-slicer_preview_nightly.cmake" -C Release -VV -O C:\D\Logs\overload-vs2015-slicer_preview_nightly.txt
 +
 
 
</pre>
 
</pre>
  
Line 158: Line 240:
  
 
<pre>
 
<pre>
$ cp <MachineName>_<OperatingSystem>-64bits_slicer_release_nightly.cmake <MachineName>_<OperatingSystem>-64bits_slicer_release_continuous.cmake
+
$ cp <MachineName>_<OperatingSystem>-slicer_preview_nightly.cmake <MachineName>_<OperatingSystem>-slicer_preview_continuous.cmake
 
</pre>
 
</pre>
  
Edit <code><MachineName>_<OperatingSystem>-64bits_slicer_release_continuous.cmake</code> and set
+
Edit <code><MachineName>_<OperatingSystem>-slicer_preview_continuous.cmake</code> and set
  
 
<pre>
 
<pre>
Line 170: Line 252:
  
 
<pre>
 
<pre>
0 6 * * * /path/to/cmake-2.8.7/bin/ctest -S /Users/JOE/DashboardScripts/<MachineName>_<OperatingSystem>-64bits_slicer_release_continuous.cmake -VV -O /Users/JOE/Dashboards/Logs/<MachineName>_<OperatingSystem>-64bits_slicer_release_nightly.log
+
0 6 * * * /path/to/cmake-3.13.4/bin/ctest -S /Users/JOE/DashboardScripts/<MachineName>_<OperatingSystem>-slicer_preview_continuous.cmake -VV -O /Users/JOE/Dashboards/Logs/<MachineName>_<OperatingSystem>-slicer_preview_nightly.log
 
</pre>
 
</pre>
  
 
The output of the build is contained in <code>ctest_package_make_package_output.txt</code> in your slicer build directory, you can check this file if something went wrong.
 
The output of the build is contained in <code>ctest_package_make_package_output.txt</code> in your slicer build directory, you can check this file if something went wrong.
 +
 +
= Factory machines setup =
 +
 +
Tool used for task scheduling is described here: [[Documentation/Nightly/Developers/Factory]]
 +
 +
Dashboard scripts used on the factory are available here: https://github.com/Slicer/DashboardScripts
 +
 +
More details available here:
 +
* [[Documentation/Nightly/Developers/Build_ExtensionsIndex#Dashboard_driven_build]]
  
 
= Remarks =
 
= Remarks =

Latest revision as of 18:03, 8 July 2019

Home < Documentation < Nightly < Developers < Tutorials < DashboardSetup


For the latest Slicer documentation, visit the read-the-docs.


General Instruction

Prerequisites

  • Install recommended compiler for your system
  • Install/build prerequisites as described here:
    • CMake (use the latest CMake stable release)
    • git
    • svn
    • Qt
    • NSIS (only on Windows)
    • Docker (only on Linux to use SlicerBuildEnvironment docker image)
  • Disable detachedHead warnings:
git config --global advice.detachedHead false

Create dashboard client build directories

  • On Linux, create the following directories:
/home/username/Dashboards
/home/username/Dashboards/Logs
/home/username/Dashboards/DashboardScripts
  • On macOS, create a directory like
/Users/username/Dashboards
/Users/username/Dashboards/Logs
/Users/username/Dashboards/DashboardScripts
  • On windows, create a directory like
C:/D
C:/D/Logs
C:/D/DashboardScripts

Notes:

  • username should be changed to match your system.
  • On Windows, a short directory name is required to overcome path length limitation.
  • The Dashboards directory will be used to set the DASHBOARDS_DIR variable in the client configuration script.


Customize template dashboard client script

Download template scripts

Download the template script: http://svn.slicer.org/Slicer4/trunk/CMake/SlicerDashboardScript.TEMPLATE.cmake

On Linux and macOS:

wget http://svn.slicer.org/Slicer4/trunk/CMake/SlicerDashboardScript.TEMPLATE.cmake
mv SlicerDashboardScript.TEMPLATE.cmake <MachineName>_<OperatingSystem>-slicer_preview_nightly.cmake

On windows, from a powershell terminal:

wget http://svn.slicer.org/Slicer4/trunk/CMake/SlicerDashboardScript.TEMPLATE.cmake -OutFile <MachineName>_<OperatingSystem>-slicer_preview_nightly.cmake

Customize script

Edit the file <MachineName>_<OperatingSystem>-slicer_preview_nightly.cmake to match your machine settings.


The following directories will be created by the dashboard script:

#   Source directory : <DASHBOARDS_DIR>/<Slicer_DASHBOARD_SUBDIR>/<Slicer_DIRECTORY_BASENAME>-<Slicer_DIRECTORY_IDENTIFIER>
#   Build directory  : <DASHBOARDS_DIR>/<Slicer_DASHBOARD_SUBDIR>/<Slicer_DIRECTORY_BASENAME>-<Slicer_DIRECTORY_IDENTIFIER>-build

To easily identify build options associated with source and build directories, the associated build options will be combined together to create an empty text file with the following name:

<DASHBOARDS_DIR>/<Slicer_DASHBOARD_SUBDIR>/<Slicer_DIRECTORY_BASENAME>-<Slicer_DIRECTORY_IDENTIFIER>-build - ${CTEST_BUILD_NAME}-${CTEST_BUILD_CONFIGURATION}-${SCRIPT_MODE}.txt


Publish and version control the dashboard scripts

To backup your scripts and help the Slicer community setup additional dashboard clients by adapting your scripts, consider publishing your scripts in a GitHub repository.

Assuming your organization is named Awesome, you could create the Github project: Awesome/SlicerDashboardScripts.

For example, the official Slicer dashboard script are published here: https://github.com/Slicer/DashboardScripts


Scheduling on Unix-like

So that your dashboard can automatically start at 11pm daily, you could add an entry similar to the following one in your crontab. (You could run crontab -e to edit the current user cron list and crontab -l to dislay the current list.)

0 23 * * * /path/to/cmake-3.13.4/bin/ctest -S /Users/username/DashboardScripts/<MachineName>_<OperatingSystem>-slicer_preview_nightly.cmake -VV -O /Users/username/Dashboards/Logs/<MachineName>_<OperatingSystem>-slicer_preview_nightly.cmake.log

Scheduling on Linux

Install SlicerBuildEnvironment docker image

Read more details at https://github.com/Slicer/SlicerBuildEnvironment#readme

mdir /home/username/bin
env_name=qt5-centos7
script=/home/username/bin/slicer-buildenv-${env_name}
docker run --rm slicer/buildenv-${env_name} > $script
chmod +x $script


Create a machinename.sh file that performs the build and use SlicerBuildEnvironment docker image

To use SlicerBuildEnvironment docker images, create a wrapper script like the following updating username and machinename to match your system:

FileName: /home/username/Dashboards/DashboardScripts/machinename.sh

export DISPLAY=:0.0

# Changing directory is required by "slicer-buildenv-qt5-centos7-latest" script
cd  /home/username/Dashboards

# Download up-to-date slicer/buildenv-qt5-centos7:latest image
/home/username/bin/slicer-buildenv-qt5-centos7-latest update

# Slicer dashboard settings
docker_args="-e run_ctest_with_disable_clean=${run_ctest_with_disable_clean-FALSE}"
docker_args+=" -e run_ctest_with_update=${run_ctest_with_update-TRUE}"
docker_args+=" -e run_ctest_with_test=${run_ctest_with_test-FALSE}" # XXX Re-enable testing after slicer/slicer-test images have been updated

# Slicer 'Preview' release
time /home/username/bin/slicer-buildenv-qt5-centos7-latest \
  --args "${docker_args}" \
ctest -S /work/DashboardScripts/machinename-slicer_preview_nightly.cmake -VV -O /work/Logs/machinename-slicer_preview_nightly.log


Scheduling on macOS

macOS is deprecating the use of cron in favor of launchd.

Create a file $HOME/Library/LaunchAgents/org.slicer.NightlyDashboard.plist

This is Jim's plist file which has extra EnvironmentVariables to get through his firewall.

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
  <key>Label</key>
  <string>org.slicer.NightlyDashboard</string>

  <key>ProgramArguments</key>
  <array>
    <string>/usr/local/bin/ctest</string>
    <string>-S</string>
    <string>/Users/millerjv/Projects/Slicer4-Dashboard/SlicerDashboardScript.cmake</string>
  </array>

  <key>EnvironmentVariables</key>
  <dict>
        <key>ALL_PROXY</key>
        <string>proxy.research.ge.com:8080</string>
        <key>http_proxy</key>
        <string>proxy.research.ge.com:8080</string>
        <key>RSYNC_PROXY</key>
        <string>proxy.research.ge.com:8080</string>
  </dict>

  <key>Nice</key>
  <integer>1</integer>

  <key>StartCalendarInterval</key>
  <dict>
        <key>Hour</key>
        <integer>1</integer>
        <key>Minute</key>
        <integer>03</integer>
  </dict>

  <key>StandardErrorPath</key>
  <string>/tmp/org.slicer.NightlyDashboard.err</string>

  <key>StandardOutPath</key>
  <string>/tmp/org.slicer.NightlyDashboard.out</string>
</dict>
</plist>

You can manually load this agent using

$ launchctl load $HOME/Library/LaunchAgents/org.slicer.NightlyDashboard.plist

and the agent will be reloaded automatically on a reboot.

It seems I have to be logged onto the console for the launch agent to get installed and run. What I do is log on, then select "Login Window..." so that other people can log onto the console. This is suboptimal as I need to do this after each reboot of the system.


Scheduling on Windows

Create a .bat file that performs the build

For example, a clean nightly build can be performed by a batch file like this:


rmdir /S /Q "C:\D\P\Slicer-0-build"
"c:\Program Files (x86)\CMake\bin\ctest.exe" -S "C:\D\DashboardScripts\overload-vs2015-slicer_preview_nightly.cmake" -C Release -VV -O C:\D\Logs\overload-vs2015-slicer_preview_nightly.txt

Create a new scheduled task that runs the .bat file

  • Windows XP: Create a new scheduled task at Control Panel / Scheduled Tasks / Add Scheduled
  • Windows 7: Task scheduler can be found at Start Menu / All Programs / Accessories / System Tools / Task Scheduler.

Setting up a continuous dashboard

Similarly if you want to setup a continuous dashboard,

$ cp <MachineName>_<OperatingSystem>-slicer_preview_nightly.cmake <MachineName>_<OperatingSystem>-slicer_preview_continuous.cmake

Edit <MachineName>_<OperatingSystem>-slicer_preview_continuous.cmake and set

set(SCRIPT_MODE "*continuous*")

Then add the corresponding entry in crontab so that it starts everyday at 6am:

0 6 * * * /path/to/cmake-3.13.4/bin/ctest -S /Users/JOE/DashboardScripts/<MachineName>_<OperatingSystem>-slicer_preview_continuous.cmake -VV -O /Users/JOE/Dashboards/Logs/<MachineName>_<OperatingSystem>-slicer_preview_nightly.log

The output of the build is contained in ctest_package_make_package_output.txt in your slicer build directory, you can check this file if something went wrong.

Factory machines setup

Tool used for task scheduling is described here: Documentation/Nightly/Developers/Factory

Dashboard scripts used on the factory are available here: https://github.com/Slicer/DashboardScripts

More details available here:

Remarks

Setting up a dashboard on a Windows machine

Disabling TortoiseSVN Icon Overlay

If you're using an interface for version control such as TortoiseSVN, make sure in the Icon Overlay settings that the status cache is set to None.

Make sure the status cache is set to "None."

Keep short path

Keep the paths to your Nightly, Continuous, and Experimental directories as terse as possible. A good standard is C:\D for dashboards, and C:\D\<N,C,E> subdirectories for Nightly, Continuous, and Experimental. Otherwise, CMake will choke on the paths.

How can I prevent the “… has stopped working” window

As documented here, set registry key HKEY_LOCAL_MACHINE\Software\Microsoft\.NETFramework\DbgJITDebugLaunchSetting value to 1.

Value 1 simply return control. This results in a stack dump, after which the process is terminated.

This has been documented while trying to prevent the dialog "Microsoft Visual Studio 8 has stopped working" from appearing when Slicer extensions dashboard were running. The details associated with the dialog were:

Problem signature:
  Problem Event Name:	BEX
  Application Name:	devenv.exe
  Application Version:	9.0.21022.8
  Application Timestamp:	47317b3d
  Fault Module Name:	VCProjectEngine.dll_unloaded
  Fault Module Version:	0.0.0.0
  Fault Module Timestamp:	47318038
  Exception Offset:	72dbdce0
  Exception Code:	c0000005
  Exception Data:	00000008

Reference:

Lockhunter: Unlock directories or folders

Often on Windows, once a dashboard build is started, it is impossible to delete anything from the source or build directory. Windows will report that this file is currently in use by another program, or "locking" it. For this, we recommend installing Lockhunter.

Lockhunter screenshot