Roundtable Commander Jenkins

Roundtable Commander Jenkins Plugin

The Roundtable Commander plugin for Jenkins provides a standard SCM step that can be used in Jenkins projects/pipelines to fetch sources from Roundtable TSMS repositories and made those available for subsequent steps of the build project/pipeline.

Install the UpdateSites Manager plugin

The easiest way to install the Roundtable Commander Jenkins plugin is to use our dedicated Update Center site with the "UpdateSites Manager" plugin.

To do so, go to "Manage Jenkins -> Plugins" menu and search for it in the "Available plugins" tab, select it and choose "Install" (normally no restart is needed).

Add the Roundtable Commander update site in UpdateSites Manager

Next the Roundtable Commander update site needs to be added to the list of custom update sites in "UpdateSites Manager", go to "Manage Jenkins -> Uncategorized" section and select "Manage UpdateSites".

Inside the "UpdateSites Manager" configuration page select "Add" and use the following details for the Roundtable Commander update site:

id: acorn-update-center
URL: http://roundtable.acorn.ro/update/update-center.json

Make sure you check the "Need CA Certificate" box and copy the following text in the certificate field:

Install the Roundtable Commander plugin

After adding the Roundtable Commander update site you can install the plugin by going to the "Manage Jenkins -> Plugins" menu and search for the "Roundtable Commander" plugin into the "Available plugins" tab.

If not found make sure you refresh the list of available plugins by hitting the "Check now" button, this will read the information from the update site added previously.

Select the plugin and choose "Install", normally no restart is needed so you should be able to use it right away in build projects/pipelines.

The Roundtable Commander plugin has a few options that can be configured through the "Manage Jenkins -> System" menu, scroll down to the "Roundtable Commander plugin" section - mainly those settings will serve as a default values for the SCM step when used in build projects/pipelines.

This is the place where you enter the registration information, just copy the content of the license file and paste it into the "Registration" form. If the license information is not provided when trying to use the Roundtable Commander SCM step in one build project/pipeline the following error will appear in the output console and no source is downloaded from the Roundtable TSMS repository.

The Roundtable Commander will be available as a regular SCM step in any "freestyle" build project that is normally used for software builds by combining SCM with other build systems.

While the project is build the information about the sources downloaded from the Roundtable TSMS repository will be available in the output console.

When the project build is completed the build will show a status similar to the following one, if there weren't any errors in the build.

The plugin will also provide the change log, proven there were any changes compared to the previous run. If the shallow depth is set to anything but "0" (all history) then the changes history will be "merged" is a smaller number of entries based on the depth set.

The sources downloaded from the Roundtable TSMS repositories will be available on the build workspace - if multiple workspaces were downloaded the workspace will contain the content of the last workspace checked-out during the build.

Using Roundtable Commander SCM step in a "Pipeline" project is also possible, to obtain the correct pipeline syntax you can use the "Snippet Generator", select the "checkout" step and pick the "Roundtable Commander" from the list of the SCM providers. Fill in all the connection and workspace selection details like for the freestyle project and generate the script.

If the project contains a Jenkins "pipeline script" then instead of providing the pipeline script in the Jenkins build project select "Pipeline script from SCM" from the "Definition" drop-down and then select the Roundtable Commander SCM provider and fill in the required information, make sure you update the "Script Path" (defaults to "Jenkinsfile").

When building the pipeline project you should see a similar output in the build console as for a freestyle project, only slightly different - the "lightweight checkout" is not supported as for now there is no option to checkout a single file from the repository (the Jenkinsfile script) so is better to keep the script file inside the same repository you need for the rest of the build process.