Update README and actions description

Signed-off-by: Raul Sanchez-Mateos <raul@eprosima.com>

.github/workflows/build_fastdds.yml

@@ -21,10 +21,22 @@
 # MANUAL RUN:
 #  Running this workflow manually, the following arguments might be set:
 #
-#   built_configuration_branch: set a branch to download colcon.meta file from this repository [Default: main]
+#   built_configuration_branch:       set a branch to download colcon.meta file from this repository [Default: main]
 #
-#   artifacts_name_postfix:     set the postfix name for the uploading artifact [Default: _manual]
-#                               Note: do not use "_nightly" in this argument, or other workflows may be affected
+#   artifacts_name_postfix:           set the postfix name for the uploading artifact [Default: _manual]
+#                                     Note: do not use "_nightly" in this argument, or other workflows may be affected
+#
+#   use_repos_file:                   flag to use .repos file instead of manually set repository branches.
+#                                     The .repos file will be downloaded from the eProsima-CI branch set in "built_configuration_branch".
+#
+#   foonathan_memory_vendor_branch:   branch, tag or commit of eProsima/foonathan_memory_vendor repository.
+#                                     Check available branches in https://github.com/eProsima/foonathan_memory_vendor.
+#
+#   fastcdr_branch:                   branch, tag or commit of eProsima/Fast-CDR repository.
+#                                     Check available branches in https://github.com/eProsima/Fast-CDR.
+#
+#   fastdds_branch:                   branch, tag or commit of eProsima/Fast-DDS repository.
+#                                     Check available branches in https://github.com/eProsima/Fast-DDS.
 #
 
 name: build_fastdds
@@ -52,22 +64,30 @@ on:
         default: true
 
       artifacts_name_postfix:
-        description: Addition to artifacts name creation (do not use _nightly postfix when creating artifacts with specific arguments).
+        description: >
+          Addition to artifacts name creation (do not use _nightly postfix when creating artifacts with specific
+          arguments).
         required: false
         default: _manual
 
       foonathan_memory_vendor_branch:
-        description: Branch, tag or commit of eProsima/foonathan_memory_vendor repository. Check available branches in https://github.com/eProsima/foonathan_memory_vendor.
+        description: >
+          Branch, tag or commit of eProsima/foonathan_memory_vendor repository.
+          Check available branches in https://github.com/eProsima/foonathan_memory_vendor.
         required: false
         default: master
 
       fastcdr_branch:
-        description: Branch, tag or commit of eProsima/Fast-CDR repository. Check available branches in https://github.com/eProsima/Fast-CDR.
+        description: >
+          Branch, tag or commit of eProsima/Fast-CDR repository.
+          Check available branches in https://github.com/eProsima/Fast-CDR.
         required: false
         default: master
 
       fastdds_branch:
-        description: Branch, tag or commit of eProsima/Fast-DDS repository. Check available branches in https://github.com/eProsima/Fast-DDS.
+        description: >
+          Branch, tag or commit of eProsima/Fast-DDS repository.
+          Check available branches in https://github.com/eProsima/Fast-DDS.
         required: false
         default: master
 

README.md

@@ -79,6 +79,9 @@ For more information about versioning handle of this project, check following [f
 - [download_dependency](multiplatform/download_dependency/action.yml)
   - Download an artifact previously generated from a workflow run.
 
+- [fetch_fastdds_manual](multiplatform/fetch_fastdds_manual/action.yml)
+  - Download Fast DDS and its eProsima dependencies setting the specific version of each repository.
+
 - [generate_dependency_artifact](multiplatform/generate_dependency_artifact/action.yml)
   - Build a project and upload the installed objects as an artifact.
 
@@ -210,6 +213,8 @@ Run the `manual_build` workflow with these arguments:
 
 > :warning: Do not generate custom artifacts with postfix `_nightly`, as this is the main name other repos will use.
 
+> :page_facing_up: Fast DDS manual build allows to specify Fast DDS and its eProsima dependencies version as inputs of the workflow. In order to use the manually set versions instead the ones taken from the `.repos` file just disable `use_repos_file` option.
+
 ## Custom artifact generation
 
 The workflow [manual_build](.github/workflows/manual_build.yml) supports to create any artifact giving a `.repos` and `colcon.meta` files.

multiplatform/fetch_fastdds_manual/action.yml

@@ -1,4 +1,5 @@
 name: fetch_fastdds_manual
+description: Download Fast DDS and its eProsima dependencies setting the specific version of each repository
 
 inputs:
 

ubuntu/fetch_fastdds_manual/action.yml

@@ -1,4 +1,5 @@
 name: fetch_fastdds_manual
+description: Download Fast DDS and its eProsima dependencies setting the specific version of each repository
 
 inputs:
 
@@ -34,7 +35,7 @@ runs:
         echo "Downloading following dependencies:"
         echo "  - Foonathan Memory Vendor: ${{ inputs.foonathan_memory_vendor_branch }}"
         echo "  - Fast CDR: ${{ inputs.fastcdr_branch }}"
-        echo "  - Fast CDR: ${{ inputs.fastdds_branch }}"
+        echo "  - Fast DDS: ${{ inputs.fastdds_branch }}"
 
         mkdir -p ${{ inputs.destination_workspace }}
         cd ${{ inputs.destination_workspace }}

windows/fetch_fastdds_manual/action.yml

@@ -1,4 +1,5 @@
 name: fetch_fastdds_manual
+description: Download Fast DDS and its eProsima dependencies setting the specific version of each repository
 
 inputs:
 
@@ -35,7 +36,7 @@ runs:
         Write-Host 'Downloading following dependencies:'
         Write-Host '  - Foonathan Memory Vendor: ${{ inputs.foonathan_memory_vendor_branch }}'
         Write-Host '  - Fast CDR: ${{ inputs.fastcdr_branch }}'
-        Write-Host '  - Fast CDR: ${{ inputs.fastdds_branch }}'
+        Write-Host '  - Fast DDS: ${{ inputs.fastdds_branch }}'
 
         New-Item -ItemType Directory -Force -Path ${{ inputs.destination_workspace }}
         Set-Location -Path ${{ inputs.destination_workspace }}