Skip to content

Commit d218082

Browse files
committed
README: Add "Testing environments" section
1 parent f143725 commit d218082

File tree

1 file changed

+19
-2
lines changed

1 file changed

+19
-2
lines changed

README.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ SlicerExecutionModel
33

44
[![Circle CI](https://circleci.com/gh/Slicer/SlicerExecutionModel.svg?style=svg)](https://circleci.com/gh/Slicer/SlicerExecutionModel)
55

6-
[![](https://images.microbadger.com/badges/image/slicer/slicerexecutionmodel.svg)](https://microbadger.com/images/slicer/slicerexecutionmodel)
7-
86
Overview
97
--------
108

@@ -27,6 +25,7 @@ do better.
2725
We encourage a range of contributions, from patches that include passing tests and
2826
documentation, all the way down to half-baked ideas that launch discussions.
2927

28+
3029
### How to submit a PR
3130

3231
If you are new to SlicerExecutionModel development and you don't have push access to the
@@ -50,6 +49,7 @@ When submitting a PR, make sure to add a ``Cc: @slicer/slicerexecutionmodel`` co
5049
developers of your awesome contributions. Based on the
5150
comments posted by the reviewers, you may have to revisit your patches.
5251

52+
5353
### Automatic testing of pull requests
5454

5555
When you submit a PR to the SlicerExecutionModel repo, CircleCI will run the build and test suite on the
@@ -64,6 +64,23 @@ Your test results will be posted on [SlicerExecutionModel's dashboard](http://sl
6464
These results will list any failed tests. You can reach your
6565
build by clicking the build status link on your GitHub PR.
6666

67+
68+
### Testing environments
69+
70+
With each PR, SlicerExecutionModel is built and tested against multiple version of ITK. Each
71+
environment is made available in docker images:
72+
73+
* Each environment is described in a ``Dockerfile`` found in a ``Docker-ITK-vX.Y.Z`` subdirectory of [test](./test).
74+
* Testing using a given environment is enabled updating the [circle.yml](circle.yml) file.
75+
* Before enabling an environment, associated docker image has to be (1) built locally running the `build.sh` script
76+
and (2) manually pushed to [dockerhub](https://hub.docker.com/r/slicer/slicerexecutionmodel/tags/).
77+
78+
Available environments are:
79+
80+
* [![](https://images.microbadger.com/badges/version/slicer/slicerexecutionmodel:itk-v4.8.0_use_system_libraries-off.svg)](https://microbadger.com/images/slicer/slicerexecutionmodel:itk-v4.8.0_use_system_libraries-off)
81+
* [![](https://images.microbadger.com/badges/version/slicer/slicerexecutionmodel:itk-v4.10.1_use_system_libraries-off.svg)](https://microbadger.com/images/slicer/slicerexecutionmodel:itk-v4.10.1_use_system_libraries-off "Get your own version badge on microbadger.com")
82+
83+
6784
### How to integrate a PR
6885

6986
Getting your contributions integrated is relatively straightforward, here is the checklist:

0 commit comments

Comments
 (0)