Skip to content

docs: note that some unit tests are run on demand, not in CI - #4807

Closed
oharboe wants to merge 1 commit into
The-OpenROAD-Project:masterfrom
oharboe:docs/local-unit-tests
Closed

oharboe wants to merge 1 commit into
The-OpenROAD-Project:masterfrom
oharboe:docs/local-unit-tests

Conversation

@oharboe

@oharboe oharboe commented Nov 8, 2026 •

Copy link
Copy Markdown
Collaborator

Before: CI runs flow/test/test_*.py. Some unit tests elsewhere in the tree are run on demand and are not hooked up to CI, and nothing in the docs says so.
Now: docs/contrib/DeveloperGuide.md says so, and that such tests may need some maintenance before they pass.

🤖 Generated with Claude Code

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the developer guide to document unit tests that are not executed by CI, providing commands to run them locally. The review feedback correctly points out that the shell loop for running memory tests should fail early if any individual test fails, rather than silently masking failures if the final test succeeds.

Comment thread docs/contrib/DeveloperGuide.md Resolved
CI runs flow/test/test_*.py. Some unit tests elsewhere in the tree are
run on demand and are not hooked up to CI, so a green CI run says
nothing about them and they may need some maintenance before they pass.
Say so in the developer guide.

Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
@oharboe
oharboe force-pushed the docs/local-unit-tests branch from c03eca6 to 002b99b Compare November 8, 2026 09:30
@oharboe oharboe changed the title docs: list the unit tests CI does not run, and how to run them docs: note that some unit tests are run on demand, not in CI Nov 8, 2026
@oharboe

oharboe commented Nov 8, 2026

Copy link
Copy Markdown
Collaborator Author

Superseded by #4808: hook these tests up to CI instead of documenting that they are not.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant