Skip to content

Commit

Permalink
[ros2] Update version docs, add Galactic and Fortress (#164)
Browse files Browse the repository at this point in the history
Signed-off-by: Louise Poubel <louise@openrobotics.org>
  • Loading branch information
chapulina committed Jun 16, 2021
1 parent 1fc0847 commit 413999b
Show file tree
Hide file tree
Showing 11 changed files with 62 additions and 35 deletions.
4 changes: 4 additions & 0 deletions .github/workflows/build-and-test.sh
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,10 @@ if [ "$IGNITION_VERSION" != "citadel" ]; then
if [ "$IGNITION_VERSION" == "edifice" ]; then
IGN_DEPS="libignition-msgs7-dev libignition-transport10-dev libignition-gazebo5-dev"
fi

if [ "$IGNITION_VERSION" == "fortress" ]; then
IGN_DEPS="libignition-msgs8-dev libignition-transport11-dev libignition-gazebo6-dev"
fi
fi

# Dependencies.
Expand Down
20 changes: 5 additions & 15 deletions .github/workflows/ros2-ci.yml
Original file line number Diff line number Diff line change
@@ -1,13 +1,6 @@
name: ROS2 CI

on:
pull_request:
push:
branches:
- ros2
schedule:
# Run the CI automatically once per day to look for flakyness.
- cron: "0 0 * * *"
on: [push, pull_request]

jobs:
ros_ign_ci:
Expand All @@ -16,18 +9,15 @@ jobs:
strategy:
matrix:
include:
- docker-image: "ubuntu:20.04"
ignition-version: "citadel"
ros-distro: "foxy"
- docker-image: "ubuntu:20.04"
ignition-version: "dome"
ros-distro: "foxy"
- docker-image: "ubuntu:20.04"
ignition-version: "edifice"
ros-distro: "foxy"
ros-distro: "galactic"
- docker-image: "ubuntu:20.04"
ignition-version: "edifice"
ros-distro: "rolling"
- docker-image: "ubuntu:20.04"
ignition-version: "fortress"
ros-distro: "rolling"
container:
image: ${{ matrix.docker-image }}
steps:
Expand Down
34 changes: 15 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,19 @@
[![Build Status](https://travis-ci.org/ignitionrobotics/ros_ign.svg?branch=noetic)](https://travis-ci.org/ignitionrobotics/ros_ign/branches)
[![Build Status](https://github.com/ignitionrobotics/ros_ign/actions/workflows/ros2-ci.yml/badge.svg?branch=ros2)](https://github.com/ignitionrobotics/ros_ign/actions/workflows/ros2-ci.yml)

ROS version | Ignition version | Branch | Binaries hosted at
-- | -- | -- | --
Melodic | Blueprint | [melodic](https://github.com/osrf/ros_ign/tree/melodic) | https://packages.osrfoundation.org
Melodic | Citadel | [melodic](https://github.com/osrf/ros_ign/tree/melodic) | only from source
Melodic | Dome | not supported |
Noetic | Blueprint | not supported |
Melodic | Dome | [melodic](https://github.com/osrf/ros_ign/tree/melodic) | https://packages.osrfoundation.org
Noetic | Citadel | [noetic](https://github.com/osrf/ros_ign/tree/noetic) | https://packages.ros.org
Noetic | Dome | [noetic](https://github.com/osrf/ros_ign/tree/noetic) | only from source
Noetic | Edifice | [noetic](https://github.com/osrf/ros_ign/tree/noetic) | only from source
Dashing | Blueprint | [dashing](https://github.com/osrf/ros_ign/tree/dashing) | only from source
Dashing | Citadel | [dashing](https://github.com/osrf/ros_ign/tree/dashing) | only from source
Dashing | Dome | not supported |
Eloquent | Blueprint | [dashing](https://github.com/osrf/ros_ign/tree/dashing) | only from source
Eloquent | Citadel | [dashing](https://github.com/osrf/ros_ign/tree/dashing) | only from source
Eloquent | Dome | not supported |
Foxy | Blueprint | not supported |
Noetic | Fortress (not released) | [noetic](https://github.com/osrf/ros_ign/tree/noetic) | only from source
Foxy | Citadel | [foxy](https://github.com/osrf/ros_ign/tree/foxy) | https://packages.ros.org
Foxy | Dome | [foxy](https://github.com/osrf/ros_ign/tree/foxy) | only from source
Foxy | Edifice | [foxy](https://github.com/osrf/ros_ign/tree/foxy) | only from source
Rolling | Edifice | [ros2](https://github.com/osrf/ros_ign/tree/ros2) | only from source
Galactic | Edifice | [ros2](https://github.com/osrf/ros_ign/tree/ros2) | https://packages.ros.org
Rolling | Edifice | [ros2](https://github.com/osrf/ros_ign/tree/ros2) | https://packages.ros.org
Rolling | Fortress (not released) | [ros2](https://github.com/osrf/ros_ign/tree/ros2) | only from source

> Please [ticket an issue](https://github.com/ignitionrobotics/ros_ign/issues/) if you'd like support to be added for some combination.
Expand Down Expand Up @@ -53,11 +47,11 @@ This repository holds packages that provide integration between

## Install

This branch supports ROS Foxy and Rolling. See above for other ROS versions.
This branch supports ROS Galactic and Rolling. See above for other ROS versions.

### Binaries

Foxy binaries are only available for Citadel.
Galactic and Rolling binaries are available for Edifice.
They are hosted at https://packages.ros.org.

1. Add https://packages.ros.org
Expand All @@ -68,24 +62,26 @@ They are hosted at https://packages.ros.org.

1. Install `ros_ign`

sudo apt install ros-foxy-ros-ign
sudo apt install ros-<distro>-ros-ign

Where `<distro>` can be `galactic` or `rolling`.

### From source

#### ROS

Be sure you've installed
[ROS Foxy or Rolling](https://index.ros.org/doc/ros2/Installation/)
[ROS Galactic or Rolling](https://index.ros.org/doc/ros2/Installation/)
(at least ROS-Base). More ROS dependencies will be installed below.

#### Ignition

Install either [Citadel, Dome or Edifice](https://ignitionrobotics.org/docs).
Install either [Edifice or Fortress](https://ignitionrobotics.org/docs).

Set the `IGNITION_VERSION` environment variable to the Ignition version you'd
like to compile against. For example:

export IGNITION_VERSION=citadel
export IGNITION_VERSION=edifice

> You only need to set this variable when compiling, not when running.
Expand All @@ -111,7 +107,7 @@ The following steps are for Linux and OSX.
rosdep install -r --from-paths src -i -y --rosdistro <distro>
```

Where `<distro>` can be `foxy` or `rolling`.
Where `<distro>` can be `galactic` or `rolling`.

> If `rosdep` fails to install Ignition libraries and you have not installed them before, please follow [Ignition installation instructions](https://ignitionrobotics.org/docs/latest/install).
Expand Down
2 changes: 1 addition & 1 deletion RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ versions:
* Citadel: 1
* Dome: 2
* Edifice: 3
* Fortress: 4

ROS | Ignition | Version
-- | -- | --
Expand Down Expand Up @@ -108,4 +109,3 @@ Foxy | Edifice | 0.223.X
cd release-tools/bloom
./ros_ign_bridge-release.py.bash 0.8.0 https://github.com/osrf/ros_ign-release <ros_distro> <token> --ignition-version <version_name>
```

9 changes: 9 additions & 0 deletions ros_ign_bridge/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,15 @@ elseif("$ENV{IGNITION_VERSION}" STREQUAL "dome")
set(IGN_MSGS_VER ${ignition-msgs6_VERSION_MAJOR})

message(STATUS "Compiling against Ignition Dome")
# Fortress
elseif("$ENV{IGNITION_VERSION}" STREQUAL "fortress")
find_package(ignition-transport11 REQUIRED)
set(IGN_TRANSPORT_VER ${ignition-transport11_VERSION_MAJOR})

find_package(ignition-msgs8 REQUIRED)
set(IGN_MSGS_VER ${ignition-msgs8_VERSION_MAJOR})

message(STATUS "Compiling against Ignition Fortress")
# Default to Edifice
else()
find_package(ignition-transport10 REQUIRED)
Expand Down
3 changes: 3 additions & 0 deletions ros_ign_bridge/package.xml
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,9 @@
<depend>tf2_msgs</depend>
<depend>trajectory_msgs</depend>

<!-- Fortress -->
<depend condition="$IGNITION_VERSION == fortress">ignition-msgs8</depend>
<depend condition="$IGNITION_VERSION == fortress">ignition-transport11</depend>
<!-- Edifice (default) -->
<depend condition="$IGNITION_VERSION == edifice">ignition-msgs7</depend>
<depend condition="$IGNITION_VERSION == edifice">ignition-transport10</depend>
Expand Down
9 changes: 9 additions & 0 deletions ros_ign_gazebo/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,15 @@ elseif("$ENV{IGNITION_VERSION}" STREQUAL "dome")
set(IGN_MSGS_VER ${ignition-msgs6_VERSION_MAJOR})

message(STATUS "Compiling against Ignition Dome")
# Fortress
elseif("$ENV{IGNITION_VERSION}" STREQUAL "fortress")
find_package(ignition-transport11 REQUIRED)
set(IGN_TRANSPORT_VER ${ignition-transport11_VERSION_MAJOR})

find_package(ignition-msgs8 REQUIRED)
set(IGN_MSGS_VER ${ignition-msgs8_VERSION_MAJOR})

message(STATUS "Compiling against Ignition Fortress")
# Default to Edifice
else()
find_package(ignition-transport10 REQUIRED)
Expand Down
2 changes: 2 additions & 0 deletions ros_ign_gazebo/package.xml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@
<depend>rclcpp</depend>
<depend>ignition-math6</depend>

<!-- Fortress -->
<depend condition="$IGNITION_VERSION == fortress">ignition-gazebo6</depend>
<!-- Edifice (default) -->
<depend condition="$IGNITION_VERSION == edifice">ignition-gazebo5</depend>
<depend condition="$IGNITION_VERSION == ''">ignition-gazebo5</depend>
Expand Down
2 changes: 2 additions & 0 deletions ros_ign_gazebo_demos/package.xml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@

<buildtool_depend>ament_cmake</buildtool_depend>

<!-- Fortress -->
<exec_depend condition="$IGNITION_VERSION == fortress">ignition-gazebo6</exec_depend>
<!-- Edifice (default) -->
<exec_depend condition="$IGNITION_VERSION == edifice">ignition-gazebo5</exec_depend>
<exec_depend condition="$IGNITION_VERSION == ''">ignition-gazebo5</exec_depend>
Expand Down
9 changes: 9 additions & 0 deletions ros_ign_image/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,15 @@ elseif("$ENV{IGNITION_VERSION}" STREQUAL "dome")
set(IGN_MSGS_VER ${ignition-msgs6_VERSION_MAJOR})

message(STATUS "Compiling against Ignition Dome")
# Fortress
elseif("$ENV{IGNITION_VERSION}" STREQUAL "fortress")
find_package(ignition-transport11 REQUIRED)
set(IGN_TRANSPORT_VER ${ignition-transport11_VERSION_MAJOR})

find_package(ignition-msgs8 REQUIRED)
set(IGN_MSGS_VER ${ignition-msgs8_VERSION_MAJOR})

message(STATUS "Compiling against Ignition Fortress")
# Default to Edifice
else()
find_package(ignition-transport10 REQUIRED)
Expand Down
3 changes: 3 additions & 0 deletions ros_ign_image/package.xml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@
<depend>rclcpp</depend>
<depend>sensor_msgs</depend>

<!-- Fortress -->
<depend condition="$IGNITION_VERSION == fortress">ignition-msgs8</depend>
<depend condition="$IGNITION_VERSION == fortress">ignition-transport11</depend>
<!-- Edifice (default) -->
<depend condition="$IGNITION_VERSION == edifice">ignition-msgs7</depend>
<depend condition="$IGNITION_VERSION == edifice">ignition-transport10</depend>
Expand Down

0 comments on commit 413999b

Please sign in to comment.