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

From Slicer Wiki
Jump to: navigation, search
(Nightly -> 4.2)
 
Line 12: Line 12:
 
* Consider also reading [https://github.com/Slicer/ExtensionsIndex/wiki/Extension-description-file Extension description file format]
 
* Consider also reading [https://github.com/Slicer/ExtensionsIndex/wiki/Extension-description-file Extension description file format]
  
−
=Requesting an extension version update=
+
= Requesting an extension version update {{updated}} =
  
−
{{note}} this procedure is still under discussion.
+
On your local fork, the idea is to create the following topic branches:
 +
* <code>update-<YourExtensionName></code> based of [https://github.com/Slicer/ExtensionsIndex/tree/master <code>master</code>] integration branch.
 +
* <code>update-<YourExtensionName>-4.2.0</code> based of [https://github.com/Slicer/ExtensionsIndex/tree/4.2.0 <code>4.2.0</code>] integration branch.
 +
 
 +
== Extensions build against Slicer trunk ==
 +
 
 +
The following instruction describes how to contribute extension description file updates for an extension being built against slicer trunk.
  
 
* Update the master branch of both your local clone and your online ExtensionsIndex fork
 
* Update the master branch of both your local clone and your online ExtensionsIndex fork
Line 25: Line 31:
 
</pre>
 
</pre>
 
* 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
 +
<pre>
 +
git checkout -b update-<YourExtensionName>
 +
</pre>
 
* Regenerate the <YourExtensionName>.s4ext file by configuring your extension with CMake
 
* 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)
 
* Commit the <YourExtensionName>.s4ext file to your cloned ExtensionIndex repository (provide a meaningful commit comment)
 
* Push modifications to your ExtensionIndex fork on github
 
* Push modifications to your ExtensionIndex fork on github
 
* Submit a pull request to https://github.com/Slicer/ExtensionsIndex (provide a meaningful commit comment)
 
* Submit a pull request to https://github.com/Slicer/ExtensionsIndex (provide a meaningful commit comment)
 +
 +
== Extensions build against Slicer {{Documentation/currentversion}}  ==
 +
 +
The following instruction describes how to contribute extension description file updates for an extension being built against slicer trunk.
 +
 +
* Update the 4.2.0 branch of both your local clone and your online ExtensionsIndex fork
 +
<pre>
 +
git add upstream git://github.com/Slicer/ExtensionsIndex  # Add reference to the authoritative ExtensionsIndex
 +
git fetch upstream                                        # Fetch change of the authoritative ExtensionsIndex
 +
git checkout 4.2.0                                        # Checkout 4.2.0
 +
git reset --hard upstream/4.2.0                            # Reset your local 4.2.0 branch using the authoritative 4.2.0
 +
git push origin 4.2.0                                      # Update the 4.2.0 branch of your online fork
 +
</pre>
 +
* Create a branch named update-<YourExtensionName>-4.2.0 in the clone of your forked ExtensionsIndex
 +
<pre>
 +
git checkout -b update-<YourExtensionName>-4.2.0
 +
</pre>
 +
* 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)
 +
 +
 +
<gallery widths=800px heights=300px perrow=1>
 +
File:Extensions-4.2-pull-request-step1.png|1. Create Pull Request
 +
File:Extensions-4.2-pull-request-step2.png|2. Select base
 +
File:Extensions-4.2-pull-request-step3.png|3. Send Pull Request
 +
File:Extensions-4.2-pull-request-step4.png|4. Verify
 +
</gallery>

Revision as of 15:18, 9 November 2012

Home < Documentation < 4.2 < Developers < Tutorials < BuildTestPackageDistributeExtensions

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

Requesting an extension version update   UPDATED

On your local fork, the idea is to create the following topic branches:

  • update-<YourExtensionName> based of master integration branch.
  • update-<YourExtensionName>-4.2.0 based of 4.2.0 integration branch.

Extensions build against Slicer trunk

The following instruction describes how to contribute extension description file updates for an extension being built against slicer trunk.

  • Update the master branch of both your local clone and your online ExtensionsIndex fork
git add upstream git://github.com/Slicer/ExtensionsIndex   # Add reference to the authoritative ExtensionsIndex
git fetch upstream                                         # Fetch change of the authoritative ExtensionsIndex
git checkout master                                        # Checkout master
git reset --hard upstream/master                           # Reset your local master branch using the authoritative master 
git push origin master                                     # Update the master branch of your online fork
  • Create a branch named update-<YourExtensionName> in the clone of your forked ExtensionsIndex
git checkout -b update-<YourExtensionName>
  • 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)

Extensions build against Slicer 4.10

The following instruction describes how to contribute extension description file updates for an extension being built against slicer trunk.

  • Update the 4.2.0 branch of both your local clone and your online ExtensionsIndex fork
git add upstream git://github.com/Slicer/ExtensionsIndex   # Add reference to the authoritative ExtensionsIndex
git fetch upstream                                         # Fetch change of the authoritative ExtensionsIndex
git checkout 4.2.0                                         # Checkout 4.2.0
git reset --hard upstream/4.2.0                            # Reset your local 4.2.0 branch using the authoritative 4.2.0 
git push origin 4.2.0                                      # Update the 4.2.0 branch of your online fork
  • Create a branch named update-<YourExtensionName>-4.2.0 in the clone of your forked ExtensionsIndex
git checkout -b update-<YourExtensionName>-4.2.0
  • 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)


  • 1. Create Pull Request

  • 2. Select base

  • 3. Send Pull Request

  • 4. Verify

Retrieved from "https://www.slicer.org/w/index.php?title=Documentation/4.2/Developers/Tutorials/BuildTestPackageDistributeExtensions&oldid=29147"