From 04542c3288b838c57253f2c315f1dab028412a40 Mon Sep 17 00:00:00 2001
From: Théo Zimmermann
Date: Tue, 28 Aug 2018 18:43:03 +0200
Subject: Download tarball instead of cloning external projects (when $CI is
 set).

This allows to use fixed commits and not just branches or tags.

We keep using git clone when $FORCE_GIT is set (for projects on
gforge.inria.fr and projects pulling dependencies through git submodules).

fiat-parsers also calls git submodule, but inside its own Makefile.
---
 dev/ci/user-overlays/README.md | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

(limited to 'dev/ci/user-overlays/README.md')

diff --git a/dev/ci/user-overlays/README.md b/dev/ci/user-overlays/README.md
index d38d1b06d1..68afe7ee4a 100644
--- a/dev/ci/user-overlays/README.md
+++ b/dev/ci/user-overlays/README.md
@@ -7,10 +7,12 @@ request to test it with the adapted version of the external project.
 An overlay is a file which defines where to look for the patched version so that
 testing is possible. It redefines some variables from
 [`ci-basic-overlay.sh`](../ci-basic-overlay.sh):
-give the name of your branch using a `_CI_BRANCH` variable and the location of
-your fork using a `_CI_GITURL` variable.
+give the name of your branch / commit using a `_CI_REF` variable and the
+location of your fork using a `_CI_GITURL` variable.
 The `_CI_GITURL` variable should be the URL of the repository without a
 trailing `.git`.
+If the fork is not on the same platform (e.g. GitHub instead of GitLab), it is
+necessary to redefine the `_CI_ARCHIVEURL` variable as well.
 
 Moreover, the file contains very simple logic to test the pull request number
 or branch name and apply it only in this case.
@@ -25,7 +27,7 @@ Example: `00669-maximedenes-ssr-merge.sh` containing
 #!/bin/sh
 
 if [ "$CI_PULL_REQUEST" = "669" ] || [ "$CI_BRANCH" = "ssr-merge" ]; then
-    mathcomp_CI_BRANCH=ssr-merge
+    mathcomp_CI_REF=ssr-merge
     mathcomp_CI_GITURL=https://github.com/maximedenes/math-comp
 fi
 ```
-- 
cgit v1.2.3