Reference
CI/CD Integration
Run OrbitTest reliably in GitHub Actions or another CI system with sharding and artifacts.
Documentation goal: this page is written as practical product documentation, with enough context to help a real QA engineer decide how to use the feature in a maintainable test suite.
CI goals
A CI test run should be repeatable, fast enough to matter, and rich in artifacts when it fails. Do not optimize only for green builds. Optimize for fast diagnosis of red builds.
Sharding and workers
Use workers for parallelism on one machine and sharding across multiple jobs. Keep an eye on application backend limits, test data collisions, and browser CPU pressure.
Artifacts
Always upload reports on failure. HTML reports, screenshots, traces, and JUnit files are the evidence developers need when they cannot reproduce the failure locally.
npx orbittest run --ci --workers 2 --shard 1/2 --github-annotations
npx orbittest run --ci --workers 2 --shard 2/2 --github-annotations
Practical checklist
- Keep the workflow readable enough that a QA engineer, developer, or product teammate can understand the intent without opening application source code.
- Prefer user-visible names, stable configuration, and clear evidence over hidden assumptions or brittle implementation details.
- Run the smallest useful check locally before adding it to CI, then verify that failures produce screenshots, logs, traces, or reports that explain what happened.
- Review this part of the suite regularly so outdated examples, stale setup, and obsolete workarounds do not reduce trust in the automation.
Common mistakes to avoid
- Do not add automation only to increase test count. Each page and test should protect a clear user journey, release risk, or debugging need.
- Do not hide important behavior inside helpers so deeply that the test no longer explains what the user is doing.
- Do not rely on fixed sleeps when the application can expose a meaningful ready state such as visible text, URL change, element availability, or completed evidence capture.
- Do not ignore failing artifacts. A report, screenshot, trace, or log entry should feed back into better product code, better waits, or clearer test data setup.
Was this page useful?
Your response is saved in this browser and helps shape the docs experience.