add readme

Signed-off-by: M. Fatih Cırıt <mfc@leodrive.ai>
autowarefoundation · Aug 19, 2024 · 1c17cd5 · 1c17cd5
1 parent db8a7e2
commit 1c17cd5
Showing 2 changed files with 10 additions and 8 deletions.
diff --git a/colcon-build/README.md b/colcon-build/README.md
@@ -30,13 +30,15 @@ jobs:
 
 ## Inputs
 
-| Name                | Required | Description                                         |
-| ------------------- | -------- | --------------------------------------------------- |
-| rosdistro           | true     | ROS distro.                                         |
-| target-packages     | true     | The target packages to build.                       |
-| build-depends-repos | false    | The `.repos` file that includes build dependencies. |
-| cmake-build-type    | false    | The value for `CMAKE_BUILD_TYPE`.                   |
-| token               | false    | The token for build dependencies.                   |
+| Name                         | Required | Description                                                                                                             |
+|------------------------------|----------|-------------------------------------------------------------------------------------------------------------------------|
+| rosdistro                    | true     | ROS distro.                                                                                                             |
+| target-packages              | true     | The target packages to build.                                                                                           |
+| build-depends-repos          | false    | The `.repos` file that includes build dependencies.                                                                     |
+| cmake-build-type             | false    | The value for `CMAKE_BUILD_TYPE`.                                                                                       |
+| token                        | false    | The token for build dependencies.                                                                                       |
+| colcon-parallel-workers-flag | false    | Will be appended to the colcon build command to limit number of packages built in parallel. e.g. "--parallel-workers 3" |
+| makeflags                    | false    | Will be exported as MAKEFLAGS environment variable for colcon build step. e.g. "-j 4"                                   |
 
 ## Outputs
 

diff --git a/colcon-build/action.yaml b/colcon-build/action.yaml
@@ -31,7 +31,7 @@ inputs:
     default: ""
     required: false
   makeflags:
-    description: If set, will be exported as MAKEFLAGS environment variable. e.g. "-j 4"
+    description: Will be exported as MAKEFLAGS environment variable. e.g. "-j 4"
     default: ""
     required: false