diff options
Diffstat (limited to '.github/for_maintainers/tests_strategy.md')
-rw-r--r-- | .github/for_maintainers/tests_strategy.md | 28 |
1 files changed, 14 insertions, 14 deletions
diff --git a/.github/for_maintainers/tests_strategy.md b/.github/for_maintainers/tests_strategy.md index c25acf9b..338d4282 100644 --- a/.github/for_maintainers/tests_strategy.md +++ b/.github/for_maintainers/tests_strategy.md @@ -8,13 +8,13 @@ The aim is to help maintainers to anticipate third parties modifications, update ### Linux -As all the third parties are already installed (thanks to docker), the compilations has been seperated by categories to be parallelized: +As all the third parties are already installed (thanks to docker), the compilations have been separated in categories to be parallelized: * examples (C++) * tests (C++) * utils (C++) * doxygen (C++ documentation that is available in the artefacts) -* python (including documentation and code coverage that are available in the artefacts) +* python (including documentation and code coverage that are available in the artefacts; here the WITH_GUDHI_REMOTE_TEST option is enabled which adds datasets fetching test) (cf. `.circleci/config.yml`) @@ -25,9 +25,9 @@ Without CGAL, and, with or without Eigen builds are performed inside the docker #### Update docker images -C++ third parties installation are done thanks to apt on Ubuntu latest LTS. +C++ third parties installation is done thanks to apt on Ubuntu latest LTS. -Docker images need to be rebuild and push each time `.github/build-requirements`, `.github/test-requirements`, when a new third party is added, when a new CGAL version improves gudhi performances, ... +Docker images need to be rebuilt and pushed each time `.github/build-requirements`, `.github/test-requirements`, when a new third party is added, when a new CGAL version improves gudhi performances, ... ```bash docker build -f Dockerfile_for_circleci_image -t gudhi/ci_for_gudhi:latest . @@ -39,35 +39,35 @@ docker push gudhi/ci_for_gudhi_wo_cgal:latest ### Windows -The compilations are not parallelized, as installation time (about 30 minutes) is too much compare to +The compilations are not parallelized, as installation time (about 30 minutes) is too much compared to build and tests timings (about 30 minutes). Builds and tests include: * examples (C++) * tests (C++) * utils (C++) -* python +* python (here the WITH_GUDHI_REMOTE_TEST option is enabled which adds datasets fetching test) Doxygen (C++) is not generated. (cf. `azure-pipelines.yml`) -C++ third parties installation are done thanks to [vcpkg](https://github.com/microsoft/vcpkg/). -In case of installation issue, check in [vcpkg issues](https://github.com/microsoft/vcpkg/issues). +C++ third parties installation is done thanks to [vcpkg](https://github.com/microsoft/vcpkg/). +In case of an installation issue, check in [vcpkg issues](https://github.com/microsoft/vcpkg/issues). ### OSx The compilations are not parallelized, but they should, as installation time (about 4 minutes) is -negligeable compare to build and tests timings (about 30 minutes). Builds and tests include: +negligible compared to build and tests timings (about 30 minutes). Builds and tests include: * examples (C++) * tests (C++) * utils (C++) -* python +* python (here the WITH_GUDHI_REMOTE_TEST option is enabled which adds datasets fetching test) * Doxygen (C++) (cf. `azure-pipelines.yml`) -C++ third parties installation are done thanks to [brew](https://formulae.brew.sh/formula/). -In case of installation issue, check in formula issues. +C++ third parties installation is done thanks to [brew](https://formulae.brew.sh/formula/). +In case of an installation issue, check in formula issues. ## Pip packaging @@ -80,9 +80,9 @@ Only the Linux pip package is based on a docker image (`gudhi/pip_for_gudhi` bas ### Update docker image -C++ third parties installation are done thanks to yum on an image based on `quay.io/pypa/manylinux2014_x86_64`. +C++ third parties installation is done thanks to yum on an image based on `quay.io/pypa/manylinux2014_x86_64`. -Docker image need to be rebuild and push each time `.github/build-requirements`, when a new third party is added, when a new CGAL version improves gudhi performances, ... +Docker image needs to be rebuilt and pushed each time `.github/build-requirements`, when a new third party is added, when a new CGAL version improves gudhi performances, ... As `.github/test-requirements` is not installed, no need to rebuild image when this file is modified. ```bash |