tecnalia-advancedmanufacturing-robotics / industrial_ci

Easy continuous integration repository for ROS repositories

Industrial CI

CI (Continuous Integration) configuration for ROS (Robot Operating System).

Table of Contents

• Detailed documentation
• Introduction
• Quick Start
  • Concrete examples of config files
• Metrics

Detailed documentation

Other than the brief introduction in this page, you can also check the detailed doc here.

Introduction

This package contains CI (Continuous Integration) configuration that any ROS-powered packages can commonly use. Some notable feature:

• Checks if your package builds, installs without issues. If unit/system tests are defined run them. ROS Prerelease Test can optionally be run.
• Proven to cover the general requirements of the ROS-based robotics repositories. Easily configurable.
• Users can add custom pre/post processes.
• Covers ROS Indigo, Jade, Kinetic distribution.
• As of January 2017, this repo provides configuration for Travis CI only, although it should be easily deployed from other CI services.

For a brief overall introduction, you could also check a presentation:

• ROS-Industrial community meeting

Quick Start

With a few steps, you can start in your client repository using CI confiurations stored in industrial_ci.

1. Activate CI on your github repository.

• For Travis CI), you may do so either at https://travis-ci.org/profile/YOUR_GITHUB_ORGANIZATION or at https://travis-ci.org/profile/YOUR_GITHUB_USER (depending on where your repository sits).

2. In .travis.yml file in your client repo, add in "install" section a sentence git clone https://github.com/ros-industrial/industrial_ci.git .ci_config, like below:

install:
  - git clone https://github.com/ros-industrial/industrial_ci.git .ci_config
script:
  - .ci_config/travis.sh

• Note: The name .ci_config is NO longer REQUIRED for the cloned folder starting version 0.3.2; you can pick any name as long as the folder is hidden (by being prepended by ".").

Concrete examples of config files

For most of the cases, For development branch intended for ROS Indigo:

• ros_canopen/.travis.yml

For development branch intended for ROS Indigo and newer distros:

• industrial_core/.travis.yml: Indigo and Jade compatible.
• leap_motion/.travis.yml: Indigo, Jade, Kinetic compatible. Also runs ROS Prerelease Test.

For development branch intended for ROS Kinetic:

• industrial_core/.travis.yml

For more complexed example:

• .travis.yml from the same repo. You can see how options are used.

Metrics

There might not an easy way to precisely count how many repositories out there are using industrial_ci. Counting that number isn't even our priority at all, but we're often simply curious. Here's some ways that give us some clues for the usage metrics:

• Searching Github repos that contain string industrial_ci) (with some duplicates. Excluding industrial_ci repo): As of Jan 20, 2017, it returns 142 repos.

• Github-->`Graphs`-->`Traffic` view (visible only to admins). Below is taken on Jan 20, 2017:

  

EoF