Added documentation for usage of setup-gazebo (#530)

* Added documentation for usage of setup-gazebo

Signed-off-by: Saurabh Kamat <[email protected]>

* Removed garden from setup-gazebo docs

Signed-off-by: Saurabh Kamat <[email protected]>

* Updated setup-gazebo usage instructions

Signed-off-by: Saurabh Kamat <[email protected]>

---------

Signed-off-by: Saurabh Kamat <[email protected]>
Co-authored-by: Addisu Z. Taddese <[email protected]>

Author: sauk2

index.yaml

@@ -28,6 +28,10 @@ pages:
         title: ROS 2 Gazebo Vendor Packages
         file: ros2_gz_vendor_pkgs.md
         description: Using ROS 2 Gazebo Vendor packages
+  - name: setup_gazebo_in_ci
+    title: Continuous Integration For Gazebo Packages
+    file: setup_gazebo_in_ci.md
+    description: Instruction on using setup-gazebo
   - name: gazebo_classic_migration
     title: Gazebo Classic Migration
     file: gazebo_classic_migration.md

setup_gazebo_in_ci.md

@@ -0,0 +1,27 @@
+# Setting up Gazebo in a Continuous Integration (CI) Pipeline
+
+Setting up a Gazebo environment in a Continuous Integration (CI) pipeline can often be a complex and time-consuming task.
+It typically involves installing various dependencies, managing repository keys, and ensuring platform compatibility with the Gazebo distribution.
+If done incorrectly, this can lead to unpredictable behaviors in CI due inconsistencies across environments.
+This section provides information on setting up a Gazebo in a continuous integration pipeline using the `setup-gazebo` GitHub Action to automate the entire process of configuring a Gazebo environment in a CI by taking care of everything, from handling dependencies to installing the desired Gazebo distribution.
+
+This action can also be used to install Gazebo alongside ROS 2 along with ROS-Gazebo bridge (`ros_gz`). It handles the installation of the correct version of Gazebo and `ros_gz` from all of all the recommended and supported combinations, along with possible combinations through ROS official binaries as ROS Gazebo vendor packages.
+
+The `setup-gazebo` GitHub Action can be found on the [Marketplace](https://github.com/marketplace/actions/setup-gazebo-environment) with its source code hosted at [github.com/gazebo-tooling/setup-gazebo](https://github.com/gazebo-tooling/setup-gazebo). Also check this [community post](https://community.gazebosim.org/t/introducing-the-setup-gazebo-github-action/3132) for more details.
+
+## Supported Gazebo Releases
+
+The action currently supports all the non-EOL Gazebo releases. See [releases](https://gazebosim.org/docs/all/releases/) for more information.
+
+* Citadel
+* Fortress
+* Harmonic
+* Ionic
+
+## Supported Platforms
+
+The `setup-gazebo` GitHub Action works on three platforms (Ubuntu, macOS and Windows) with the usage instructions for each described below,
+
+* [Ubuntu](https://github.com/marketplace/actions/setup-gazebo-environment#ubuntu)
+* [macOS](https://github.com/marketplace/actions/setup-gazebo-environment#macos)
+* [Windows](https://github.com/marketplace/actions/setup-gazebo-environment#windows)