summaryrefslogtreecommitdiff
path: root/tools/ci/inria/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'tools/ci/inria/README.md')
-rw-r--r--tools/ci/inria/README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/tools/ci/inria/README.md b/tools/ci/inria/README.md
new file mode 100644
index 0000000000..8ade11237f
--- /dev/null
+++ b/tools/ci/inria/README.md
@@ -0,0 +1,13 @@
+This directory contains the configuration files of the Jenkins jobs
+used to test OCaml on Inria's continuous integration infrastructure.
+
+Each subdirectory under `tools/ci/inria` corresponds to one CI job
+and should contain at least a `Jenkinsfile` describing the pipeline
+associated with this job(1). In addition, the job's directory can also
+contain a `script` file specifying the commands used to actually execute
+the job. Other files may be included as appropriate.
+
+(1) The Jenkinsfiles can follow either the declarative syntax documented
+at https://www.jenkins.io/doc/book/pipeline/syntax, or the advanced
+(scripted) one documented at
+https://www.jenkins.io/doc/book/pipeline/jenkinsfile/#advanced-scripted-pipeline