How to test your pull request
The medium-term plan is have github to request a build automatically for each pull-request.
Meanwhile, there are two approaches depending if you have a Jenkins Inria account.
I don't have a Jenkins account
If you do not yet have an account at our Jenkins instance, you can create one:
go to this place
- click on "Sign Up"
- provide required information
- click on "Log In"
go to "dashboard"
- click on "Join an existing project"
- and request to join the project "coq"
You'll have to wait until some of the existing members of the project actually confirms your membership.
I have a Jenkins account
The following sections describe how you can use your Jenkins account
- either to test whether your branch does not break some of the tracked developments
- or to run benchmarks (i.e. observe changes in compilation times of tracked developments).
Check if a given branch breaks some of the tracked developments
Benchmarking (without "overlays")
where the field coq_opam_packages is by default set to:
coq-hott coq-flocq coq-compcert coq-vst coq-geocoq coq-color coq-fiat-crypto coq-fiat-parsers coq-unimath coq-sf coq-mathcomp-ssreflect coq-iris coq-mathcomp-fingroup coq-mathcomp-finmap coq-coquelicot coq-mathcomp-algebra coq-mathcomp-solvable coq-mathcomp-field coq-mathcomp-character coq-mathcomp-odd_order
Assuming that you will use the above value for the coq_opam_packages field, the benchmarking will finish in:
- 7 hours when each package is compiled once
- 15 hours when each package is compiled twice
- 22 hours when each package is compiled thrice
- 28 hours when each package is compiled four-times
The job itself produces a looooong log. At its end you should see the results rendered as a table:
Each line shows the measurement for a single OPAM package.
Each measured/computed quantity has its own column.
The git commits, that were considered are stated explicitely below the table as NEW and OLD.
E.g., in the table shown above, we see that the compilation of coq-geocoq
- originally took 2394.71 seconds
- now it takes 2215.65
- which means that it decreased by cca. 7%
The lines of the table are ordered wrt. improvements in the overall compilation times.
Benchmarking (with "overlays")
The following two parameters of the job:
enable us to define "overlays", i.e. tweak the definitions of OPAM packages to be used with new_coq_commit.
Concretely, one has to:
clone the official repository that defines the OPAM packages
- modify the definitions of the relevant OPAM packages as needed
- push these modifications to some repository visible to Jenkins (e.g. to a personal github fork)
and when starting the benchmarking job, set the new_coq_opam_archive_git_uri and new_coq_opam_archive_git_branch appropriatelly.