From 4fc8365c8d99b631e7cd2f220980a2ba57dbb1bf Mon Sep 17 00:00:00 2001
From: Franz Zieris <franz.zieris@fu-berlin.de>
Date: Fri, 13 Jul 2018 09:10:50 +0200
Subject: [PATCH] add documentation to .gitlab-ci.yml

---
 .gitlab-ci.yml     | 2 +-
 preload-packages.R | 2 ++
 2 files changed, 3 insertions(+), 1 deletion(-)

diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index 46da290..5dd75b7 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -3,7 +3,7 @@ image: rocker/verse
 compile:
   stage: build
   before_script:
-    - Rscript preload-packages.R
+    - Rscript preload-packages.R   # optional, but saves time
   script:
     - Rscript -e "library(knitr);knit('report_en.Rnw');"
     - Rscript -e "library(tinytex);pdflatex('report_en.tex');"
diff --git a/preload-packages.R b/preload-packages.R
index a7dc35c..5f4f905 100644
--- a/preload-packages.R
+++ b/preload-packages.R
@@ -1,3 +1,5 @@
+# Preloading the LaTeX packages is optional (tinytex would install them
+# on-the-fly when calling `pdflatex()`), but is a time-saver for GitLab CI
 latex_packages = c(
     'babel-english',
     'babel-german',
-- 
GitLab