Commit 3ef96034 authored by Ralf Jung's avatar Ralf Jung

update README

parent b1248266
......@@ -50,6 +50,7 @@ variables:
except:
- triggers
- schedules
- api
## Build jobs
```
......@@ -65,10 +66,10 @@ when the pipeline gets triggered though the API or an automatic schedule. See
Below this, you can configure your build jobs. A normal job looks like this:
```
build-coq.8.8.2:
build-coq.8.10.1:
<<: *template
variables:
OPAM_PINS: "coq version 8.8.2"
OPAM_PINS: "coq version 8.10.1"
```
This builds your project against Coq 8.8.2. The first line determines the job
......@@ -86,24 +87,26 @@ some of the things that are common amongst Iris build jobs.
## Nightly builds
To make sure that a project keeps working as we update Iris, we can set up
nightly builds against the latest Iris version. To this end, add a job like
this:
nightly builds against the latest Iris version, and often we pin that to a
*branch* of Coq to make sure we keep working with the next patch release. To
this end, add a job like this:
```
build-iris.dev:
<<: *template
variables:
OPAM_PINS: "coq version 8.9.0 coq-stdpp.dev git git+https://gitlab.mpi-sws.org/iris/stdpp.git#$STDPP_REV coq-iris.dev git git+https://gitlab.mpi-sws.org/iris/iris.git#$IRIS_REV"
OPAM_PINS: "coq version 8.10.dev coq-stdpp.dev git git+https://gitlab.mpi-sws.org/iris/stdpp.git#$STDPP_REV coq-iris.dev git git+https://gitlab.mpi-sws.org/iris/iris.git#$IRIS_REV"
except:
only:
- triggers
- schedules
- api
```
The last four lines configure this job to *not* run when new commits are pushed
to the repo, and instead make it run when a pipeline is triggered through the
REST API or by a schedule. The pins are set up to install a development version
of all the dependencies.
of all the dependencies, and the `8.10` branch of Coq.
Now ask an admin to set up a pipeline schedule. The schedule should set all the
`_REV` variables to the branches that should be tested against. We usually only
......@@ -121,11 +124,11 @@ about broken builds. This can be achieved by having an admin follow these steps
To track performance of the project, one of the jobs should look like this:
```
build-coq.8.8.0:
build-coq.8.10.0:
<<: *template
variables:
OPAM_PINS: "coq version 8.8.0"
TIMING_CONF: "coq-8.8.0"
OPAM_PINS: "coq version 8.10.0"
TIMING_CONF: "coq-8.10.0"
tags:
- fp-timing
```
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment