Merge pull request #330 from una-auxme/285-feature-document-the-distr…

…ibuted-launch-of-the-carla-simulator-and-agent

285 feature document the distributed launch of the carla simulator and agent

.github/workflows/build.yml

@@ -2,7 +2,7 @@ name: Build and push image
 
 on:
   workflow_run:
-    workflows: ["Check code format", "Linter markdown and code"]
+    workflows: ["Check code format"]
     types:
       - completed
 
@@ -12,6 +12,7 @@ env:
 
 jobs:
   build-and-push-image:
+    name: Build and push image
     runs-on: self-hosted
     outputs:
       version: ${{ steps.build.version.outputs.version }}

.github/workflows/drive.yaml → .github/workflows/drive.yml

@@ -9,9 +9,6 @@ on:
 jobs:
   drive:
     runs-on: self-hosted
-    needs: build-and-push-image
-    # run only on pull request for now
-    if: github.event_name == 'pull_request'
     env:
       AGENT_VERSION: latest
       COMPOSE_FILE: ./build/docker-compose.cicd.yaml

.github/workflows/format.yaml → .github/workflows/format.yml

@@ -1,13 +1,14 @@
 name: Check code format
 
 on:
-  pull_request:
-    branches:
-      - "main"
+  workflow_run:
+    workflows: ["Linter markdown and code"]
+    types:
+      - completed
 
 jobs:
     format:
-        name: Check code files format
+        name: Check code format
         runs-on: ubuntu-latest
         steps:
           - name: Check out the repo

.github/workflows/linter.yml

@@ -7,7 +7,7 @@ on:
 
 jobs:
     linter:
-        name: Lint project files
+        name: Linter markdown and code
         runs-on: ubuntu-latest
         steps:
           - name: Check out the repo

doc/development/distributed_simulation.md

@@ -33,7 +33,7 @@ As far as we know, you need more than **10 GB of VRAM** to run the server and th
 
 ### Ensure similarity between normal docker-compose and distributed docker-compose files
 
-Carefully compare that their are no major differences between the `docker-compose.yml` and `docker-compose.distributed.yml` files.
+Carefully compare that their are no major differences between the `docker-compose.*.yaml` and `docker-compose.*-distributed.yaml` files.
 Mainly, the `carla-simulator` service will not be executed in the non-distributed version.
 
 ### Set the `<ip-address>` of the carla simulator in docker-compose distributed files