View source for Documentation/4.10/Developers/Build system/SlicerBot

= Overview =

Each time a task associated to the wiki, repository or bug tracker is automated by the execution of a script on a machine, the ''machine user'' running such script will be identified as <code>SlicerBot</code>.

= Type of SlicerBot =

== Wiki ==

This SlicerBot user publishes update on the Slicer wiki. The associated wiki account is [[User:UpdateBot|UpdateBot]]

== Git ==

This SlicerBot user can commit changes to a defined subset of Slicer repositories. The associated github account is [https://github.com/slicerbot slicerbot] and it can commit changes to [https://github.com/orgs/Slicer/teams/slicerbot-team/repositories all repositories associated] with the <code>slicerbot-team</code> in [https://github.com/Slicer Slicer] github organization.

As documented on [https://developer.github.com/guides/managing-deploy-keys/#machine-users managing deploy keys] Github guide, there are multiple approaches to grant a machine ''access'' to a repository. We chose the ''machine user'' one.

In a nutshell, the steps to configure a ''git machine user'' are:

* Generate SSK keys without pass-phrase:

 ssh-keygen -t rsa -C "slicerbot@slicer.org"

* Add the generated <code>id_rsa.pub</code> key to the list of SSH keys associated with [https://github.com/slicerbot slicerbot] user. Each key '''*SHOULD*''' be named <code>slicerbot-&lt;hostname&gt;</code>. For example <code>slicerbot-factory-south-ubuntu</code>

* Setup git username and email:

 git config --global user.name "Slicer Bot"
 git config --global user.email "slicerbot@slicer.org"

=== SVN2GitHub synchronization ===

* See [[{{FULLPAGENAME}}/SVN2GitHub|SVN2GitHub]]

== HtmlDoc ==

See https://github.com/Slicer/apidocs.slicer.org#readme

== Packages ==

These bots can upload packages on http://slicer.kitware.com/midas3

=== Applications ===

The group with "write" permission on the [http://slicer.kitware.com/midas3/folder/249 NA-MIC/Public/Slicer/Packages/Applications/] folder is <code>Slicer App Packages Uploader</code>

Bots currently associated with this group are:

* [http://slicer.kitware.com/midas3/user/44 Slicerbot Kitware]
* [http://slicer.kitware.com/midas3/user/465 Slicerbot Perklab]

Organization of packages listed on https://download.slicer.org is specified on https://github.com/mhalle/slicer4-download

=== Extensions ===

Extensions are organized in three different folders:
* [http://slicer.kitware.com/midas3/folder/254 NA-MIC/Public/Slicer/Packages/Extensions/Nightly]
* [http://slicer.kitware.com/midas3/folder/1568 NA-MIC/Public/Slicer/Packages/Extensions/Continuous]
* [http://slicer.kitware.com/midas3/folder/253 NA-MIC/Public/Slicer/Packages/Extensions/Experimental]

Currently, any user associated with the <code>Experimental Uploader</code> group as "write" permission to these folders.

In additional to users who [[Documentation/{{documentation/version}}/Developers/Tutorials/BuildTestPackageDistributeExtensions#Step-by-step:_How_to_create.2C_publish_and_distribute_an_extension_.3F|requested]] to be added to the <code>Experimental Uploaded</code> group, the following bots are included:

* [http://slicer.kitware.com/midas3/user/44 Slicerbot Kitware]
* [http://slicer.kitware.com/midas3/user/465 Slicerbot Perklab]

Note: The concept of channels is being discussed (See [http://www.na-mic.org/Bug/view.php?id=2334 #2334]). By default, only extension associated with the "official" would be listed in the extensions manager. User will have the option to select other channels.

= SlicerBots =

As of 2018-03-07, the machines with SlicerBot accounts are:
* factory
* factory-south
* factory-south-ubuntu
* metroplex
* overload