ITK/Policy and Procedure for Adding Dashboards: Difference between revisions
From KitwarePublic
< ITK
Jump to navigationJump to search
| Line 8: | Line 8: | ||
== Procedure == | == Procedure == | ||
The recommended method for dashboard submission is using ctest scripts. | The recommended method for dashboard submission is using [http://www.cmake.org/Wiki/CMake_Scripting_Of_CTest ctest scripts]. | ||
=== Preparing a Dashboard Submission === | === Preparing a Dashboard Submission === | ||
# | # Use a CMake GUI (CMakeSetup on Windows or ccmake on UNIX) or the wizard mode (cmake -i) to edit cache entries. | ||
# Perform a manual build. | # Perform a manual build. | ||
# Run the tests. | # Run the tests. | ||
# As of ITK 3.6, the configure process creates a file ''${ITK_BINARY_DIR}/CMake/itkSampleBuildTest.cmake'' that contains ctest commands to build, test and submit a configuration that is the same as your configured build. | # As of ITK 3.6, the configure process creates a file ''${ITK_BINARY_DIR}/CMake/itkSampleBuildTest.cmake'' that contains ctest commands to build, test and submit a configuration that is the same as your configured build. | ||
# Copy the ''itkSampleBuildTest.cmake'' file to another directory and rename it. | # Copy the ''itkSampleBuildTest.cmake'' file to another directory and rename it. | ||
# Edit this file to select the type of submission to Nightly or Continuous | # Edit this file to select the type of submission to ''Nightly'' or ''Continuous'' | ||
# Select the build type, either Debug, Release, RelWithDebInfo or MinSizeRel | # Select the build type, either ''Debug'', ''Release'', ''RelWithDebInfo'' or ''MinSizeRel'' | ||
# By default, the script will | # By default, the script will | ||
## For nightly submissions, start with an empty binary directory. If your platform takes an unreasonable time to build from a clean directory, you can change '''CTEST_START_WITH_EMPTY_DIRECTORY''' to '''FALSE'''. | ## For nightly submissions, start with an empty binary directory. If your platform takes an unreasonable time to build from a clean directory, you can change '''CTEST_START_WITH_EMPTY_DIRECTORY''' to '''FALSE'''. | ||
## For continuous submissions, start with an empty binary directory the first time it runs each day. Here again, if your platform takes a long time to build from a clean binary directory, you can change '''CTEST_START_WITH_EMPTY_DIRECTORY_ONCE''' to '''FALSE'''. | ## For continuous submissions, start with an empty binary directory the first time it runs each day. Here again, if your platform takes a long time to build from a clean binary directory, you can change '''CTEST_START_WITH_EMPTY_DIRECTORY_ONCE''' to '''FALSE'''. | ||
# Test your ctest script | |||
## ctest -V -S ''your_script_file'' | |||
=== Scheduling a Dashboard Submission === | === Scheduling a Dashboard Submission === | ||
Dashboard submissions can be automatically run with [http://www.cmake.org/Wiki/CMake_Scripting_Of_CTest#Setting_Up_Cron.2FScheduler Cron or Scheduler]. | |||
OS Compiler Debug/Release Static/Shared 32/64 bit Wrapping | OS Compiler Debug/Release Static/Shared 32/64 bit Wrapping | ||
Revision as of 15:43, 28 February 2008
This page is under construction
The nightly and continuous build/test of ITK is essential to its survival. The ITK Dashboard presents dashboard submissions from the ITK community. The dashboards represent unique configurations of hardware platforms, operating systems, compilers, compiler options and ITK options.
Policy
Each dashboard shall present a unique combination of hardware/compiler/OS, optional features and compiler options. The dashboard submitter will monitor the itk dashboard on a routine basis to make sure that the dashboard is reporting as a nightly or continuous build.
Procedure
The recommended method for dashboard submission is using ctest scripts.
Preparing a Dashboard Submission
- Use a CMake GUI (CMakeSetup on Windows or ccmake on UNIX) or the wizard mode (cmake -i) to edit cache entries.
- Perform a manual build.
- Run the tests.
- As of ITK 3.6, the configure process creates a file ${ITK_BINARY_DIR}/CMake/itkSampleBuildTest.cmake that contains ctest commands to build, test and submit a configuration that is the same as your configured build.
- Copy the itkSampleBuildTest.cmake file to another directory and rename it.
- Edit this file to select the type of submission to Nightly or Continuous
- Select the build type, either Debug, Release, RelWithDebInfo or MinSizeRel
- By default, the script will
- For nightly submissions, start with an empty binary directory. If your platform takes an unreasonable time to build from a clean directory, you can change CTEST_START_WITH_EMPTY_DIRECTORY to FALSE.
- For continuous submissions, start with an empty binary directory the first time it runs each day. Here again, if your platform takes a long time to build from a clean binary directory, you can change CTEST_START_WITH_EMPTY_DIRECTORY_ONCE to FALSE.
- Test your ctest script
- ctest -V -S your_script_file
Scheduling a Dashboard Submission
Dashboard submissions can be automatically run with Cron or Scheduler.
OS Compiler Debug/Release Static/Shared 32/64 bit Wrapping
