add recursive submodule option also to gitlab-ci

.gitlab-ci/docker-ros.yml

@@ -42,6 +42,7 @@ variables:
   ENABLE_RECURSIVE_CUSTOM_SCRIPT:    'false'                          # Enable recursive discovery of files named `custom-script-file`
   VCS_IMPORT_FILE:            .repos                                  # Relative filepath to file containing additional repos to install via vcstools (only relevant if ENABLE_RECURSIVE_VCS_IMPORT=false)
   ENABLE_RECURSIVE_VCS_IMPORT:       'true'                           # Enable recursive discovery of files named `*.repos`
+  ENABLE_CHECKOUT_SUBMODULES: 'recursive'                             # Enable recursive submodule checkout  (normal|recursive)
   # -----
   DOCKER_ROS_GIT_REF:     main
 
@@ -61,7 +62,7 @@ variables:
   _IMAGE_DEV_TAG:         ${DEV_IMAGE_NAME}:${CI_COMMIT_TAG}-dev
   _IMAGE_RUN_TAG:         ${IMAGE_NAME}:${CI_COMMIT_TAG}
 
-  GIT_SUBMODULE_STRATEGY: recursive
+  GIT_SUBMODULE_STRATEGY: ${ENABLE_CHECKOUT_SUBMODULES}
   DOCKER_DRIVER: overlay2
   DOCKER_TLS_CERTDIR: /certs
   DOCKER_BUILDKIT: 1

README.md

@@ -373,8 +373,8 @@ Create a folder `additional-files` in your `docker` folder (or configure a diffe
 - **`enable-checkout` | `-`**  
   Enable [*checkout*](https://github.com/actions/checkout) action to (re-)download your repository prior to running the pipeline  
   *default:* `true`
-- **`enable-checkout-submodules` | `-`**  
-  Enable submodules for the [*checkout*](https://github.com/actions/checkout) action (`false`|`true`|`recursive`)  
+- **`enable-checkout-submodules` | `ENABLE_CHECKOUT_SUBMODULES`**  
+  Enable submodules for the [*checkout*](https://github.com/actions/checkout) action (`false`|`true`|`recursive`) | Enable recursive submodule checkout  (normal|recursive)  
   *default:* `recursive`
 - **`enable-checkout-lfs` | `-`**  
   Enable [*Git LFS*](https://git-lfs.com/) support for the [*checkout*](https://github.com/actions/checkout) action