aboutsummaryrefslogtreecommitdiff
path: root/dev/ci/user-overlays/README.md
diff options
context:
space:
mode:
authorEmilio Jesus Gallego Arias2018-09-01 01:56:30 +0200
committerEmilio Jesus Gallego Arias2018-09-01 01:56:30 +0200
commit6f1c4ac389e595e09fdf4653847d8c3ccca0befb (patch)
tree948a6a1ea0328b01925d7ee9120a82cc3d14317c /dev/ci/user-overlays/README.md
parent166a3838a7f07df4181617e111ffeb67dd817929 (diff)
parent04542c3288b838c57253f2c315f1dab028412a40 (diff)
Merge PR #8348: Download tarball instead of cloning external projects.
Diffstat (limited to 'dev/ci/user-overlays/README.md')
-rw-r--r--dev/ci/user-overlays/README.md8
1 files changed, 5 insertions, 3 deletions
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
```