Documentation/Nightly/Developers/Build ExtensionsIndex

From Slicer Wiki
Jump to: navigation, search
Home < Documentation < Nightly < Developers < Build ExtensionsIndex


This page explain how to build an ExtensionsIndex.

Think of the ExtensionsIndex as a repository containing a list of extension description files (*.s4ext) used by the Slicer extensions build system to build, test, package and upload extensions on an extensions server.

Once uploaded on an extensions server, within Slicer, extensions can be installed using the extensions manager.

There are two possible approaches to build it:

Manual build

Locally building an extension index provides a convenient way to:

Given a directory containing one or more extension description files, it is possible to manually configure and build the associated extensions specifying the following CMake options:

Slicer_DIR Path to Slicer build tree
Slicer_EXTENSION_DESCRIPTION_DIR Path to folder containing extension description files

Optionally, it is also possible to specify:

CMAKE_BUILD_TYPE On unix-like platform, should match the build type of the associated Slicer build directory
Slicer_UPLOAD_EXTENSIONS By default set to OFF.
If enabled, extension builds will be submitted to Slicer dashboard and associated packages will be uploaded to extensions server
MIDAS_PACKAGE_URL MIDAS extensions server URL speciManualfying where the extension should be uploaded. For example
MIDAS_PACKAGE_EMAIL Email allowing to authenticate to the extensions server.
MIDAS_PACKAGE_API_KEY Token allowing to authenticate to the extensions server.

Dashboard driven build

Continuous and nightly extension dashboards are setup on the slicer factory machine maintained by Kitware folks.

Assuming you install your own extensions server, you could also distribute your own set of extensions.


  • Setting both nightly and continuous builds of the extensions is a key component of the Slicer continuous integration process.
  • The images reported below illustrate the dashboard submissions associated with the continuous and nightly builds of Slicer extensions associated to both Slicer trunk and Slicer 4.1.1.