Put the GitLab YAML in a file instead of directly in the README (#489)

Author: DilumAluthge

README.md

@@ -28,32 +28,9 @@ Create a file at `.github/workflows/CompatHelper.yml` with the contents of the [
 If you need to use any special arguments for the `main` function, you can modify this file to add them.
 
 ### GitLab
-For GitLab you will want to add CompatHelper as a job in your `.gitlab-ci.yml` file such as:
 
-```yaml
-CompatHelper:
-  image: julia:1.6 # Set to the Julia version you want to use
-  stage: compat # You can place this in any stage that makes sense for your setup
-  before_script:
-    - apt-get update -qq && apt-get install -y git
-    - |
-      julia --color=yes -e "
-        import Pkg;
-        ENV[\"JULIA_PKG_SERVER\"] = \"\";
-        Pkg.Registry.add(\"General\");"
-    - |
-      julia --color=yes -e "
-        import Pkg;
-        name = \"CompatHelper\";
-        uuid = \"aa819f21-2bde-4658-8897-bab36330d9b7\";
-        version = \"3\";
-        Pkg.add(; name, uuid, version)"
-  script:
-    - |
-      julia --color=yes -e "
-        import CompatHelper;
-        CompatHelper.main()"
-```
+For GitLab you will want to add CompatHelper as a job in your `.gitlab-ci.yml`
+file with the contents of the [.gitlab-ci.yml](examples/gitlab/.gitlab-ci.yml) file that is included in this repository.
 
 Similarly to the GitHub setup, you can modify the `main` call here if you need to change any of the default arguments.
 You must also remember to add the `GITLAB_TOKEN` and `COMPATHELPER_PRIV` CI secrets to the project so that CompatHelper can find them.

examples/gitlab/.gitlab-ci.yml

@@ -0,0 +1,22 @@
+CompatHelper:
+  image: julia:1.6 # Set to the Julia version you want to use
+  stage: compat # You can place this in any stage that makes sense for your setup
+  before_script:
+    - apt-get update -qq && apt-get install -y git
+    - |
+      julia --color=yes -e "
+        import Pkg;
+        ENV[\"JULIA_PKG_SERVER\"] = \"\";
+        Pkg.Registry.add(\"General\");"
+    - |
+      julia --color=yes -e "
+        import Pkg;
+        name = \"CompatHelper\";
+        uuid = \"aa819f21-2bde-4658-8897-bab36330d9b7\";
+        version = \"3\";
+        Pkg.add(; name, uuid, version)"
+  script:
+    - |
+      julia --color=yes -e "
+        import CompatHelper;
+        CompatHelper.main()"