From ed16c55e32c0ee870be5c7afd74836f280d6879d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?I=C3=B1igo=20Moreno?= <inigo.moreno@tecnalia.com>
Date: Wed, 22 Sep 2021 16:08:22 +0200
Subject: [PATCH] Add documentation
---
ci-templates/README.adoc | 7 ++++++-
ci-templates/examples/include_lfs.yml | 5 +++++
ci-templates/industrial-ci-templates.yml | 1 -
3 files changed, 11 insertions(+), 2 deletions(-)
create mode 100644 ci-templates/examples/include_lfs.yml
diff --git a/ci-templates/README.adoc b/ci-templates/README.adoc
index d4f1a0d..f99eb2c 100644
--- a/ci-templates/README.adoc
+++ b/ci-templates/README.adoc
@@ -28,7 +28,6 @@ The Core pipeline, defined in link:ci-templates/core.yml[], has the following st
* Check files have no trailing whitespace and are `UTF-8` encoded
* Check that `C++` files follow this link:clang-format[]
-It is important to note that both templates set the variable `GIT_LFS_SKIP_SMUDGE`, which means that when the repositories are cloned/fetched, the files hosted using Git LFS will not be downloaded. An example on how to explicitely fetch the files from LFS can be found in the https://git.code.tecnalia.com/tecnalia_robotics/common_config/blob/e93dbe6379d94e6a895a33c59bf17ccab26eacf9/.gitlab-ci.yml#L132[common_config repository].
== Manual Jobs
@@ -52,3 +51,9 @@ The auto rules also allow for using variables to explicitely activate each job:
```yml
include::examples/build_vars.yml[]
```
+
+== LFS
+By default, lfs files are not downloaded. If you need to add LFS, include the link:ci-templates/lfs-pull.yml[] along with anything else:
+```yml
+include::examples/include_lfs.yml[]
+```
\ No newline at end of file
diff --git a/ci-templates/examples/include_lfs.yml b/ci-templates/examples/include_lfs.yml
new file mode 100644
index 0000000..00876e5
--- /dev/null
+++ b/ci-templates/examples/include_lfs.yml
@@ -0,0 +1,5 @@
+include:
+ - project: tecnalia_robotics-public/gitlab_templates
+ file:
+ - ci-templates/auto-rules/kinetic-default.yml
+ - ci-templates/auto-rules/kinetic-default.yml
diff --git a/ci-templates/industrial-ci-templates.yml b/ci-templates/industrial-ci-templates.yml
index e5e3eba..b1c5d84 100644
--- a/ci-templates/industrial-ci-templates.yml
+++ b/ci-templates/industrial-ci-templates.yml
@@ -12,7 +12,6 @@
PARALLEL_BUILDS: 2 # keep this for now, since there seems to be memory limit issues in the ci VM
AFTER_SETUP_TARGET_WORKSPACE: "rosenv && bash <(curl -Ls https://git.code.tecnalia.com/tecnalia_robotics-public/gitlab_templates/raw/master/scripts/ci_run_entry_points.sh) $$current_ws"
CMAKE_ARGS: -DCMAKE_CXX_FLAGS=-Wno-ignored-attributes -Wno-int-in-bool-context
- ROS_REPO: main
.industrial_ci_deploy:
--
GitLab