Difference between revisions of "Documentation/4.1/Developers/Tutorials/BuildTestPackageDistributeExtensions"

From Slicer Wiki
Jump to: navigation, search
(Added a wiki page for describing procedures related to extensions (this allows easy editing by anyone and avoids directly linking to an external site at many places))
 
(Prepend documentation/versioncheck template. See http://na-mic.org/Mantis/view.php?id=2887)
 
(5 intermediate revisions by one other user not shown)
Line 1: Line 1:
 +
<noinclude>{{documentation/versioncheck}}</noinclude>
 
=Create a new extension and adding it to the extension index=
 
=Create a new extension and adding it to the extension index=
 
[https://github.com/Slicer/ExtensionsIndex/blob/master/README.md#readme See instructions on github]
 
[https://github.com/Slicer/ExtensionsIndex/blob/master/README.md#readme See instructions on github]
 +
 +
==Obtain an API key to submit on the extension server==
 +
[https://github.com/Slicer/ExtensionsIndex#setting-up-an-account-and-obtaining-an-api-key See instructions on github]
 +
 +
==Upload an extension in the experimental folder==
 +
[https://github.com/Slicer/ExtensionsIndex#manual-build See instructions on github]
 +
 +
==Contribute an extension description file ==
 +
[https://github.com/Slicer/ExtensionsIndex#contributing See instructions on github]
  
 
=Requesting an extension version update=
 
=Requesting an extension version update=
Prepare an update repository/branch
+
 
 +
Note: this procedure is still under discussion.
 +
 
 
* Create a branch named update-<YourExtensionName> in the clone of your forked ExtensionsIndex
 
* Create a branch named update-<YourExtensionName> in the clone of your forked ExtensionsIndex
 
* Regenerate the <YourExtensionName>.s4ext file by configuring your extension with CMake
 
* Regenerate the <YourExtensionName>.s4ext file by configuring your extension with CMake

Latest revision as of 07:20, 14 June 2013

Home < Documentation < 4.1 < Developers < Tutorials < BuildTestPackageDistributeExtensions


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


Create a new extension and adding it to the extension index

See instructions on github

Obtain an API key to submit on the extension server

See instructions on github

Upload an extension in the experimental folder

See instructions on github

Contribute an extension description file

See instructions on github

Requesting an extension version update

Note: this procedure is still under discussion.

  • Create a branch named update-<YourExtensionName> in the clone of your forked ExtensionsIndex
  • Regenerate the <YourExtensionName>.s4ext file by configuring your extension with CMake
  • Commit the <YourExtensionName>.s4ext file to your cloned ExtensionIndex repository (provide a meaningful commit comment)
  • Push modifications to your ExtensionIndex fork on github
  • Submit a pull request to https://github.com/Slicer/ExtensionsIndex (provide a meaningful commit comment)