diff options
author | 2017-06-13 18:24:45 +0200 | |
---|---|---|
committer | 2017-06-16 10:35:37 +0200 | |
commit | d06af26e6cd93c6bb819b38573603a5e1121ed68 (patch) | |
tree | a4d6c02072d0626daa955ba3327e565c8399e1b9 /dev/ci/user-overlays/README.md | |
parent | e1d68573015883301cb401861e10233f6442d9ec (diff) |
Each user overlay goes into its own file.
This will avoid stupid merge conflicts in the future.
Diffstat (limited to 'dev/ci/user-overlays/README.md')
-rw-r--r-- | dev/ci/user-overlays/README.md | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/dev/ci/user-overlays/README.md b/dev/ci/user-overlays/README.md new file mode 100644 index 000000000..9146d3d52 --- /dev/null +++ b/dev/ci/user-overlays/README.md @@ -0,0 +1,14 @@ +# Add overlays for your pull requests in this directory + +An overlay is a file containing very simple logic to test whether we are currently building a specific pull request or git branch (useful so that overlays work on your own fork) and which changes some of the variables whose default can be found in [`ci-basic-overlay.sh`](/dev/ci/ci-basic-overlay.sh). + +The name of your overlay file should be of the form `five_digit_PR_number-GitHub_handle-branch_name.sh`. + +Example: `00669-maximedenes-ssr-merge.sh` containing + +``` +if [ "$TRAVIS_PULL_REQUEST" = "669" ] || [ "$TRAVIS_BRANCH" = "ssr-merge" ]; then + mathcomp_CI_BRANCH=ssr-merge + mathcomp_CI_GITURL=https://github.com/maximedenes/math-comp.git +fi +``` |