Adkrawcz/release hot fixes (#12)

* Remove act

Signed-off-by: Adam Krawczyk <[email protected]>

* Fix build instruction

Signed-off-by: Adam Krawczyk <[email protected]>

* Fix readme build local instruction

Signed-off-by: Adam Krawczyk <[email protected]>

---------

Signed-off-by: Adam Krawczyk <[email protected]>
Co-authored-by: Adam Krawczyk <[email protected]>

README.md

@@ -4,41 +4,148 @@ Repository containing sub-repos for setting up the whole project
 
 ## Download 
 
+### VCSTool
+
+The project uses the `vcs` tool to configure the dependent repositories.
+
+Install the [vcstool](https://github.com/dirk-thomas/vcstool):
+
+```bash
+pip3 install vcstool
+```
+
+### Get the project
 ```bash
-git clone [email protected]:wise-vision/wisevision.proj.git && cd wisevision.proj
+git clone [email protected]:wise-vision/wisevision.proj.git && cd wisevision.proj # git checkout 2411 # (or any other branch/tag) 
 vcs import --recursive < project.repos
 ```
 
+
+### Install dependencies
+
+In case you have done the installation of the dependencies before, you can skip this step to [Run without docker](#run-without-docker)
+
+#### ROS2
+
+So far the **ROS 2** `Humble` and `Jazzy` distributions are supported. The original instruction can be found here: [Humble](https://docs.ros.org/en/humble/Installation.html) or [Jazzy](https://docs.ros.org/en/jazzy/Installation.html) below instruction is for `Humble` distribution.
+
+```bash
+sudo apt install -y software-properties-common
+sudo add-apt-repository universe
+sudo apt update && sudo apt install curl -y
+sudo curl -sSL https://raw.githubusercontent.com/ros/rosdistro/master/ros.key -o /usr/share/keyrings/ros-archive-keyring.gpg
+echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/ros-archive-keyring.gpg] http://packages.ros.org/ros2/ubuntu $(. /etc/os-release && echo $UBUNTU_CODENAME) main" | sudo tee /etc/apt/sources.list.d/ros2.list > /dev/null
+sudo apt update && sudo apt upgrade -y
+sudo apt install -y ros-humble-desktop ros-dev-tools python3-rosdep
+sudo rosdep init
+rosdep update
+
+source /opt/ros/humble/setup.bash # for convenience echo "source /opt/ros/humble/setup.bash" >> ~/.bashrc
+```
+
+#### GRPC
+
+For now, the project uses the `grpc` library built from source (to be changed in future). To install it, follow the steps below:
+
+```bash
+echo "
+## GRPC
+
+export GRPC_INSTALL_DIR=$HOME/grpc_install_dir
+export PATH=$PATH:${GRPC_INSTALL_DIR}/bin
+export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:${GRPC_INSTALL_DIR}/lib" >> ~/.bashrc
+source ~/.bashrc
+mkdir $GRPC_INSTALL_DIR
+
+# Install dependencies
+sudo apt install -y cmake build-essential autoconf libtool pkg-config libpaho-mqtt-dev  libpaho-mqttpp-dev libboost-all-dev
+# Clone the repository to the ~/grpc
+git clone --recurse-submodules -b v1.64.0 --depth 1 --shallow-submodules https://github.com/grpc/grpc $HOME/grpc
+
+# Build the library
+cd $HOME/grpc
+
+mkdir -p cmake/build
+pushd cmake/build
+cmake -DBUILD_SHARED_LIBS=ON \
+    -DCMAKE_INSTALL_PREFIX=$GRPC_INSTALL_DIR \
+    -DgRPC_BUILD_GRPC_CPP_PLUGIN=ON \
+    -DgRPC_BUILD_GRPC_CSHARP_PLUGIN=OFF \
+    -DgRPC_BUILD_GRPC_NODE_PLUGIN=OFF \
+    -DgRPC_BUILD_GRPC_OBJECTIVE_C_PLUGIN=OFF \
+    -DgRPC_BUILD_GRPC_PHP_PLUGIN=OFF \
+    -DgRPC_BUILD_GRPC_PYTHON_PLUGIN=OFF \
+    -DgRPC_BUILD_GRPC_RUBY_PLUGIN=OFF \
+    ../..
+
+make -j$(nproc --ignore=2)
+make install
+popd
+```
+
 ## Build
 
 ```bash
+cd wisevision.proj # or the directory where the project.repos file is located
 colcon build --symlink-install --cmake-args -DCMAKE_BUILD_TYPE=Release
 ```
-## Source 
+## Run without docker
 
 ```bash
 source install/setup.bash
 ```
 
+TODO: Add the one liner to run the project
+
+## 
+
 ## Docker Run
 
-Easiest way to run the project is to use docker-compose.
+Other way to run the project is to use docker-compose. This step requires `docker`, `docker-compose` installed and also the GitHub token to be set in the environment
+
+### Setup
+
+It is required to set up 
 
 ```bash
-docker-compose up --build
+vcs import --recursive < project.repos
+cp src/ros2_lora_bridge/.env_example src/ros2_lora_bridge/.env  
+```
+
+### Run with docker-compose
+
+Will be removed in the future but for now, it is required to build the image locally to get the [GitHub token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens).
+
+```
+$ GITHUB_TOKEN=<YOUR-GH-TOKEN> docker-compose up --build  
 ```
 
-Permission denied for docker hub -> create image locally:
+## FAQ
+
+### Permission denied for docker hub
+
+In case of permission denied for docker hub -> create the required image locally:
+
 ``` bash
 cd src/wisevision_msgs
 docker build -t wisevision/ros_with_wisevision_msgs:humble -f Dockerfile .
 cd ../..
 docker-compose up --build
 ```
 
+### Build fails with `protobuf` error
+
+In most cases, build time error related to the `protobuf` library is due to building the `grpc` library from source with the binaries installed from the package manager. To fix this, remove the `libprotobuf-dev`, `protobuf-compiler` and `libprotoc-dev` packages and rebuild the `grpc` library from source as described in the [Install dependencies](#install-dependencies) section.
+
+```bash
+sudo apt remove --purge libprotoc-dev
+sudo apt remove --purge libprotobuf-dev
+sudo apt remove --purge protobuf-compiler
+```
+
 ## Run workflow with act
 
-Act tool [link](https://github.com/nektos/act).
+Install `act` tool [link](https://github.com/nektos/act).
 
 ```bash
 act pull_request -W .github/workflows/ros2_ci.yml -j build -P ubuntu-22.04=catthehacker/ubuntu:act-22.04 --secret SSH_KEY="$(cat path/to/your/private_key)"

project.repos

@@ -3,28 +3,28 @@ repositories:
   src/ros2_automatic_action_execution:
     type: git
     url: [email protected]:wise-vision/ros2_automatic_action_execution.git
-    version: main
+    version: 2411
   src/ros2_lora_bridge:
     type: git
     url: [email protected]:wise-vision/ros2_lora_bridge.git
-    version: main
+    version: 2411
   src/wisevision_dashboard:
     type: git
     url: [email protected]:wise-vision/wisevision-dashboard.git
-    version: main
+    version: 2411
   src/ros2_black_box:
     type: git
     url: [email protected]:wise-vision/ros2_black_box.git
-    version: main
+    version: 2411
   src/wisevision_gps_tools:
     type: git
     url: [email protected]:wise-vision/wisevision_gps_tools.git
-    version: main
+    version: 2411
   src/wisevision_msgs:
     type: git
     url: [email protected]:wise-vision/wisevision_msgs.git
-    version: main
+    version: 2411
   src/ros2_notifications:
     type: git
     url: [email protected]:wise-vision/ros2_notifications.git
-    version: main
+    version: 2411