docs(integration-tests): Restructure dev-docs directory to accommodate package integration test docs.#1686
Conversation
WalkthroughDocumentation restructuring that updates navigation links to point to an index file within the integration-tests directory, adds two new documentation pages for testing CLP packages and binaries, and reorganizes the main integration tests documentation page with expanded sections. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Bill-hbrhbr
left a comment
There was a problem hiding this comment.
I don't see any issue and don't have a strong opinion of splitting the test guide into more granular chunks. Need to ask maintainers about this split.
|
Let's merge this only after the package task is in. #1664 |
| ### Using `pytest` markers | ||
|
|
||
| To run more specific sets of tests, you can use `pytest` directly with `pytest` markers. | ||
|
|
||
| :::{note} | ||
| Before running tests using `pytest`, ensure that the CLP package and/or core binaries have been | ||
| built. | ||
| ::: | ||
|
|
||
| Ensure all commands below are run from inside the `integration-tests` directory. | ||
|
|
||
| To list all available markers: | ||
|
|
||
| ```shell | ||
| uv run pytest --markers | ||
| ``` | ||
|
|
||
| To run tests related to a specific marker (e.g., `clp_s`): | ||
|
|
||
| ```shell | ||
| uv run pytest -m clp_s | ||
| ``` |
There was a problem hiding this comment.
Why'd we get rid of this?
There was a problem hiding this comment.
because the content will be modified and inserted into both integration-tests/binary.md and integration-tests/package.md in future PRs. each one of those files will have a "Running specific tests with pytest" section that'll talk about using pytest directly and how to use markers and stuff like that (with the information tailored to binary testing and package testing respectively).
that being said, for the time being I can just put it in integration-tests/index.md (I do have the content saved on a local branch but I agree there's no real need to get rid of the content in this PR)
2c46ca6
Description
This PR restructures the
dev-docsdirectory in preparation for docs on package integration tests and binary integration tests.Checklist
breaking change.
Validation performed
Built and served docs.
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.