dart-ci

DART CI/CD troubleshooting - GitHub Actions, cache debugging, platform-specific failures

SKILL.md

GitHub

DART CI/CD Troubleshooting

Load this skill when debugging CI failures or working with GitHub Actions.

When the failing claim depends on model/scene structure, physics behavior, or Filament output, also load dart-verify-sim and reproduce it with a text oracle plus assessed visual evidence. Document a visual exception when graphics support is unavailable or not applicable in the failing environment.

Quick Commands

# Monitor PR checks
gh pr checks <PR_NUMBER>
gh pr view <PR_NUMBER> --json headRefOid,mergeStateStatus,statusCheckRollup

# View run details
gh run list --branch <BRANCH> -e pull_request -L 20
gh run view <RUN_ID> --json status,conclusion,url

# Debug failures
gh run view <RUN_ID> --job <JOB_ID> --log-failed
gh run view <RUN_ID> --json jobs --jq '.jobs[] | {name, databaseId}'

# Rerun failed jobs only after explicit maintainer/user approval
gh run rerun <RUN_ID> --failed
gh run rerun <RUN_ID> --job <DATABASE_ID>

Full Documentation

For complete CI/CD guide: docs/onboarding/ci-cd.md

Common Failure Modes

Failure Type Solution
Formatting fails pixi run lint; push only after approval
Codecov patch fails Add tests for uncovered lines
FreeBSD RTTI fails Use type enums + static_cast instead of dynamic_cast
macOS ARM64 SEGFAULT Replace alloca()/VLAs with std::vector<T>
RTD build fails Use defensive .get(key, default) patterns
gz-physics fails Reproduce with pixi run -e gazebo test-gz
CI Filament fails Configure with pixi run config -- -DDART_ENABLE_GUI_SMOKE_TESTS=ON, then run pixi run test-gui; native-window failures with pixi run ctest --test-dir build/<env>/cpp/Release -L filament-native (pixi run ctest --test-dir build/<env>/cpp -C Release -L filament-native on Windows; under xvfb-run on headless Linux); consumer failures with pixi run python scripts/test_gui_install.py on that build directory

Workflow Architecture

The CI workflows that a failing PR check belongs to (full workflow index: docs/onboarding/ci-cd.md § "Workflow Index"):

Workflow Purpose Platforms
ci_ubuntu.yml AI checks, lint, build, test, coverage Ubuntu
ci_macos.yml Lint, build, test macOS
ci_windows.yml Lint, build, test Windows
ci_filament.yml Filament GUI functional lane (<runner>-Filament-functional; not yet required) Ubuntu, Windows, macOS
ci_freebsd.yml Build + test (VM) FreeBSD
ci_simd.yml SIMD x86 instruction-level matrix Ubuntu x86_64
ci_toolchain.yml Alternate toolchain build + test Ubuntu
ci_gz_physics.yml Gazebo integration Ubuntu
api_doc.yml Doxygen API docs build Ubuntu

FreeBSD, toolchain, CodeQL, wheels, Linux ASan/coverage/Eigen alignment, and macOS Debug run only in nightly.yml; their failures arrive as nightly-failure issues, not PR checks.

Default test gates exclude device-dependent CTests labeled gui-device and Python rendering tests; device-free GUI tests still run. pixi run test-gui selects all gui CTests except filament-native. The capture smoke option DART_ENABLE_GUI_SMOKE_TESTS defaults to OFF, needs a graphics device, and replaces DART_ENABLE_GUI_OSG_SMOKE_TESTS; CI Filament enables it.

Downstream Compatibility Policy

Package, exported-target, collision, constraint, and dependency changes can affect Gazebo/gz-physics even when local unit tests pass. Reproduce those failures with the Gazebo Pixi environment when practical: pixi run -e gazebo test-gz.

Fast Iteration Loop

  1. Identify failing step from job logs
  2. Reproduce locally with same build toggles
  3. Fix the smallest failing test
  4. Push only after explicit maintainer/user approval, then monitor: gh run view <RUN_ID> --json status,conclusion,url

Caching And Duration

Treat the current run and job logs as authoritative. Inspect cache restore/save steps and job timestamps before changing a key; do not rely on fixed duration or cache-speed estimates in this skill.