Documentation/Nightly/Developers/Build ExtensionsIndex - Revision history

Lasso: moved to readthedocs

2021-09-28T20:18:20Z

moved to readthedocs

Show changes

JChris.FillionR: /* Manual build */

2018-01-12T03:40:18Z

Manual build

JChris.FillionR at 03:37, 12 January 2018

2018-01-12T03:37:39Z

JChris.FillionR: /* Build your own set of extensions against Slicer trunk build tree */

2017-08-29T19:32:11Z

Build your own set of extensions against Slicer trunk build tree

Pieper: /* Build your own set of extensions against Slicer trunk build tree */

2016-12-05T14:10:59Z

Build your own set of extensions against Slicer trunk build tree

Lasso: /* Dashboard driven build */

2016-07-21T21:13:39Z

Dashboard driven build

JChris.FillionR at 16:57, 14 January 2014

2014-01-14T16:57:48Z

Pieper: /* Build your own set of extensions against Slicer trunk build tree */

2014-01-13T22:45:29Z

Build your own set of extensions against Slicer trunk build tree

JChris.FillionR: /* Manual build */

2013-08-16T17:50:26Z

Manual build

JChris.FillionR: /* Manual build */

2013-08-16T17:49:23Z

Manual build

@@ Line 42: / Line 42: @@
      <td><code>[http://www.cmake.org/cmake/help/v2.8.8/cmake.html#variable:CMAKE_BUILD_TYPE CMAKE_BUILD_TYPE]</code></td>
      <td>On unix-like platform, should match the build type of the associated Slicer build directory</td>
    </tr>
    <tr>

@@ Line 92: / Line 92: @@
 there are two options:
 # Build the target `ExperimentalUpload` associated with each extensions
-# Configure (or re-configure) the project passing the options `Slicer_UPLOAD_EXTENSIONS`,
+-->
 `MIDAS_PACKAGE_URL`, `MIDAS_PACKAGE_EMAIL` and `MIDAS_PACKAGE_API_KEY`
@@ Line 100: / Line 102: @@
 -->
 ==== Extension build, test, package and upload using `ExperimentalUpload` target ====
@@ Line 105: / Line 108: @@
 $ cd SlicerExtensionsCustomIndex-build
 $ cd foo-build
-$ cmake -DMIDAS_PACKAGE_URL:STRING=http://slicer.kitware.com/midas3 \
+$ cmake -DCTEST_MODEL:STRING=Experimental -DMIDAS_PACKAGE_URL:STRING=http://slicer.kitware.com/midas3 \
   -DMIDAS_PACKAGE_EMAIL:STRING=jchris.fillionr@kitware.com \
   -DMIDAS_PACKAGE_API_KEY:STRING=a0b012c0123d012abc01234a012345a0 .
@@ Line 128: / Line 131: @@
 File:SlicerExtensionsCustomIndex-CDash-Foo-Extension-Experimental.png
 </gallery>
+-->
 ==== Extensions build, test, package and upload using `Slicer_UPLOAD_EXTENSIONS` option ====
@@ Line 137: / Line 140: @@
   -DSlicer_EXTENSION_DESCRIPTION_DIR:PATH=/path/to/SlicerExtensionsCustomIndex \
   -DCMAKE_BUILD_TYPE:STRING=Release \
   -DSlicer_UPLOAD_EXTENSIONS:BOOL=ON \
   -DMIDAS_PACKAGE_URL:STRING=http://slicer.kitware.com/midas3 \

@@ Line 92: / Line 92: @@
 there are two options:
-# [Build the target `ExperimentalUpload` associated with each extensions](#extension-build-test-package-and-upload-using-experimentalupload-target)
+# Build the target `ExperimentalUpload` associated with each extensions
-# [Configure (or re-configure) the project passing the options `Slicer_UPLOAD_EXTENSIONS`,
+# Configure (or re-configure) the project passing the options `Slicer_UPLOAD_EXTENSIONS`,
-`MIDAS_PACKAGE_URL`, `MIDAS_PACKAGE_EMAIL` and `MIDAS_PACKAGE_API_KEY`](#extensions-build-test-package-and-upload-using-slicer_upload_extensions-option)
+`MIDAS_PACKAGE_URL`, `MIDAS_PACKAGE_EMAIL` and `MIDAS_PACKAGE_API_KEY`
 ''Note that on Mac you may need to pass in the file paths to git and svn as [http://www.na-mic.org/Bug/view.php?id=4311 described in issue #4311].''
 ==== Extension build, test, package and upload using `ExperimentalUpload` target ====

← Older revision		Revision as of 14:10, 5 December 2016
Line 96:		Line 96:
	`MIDAS_PACKAGE_URL`, `MIDAS_PACKAGE_EMAIL` and `MIDAS_PACKAGE_API_KEY`](#extensions-build-test-package-and-upload-using-slicer_upload_extensions-option)		`MIDAS_PACKAGE_URL`, `MIDAS_PACKAGE_EMAIL` and `MIDAS_PACKAGE_API_KEY`](#extensions-build-test-package-and-upload-using-slicer_upload_extensions-option)

		+	''Note that on Mac you may need to pass in the file paths to git and svn as [http://www.na-mic.org/Bug/view.php?id=4311 described in issue #4311].''

	==== Extension build, test, package and upload using `ExperimentalUpload` target ====		==== Extension build, test, package and upload using `ExperimentalUpload` target ====

@@ Line 200: / Line 200: @@
 * Setting both nightly and continuous builds of the extensions is a key component of the Slicer continuous integration process.
-* By customizing the [https://github.com/Slicer/Slicer/blob/master/Extensions/CMake/SlicerExtensionsDashboardScript.TEMPLATE.cmake extension template dashboard script], it is possible to easily setup dashboard client submitting to [http://slicer.cdash.org/index.php?project=Slicer4 CDash].
+* By customizing the [https://github.com/Slicer/Slicer/blob/master/Extensions/CMake/SlicerExtensionsDashboardScript.TEMPLATE.cmake extension template dashboard script], it is possible to easily setup dashboard client submitting to [http://slicer.cdash.org/index.php?project=Slicer4 CDash]. See example dashboard scripts that are used on official Slicer build machines [https://github.com/Slicer/DashboardScripts here] (note that these scripts are more complex than the template to allow code reuse between different configurations, but they are tested regularly and so guaranteed to work).
 * 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.

@@ Line 81: / Line 81: @@
 $ cd ExtensionsIndex-build
 $ export SLICER=${HOME}/slicer4/latest/Slicer
-$ cmake -DSlicer_DIR:PATH=${SLICER}-superr/Slicer-build \
+$ cmake -DSlicer_DIR:PATH=${SLICER}-SuperBuild-Release/Slicer-build \
   -DSlicer_EXTENSION_DESCRIPTION_DIR:PATH=../ExtensionsIndex \
   -DCMAKE_BUILD_TYPE:STRING=Release \
@@ Line 114: / Line 114: @@
 To simply submit the configure/build/test results on CDash skipping the upload part, building target `Experimental`
-is sufficient. This is expected to work only for Slicer >= 4.1.2. See issue [#2166](http://www.na-mic.org/Bug/view.php?id=2166)
+is sufficient. This is expected to work only for Slicer >= 4.1.2. See issue [http://www.na-mic.org/Bug/view.php?id=2166 #2166]
 <pre>
@@ Line 141: / Line 141: @@
 </pre>
-=== Build your own set of extensions against Slicer 4.1.1 build tree ===
+=== Build your own set of extensions against Slicer {{Documentation/currentversion}} build tree ===
 Prerequisites:
 # Folder <code>SlicerExtensionsCustomIndex</code> contains the [[Documentation/{{documentation/version}}/Developers/Extensions/DescriptionFile|extension description files]] of your choice
-# Slicer 4.1.1 has been checkout into <code>/path/to/Slicer-411</code> and built into <code>/path/to/Slicer-411-SuperBuild-Release</code>
+# Slicer {{Documentation/currentversion}} has been checkout into <code>/path/to/Slicer-411</code> and built into <code>/path/to/Slicer-411-SuperBuild-Release</code>
 # To upload extension(s) on the [[Documentation/{{documentation/version}}/Developers/Extensions/Server|extensions server]], an [[Documentation/{{documentation/version}}/Developers/Tutorials/ObtainExtensionServerApiKey|API key]] has been obtained.
@@ Line 171: / Line 171: @@
 </pre>
-=== Build slicer extensions associated with Slicer 4.1.1 ===
+=== Build slicer extensions associated with Slicer {{Documentation/currentversion}} ===
 Considering the following assumption:
-# Slicer trunk has been checkout into `/path/to/Slicer-411` and built into `/path/to/Slicer-411-SuperBuild-Release`
+# Slicer trunk has been checkout into `/path/to/Slicer-{{Documentation/currentversion}}` and built into `/path/to/Slicer-{{Documentation/currentversion}}-SuperBuild-Release`
 The associated extensions could be built doing:
 <pre>
-$ git clone git://github.com/Slicer/ExtensionsIndex.git -b 4.1.1 SlicerExtensionsIndex-411
+$ git clone git://github.com/Slicer/ExtensionsIndex.git -b 4.3 SlicerExtensionsIndex-4.3
-$ mkdir SlicerExtensionsIndex-411-build
+$ mkdir SlicerExtensionsIndex-4.3-build
-$ cd SlicerExtensionsIndex-411-build
+$ cd SlicerExtensionsIndex-4.3-build
-$ cmake -DSlicer_DIR:PATH=/path/to/Slicer-411-SuperBuild-Release/Slicer-build \
+$ cmake -DSlicer_DIR:PATH=/path/to/Slicer-4.3-SuperBuild-Release/Slicer-build \
-  -DSlicer_EXTENSION_DESCRIPTION_DIR:PATH=/path/to/SlicerExtensionsIndex-411 \
+  -DSlicer_EXTENSION_DESCRIPTION_DIR:PATH=/path/to/SlicerExtensionsIndex-4.3 \
   -DCMAKE_BUILD_TYPE:STRING=Release \
-  /path/to/Slicer-411/Extensions/CMake
+  /path/to/Slicer-4.3/Extensions/CMake
 $ make
 </pre>

@@ Line 75: / Line 75: @@
 <pre>
-$ ls SlicerExtensionsCustomIndex
+$ ls ExtensionsIndex
 foo.s4ext
 bar.s4ext
-$ mkdir SlicerExtensionsCustomIndex-build
+$ mkdir ExtensionsIndex-build
-$ cd SlicerExtensionsCustomIndex-build
+$ cd ExtensionsIndex-build
-$ cmake -DSlicer_DIR:PATH=/path/to/Slicer-master-SuperBuild-Release/Slicer-build \
+$ export SLICER=${HOME}/slicer4/latest/Slicer
-  -DSlicer_EXTENSION_DESCRIPTION_DIR:PATH=/path/to/SlicerExtensionsCustomIndex \
+$ cmake -DSlicer_DIR:PATH=${SLICER}-superr/Slicer-build \
   -DCMAKE_BUILD_TYPE:STRING=Release \
-  /path/to/Slicer-master/Extensions/CMake
+  ${SLICER}/Extensions/CMake
 $ make
 </pre>

← Older revision		Revision as of 17:50, 16 August 2013
Line 22:		Line 22:


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

@@ Line 18: / Line 18: @@
 Locally building an extension index provides a convenient way to:
-* check [[Documentation/{{documentation/version}}/Developers/Extensions/DescriptionFile|extension description files]] are valid
+* check extension description files are valid
 * upload one or more extensions at ones to check that Slicer can download and install them