Point main README.rst to CI for supported platforms and compilers #5910
+17
−18
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…pilers - **Replace** the hard-coded “Supported compilers” and “Supported platforms” lists in `README.rst`. - **Point** readers to the current GitHub Actions matrix as the source of truth for tested platforms, compilers, and Python/C++ versions. - **Clarify** that the matrix evolves over time and that configurations users care about can be kept working via contributions. - **Avoid stale documentation**: Enumerating specific compiler and platform versions in the README is both burdensome and error-prone, and tends to drift out of sync with reality. - **Align “supported” with “tested”**: In practice, the CI configuration is the only place where we can say with confidence which combinations are exercised. Nearby versions (e.g., adjacent compiler minor releases) will often work, but we cannot test every variant. - **Reflect actual maintenance capacity**: pybind11 is maintained by a small, volunteer-based community, so support is necessarily best-effort. Pointing to CI and inviting contributions better matches how support is provided in practice. - **No behavior change**: This PR updates documentation only. - **Living source of truth**: As CI jobs are added or removed, the linked Actions view will automatically reflect the set of configurations we actively test. Keeping a configuration in CI is the best way to keep it “supported”.
3 tasks
…obs under the free tier (rather than free minutes).
Skylion007
approved these changes
Nov 29, 2025
Collaborator
Author
|
Thanks @Skylion007 for this one, too! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Replace the hard-coded “Supported compilers” and “Supported platforms” lists in
README.rst.Point readers to the current GitHub Actions matrix as the source of truth for tested platforms, compilers, and Python/C++ versions.
Clarify that the matrix evolves over time and that configurations users care about can be kept working via contributions.
Avoid stale documentation: Enumerating specific compiler and platform versions in the README is both burdensome and error-prone, and tends to drift out of sync with reality.
Align “supported” with “tested”: In practice, the CI configuration is the only place where we can say with confidence which combinations are exercised. Nearby versions (e.g., adjacent compiler minor releases) will often work, but we cannot test every variant.
Reflect actual maintenance capacity: pybind11 is maintained by a small, volunteer-based community, so support is necessarily best-effort. Pointing to CI and inviting contributions better matches how support is provided in practice.
No behavior change: This PR updates documentation only.
Living source of truth: As CI jobs are added or removed, the linked Actions view will automatically reflect the set of configurations we actively test. Keeping a configuration in CI is the best way to keep it “supported”.
Description
Suggested changelog entry:
README.rstwere replaced with a new “Supported platforms & compilers“ section that points to the CI test matrix as the living source of truth.