diff --git a/docs/contributing.md b/docs/contributing.md index fd45cc44..f7d0f73a 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -104,6 +104,8 @@ cd Catch2 ./tools/scripts/buildAndTest.sh ``` +A Windows version of the script is available at `tools\scripts\buildAndTest.cmd`. + If you added new tests, you will likely see `ApprovalTests` failure. After you check that the output difference is expected, you should run `tools/scripts/approve.py` to confirm them, and include these changes diff --git a/tools/scripts/buildAndTest.cmd b/tools/scripts/buildAndTest.cmd new file mode 100644 index 00000000..bd753a3b --- /dev/null +++ b/tools/scripts/buildAndTest.cmd @@ -0,0 +1,17 @@ +rem Start at the root of the Catch project directory, for example: +rem cd Catch2 + +rem begin-snippet: catch2-build-and-test-win +rem 1. Regenerate the amalgamated distribution +python tools\scripts\generateAmalgamatedFiles.py + +rem 2. Configure the full test build +cmake -Bdebug-build -H. -DCMAKE_BUILD_TYPE=Debug -DCATCH_BUILD_EXAMPLES=ON -DCATCH_BUILD_EXTRA_TESTS=ON -DCATCH_DEVELOPMENT_BUILD=ON + +rem 3. Run the actual build +cmake --build debug-build + +rem 4. Run the tests using CTest +cd debug-build +ctest -j 4 --output-on-failure -C Debug +rem end-snippet