Versions have four numbers from this release on.
Tests Catch3 does not run had no history, flaky detection or quarantine. --import=FILE reads a report instead of running tests and sends it through the analysis, history and reports of a run: JUnit with Surefire's reruns, xUnit.net v2, TRX, TAP 12 to 14, CTRF, Catch3's own --json report and catch3-results, a small JSON Lines format for tools with none of these. Results that share an identifier are attempts at one test, so a report of a rerun gives a flaky test. --import-revision says what was tested: a verdict that changes on one revision also counts as flaky. --import-name keeps the results in a history of their own, which --analytics reads too. A TAP stream that ends early fails instead of reading as a run that passed. The amalgamation script now accepts a relative include of the third-party wrappers, because pugixml is included from a second directory.
The release notes get their date and name the tag prefix Catch3 uses from now on. Every other version location already says 0.3.0; MODULE.bazel was the one left. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The move to C++17 left a trail of older claims. The Runner's own .clang-format still said c++20; the result is byte for byte the same under either value. Premake and Xmake still compiled the library as C++20 and the main library as C++14, which meant their CI jobs were not testing the language the project promises. Both now use C++17 for every target. The rest is text: the Meson pkg-config description claimed C++14, comments in the CMake and Meson files explained requirements that no longer exist, .clang-tidy gave C++14 as the reason for two exclusions, issue templates asked for C++20 samples, and the example headers named -std=c++14 and catch2-with-main. The release notes and the migration guide state the C++17 minimum. Doxygen's brief called the project "Catch2's test API", which presents it as Catch2. Meson declared only BSL-1.0; it now names both licenses of the tree. The amalgamated files are regenerated.
A project can now keep the options it always wants in a catch3.json instead of repeating them in every CTest, Bazel or CI command line. Where it is found: the runner looks in the working directory and in each directory above it, up to the root of the Git repository that holds the working directory, and reads the nearest file. Outside a repository it looks only in the working directory, so a stray file in a home directory never applies. --config=FILE names a file instead (relative to the working directory) and --no-config reads none; the last of the two wins. Workers, --help and --version read no file, so a broken file never stands in the way of help, and workers keep taking everything from their runner. What it says: strict JSON with "version": 1 required and "$schema" allowed for editors. The keys are the long options of the command line, and each value becomes the arguments it stands for and goes through the same parser, so there is one set of checks and one set of messages; the file and the key are named in front of them. Values are typed: switches take true (false for the negated adaptive-timeout and bisect), counts take whole numbers, timeout and the confidence interval take numbers, retries and seed take a number or a word, tests and warn take arrays, verbosity takes quiet, normal or verbose, and history takes a path or false. Paths are relative to the directory of the file. An unknown key is an error with a suggestion when it is close to a known one; a key that names an option for one run (shard, section, list, replay, ...) is told that it belongs on the command line. Repeated keys are refused. Precedence: the file's options are applied first and the command line on top, so the command line wins; test specs on the command line replace the file's tests instead of widening them with "or". --verbose names the file that was read. Options gains --config and --no-config, a ParseOptions overload that starts from given options, and a public EditDistance for the suggestions. The new ProjectConfig module holds the search, the key table and ParseCommandLine, which Runner now calls in place of ParseOptions. Tests cover the search (nearest file, the repository boundary, outside a repository), every key, words and defaults, relative and absolute paths, the messages for wrong files, precedence, --config, --no-config and the modes that read no file. A fuzzer reads arbitrary file text and checks that the worker arguments of the result parse again. The command line reference, the runner guide and the release notes describe the file; the amalgamated sources are regenerated.
The runner's hand-written JSON parser and writer, and its XML escaping,
are replaced by two established MIT libraries, vendored in third_party/:
yyjson 0.13.0 and pugixml 1.16. JsonValue and the JUnit model stay as they
are.
Both are compiled into Catch3's own translation units, so a project that
links its own yyjson or pugixml is not affected:
- src/Progmasoft/Runner/Yyjson.inl includes yyjson.c into Json.cpp with
yyjson_api defined as static, so no yyjson symbol leaves that file.
- src/Progmasoft/PugiXml.inl includes pugixml header-only into
XmlWriter.cpp with its namespace renamed to Progmasoft_Catch3_Pugi.
- Both are read as system headers, outside the warnings Catch3 builds
with; they are .inl files, which the header install rules leave out.
JSON keeps its behaviour: strings are bytes and come back as written
(invalid UTF-8 is allowed both ways), non-finite numbers are written as
null, documents nested deeper than 256 levels are refused while they are
converted, and whole numbers are written as integers. Fractions are now
written as the shortest text that reads back as the same double.
JUnit XML stays equivalent; pugixml writes ' and > in attributes as they
are, U+FFFD as the character itself and empty elements as <x />. The
tests follow.
third_party/{yyjson,pugixml} each have BUILD.bazel, CMakeLists.txt,
meson.build, xmake.lua and premake5.lua, which only provide the include
directory to the library; CMake links them through BUILD_INTERFACE.
tools/scripts/updateThirdParty.py pins the version and sha256 of each
archive; --check, now a step of the header and license workflow, fails
when a vendored file differs from its archive, and --update writes them.
Renovate proposes new versions through a regex manager on that table.
The amalgamation now has a third file, catch_amalgamated_third_party.hpp,
with both wrappers and the libraries inlined; catch_amalgamated.cpp
includes it once. The documents and the release notes say so.
Catch2 compatibility means the API tests are written in: the macros, such as TEST_CASE and REQUIRE, and the Catch:: namespace. It does not mean Catch2's build names or header paths. find_package(Catch2) found Catch3, and a project using both frameworks met two packages, two sets of targets, two Catch.cmake modules and two catch2/ header trees with the same names. Build names: - CMake: project and package Catch3, targets Catch3::Catch3 and Catch3::Catch3WithMain, libraries Catch3 and Catch3Main, options CATCH3_*, lib/cmake/Catch3 with Catch3Config, and pkg-config catch3 and catch3-with-main. The version is Catch3's, 0.3.0, compatible within a minor version. - The CMake scripts are Catch3.cmake (catch3_discover_tests), Catch3AddTests.cmake and Catch3ShardTests.cmake (catch3_add_sharded_tests); the helpers they define at ctest time have a catch3_ prefix. ParseAndAddCatchTests.cmake, deprecated upstream, is gone. - Bazel //:catch3 and //:catch3_main, Meson catch3 and catch3-with-main (with override_dependency), Xmake catch3 and catch3_main, Premake Catch3 and Catch3WithMain. Visual Studio projects get GUIDs of their own. - The Progmasoft::Catch3 target and package are gone: property testing and snapshots are part of Catch3::Catch3. Their sources now build with the library's warning flags, so property failures are built field by field (no missing initializers) and the default property name is a thread-local pointer to the name its scope owns (no global destructor). Headers: the engine moved from src/catch2 to src/Progmasoft/Catch3 with Progmasoft names, so <catch2/catch_test_macros.hpp> is <Progmasoft/Catch3/TestMacros.hpp>, <catch2/matchers/catch_matchers_string.hpp> is <Progmasoft/Catch3/Matchers/String.hpp>, and interface headers are named after their interface, such as Interfaces/IConfig.hpp. Include guards became #pragma once. The installed headers go to include/Progmasoft. src/Progmasoft/Context.cpp is StrategyContext.cpp, so no two sources share a file name. tools/scripts/upstreamFiles.txt lists the files that come from Catch2. The license check expects BSL-1.0 on them and Progmasoft's header on the rest of src/Progmasoft; the convenience-header check, the amalgamation script and the surrogate tests take the engine's headers from it. The amalgamated files are regenerated. The header-guard workflow checks for #pragma once instead of checkguard. Documents, the README and the release notes describe the new names.
Catch3 is maintained by Progmasoft, but the repository still carried Catch2's funding links, its maintainer list and GPG keys, a Code of Conduct contact at a Catch2 maintainer's address, its lists of users, its release process and release scripts, its AppVeyor configuration and its logos. - Removed FUNDING.yml, MAINTAINERS.md, appveyor.yml with the AppVeyor and OpenCppCoverage helpers, Catch2's user lists, why-catch, release process and deprecations pages, its two logos and the major/minor/patch release scripts. releaseCommon.py keeps only what the amalgamation reads. - The Code of Conduct sends reports to support@progmasoft.com. - contributing.md and release-notes.md are written for Catch3; Catch2's release history is linked upstream. - CMake, pkg-config and Doxygen name Catch3 and its repository; the amalgamated files say which Catch3 version and which Catch2 engine they come from.
Review Catch2 devel through 08092139210881f01a34e60c5f2fd6afa0ea4024, the commit of 3.16.1, and apply the eleven changes since the last reviewed revision in upstream order: d7683484 better message when a reporter cannot be initialized ea5020f0 custom argument validation in every first-party reporter aa01559e throwing-reporter test also throws in assertionEnded 45cd3987 noexcept on handleUnexpectedInflightException 6adbd539 MSVC optimizations enabled again after the benchmark headers e87f2882 no quadratic scaling for NTTP test registration 73d546cd REQUIRE expands its arguments fewer times under GCC and Clang b710039a decomposer operators as plain functions f899467b type-erased streaming of reconstructed expressions 8f0e70ca retired macos-14 runner dropped 08092139 version 3.16.1 and its release notes All of them applied to the sources without a conflict. The amalgamated distribution under extras/ conflicted because it is generated; it is generated again from the sources of this repository, which also brings it up to date with fork changes it had not picked up: the list-based stream pool, the Clang diagnostic boundary and the cassert include. No file under src/Progmasoft changes. The fork-owned texts that name the engine version say 3.16.1, and docs/upstream-status.md records the review. Upstream files keep their names, licenses and compiler options. Built with Clang 22 on Windows and tested: 148 of 149 tests pass. The one that fails, Reporters::CrashInJunitReporter, fails the same way on devel without this change with that compiler.