434a3c458a
- Updated CI documentation to enforce running the full suite without skipping the rbx-dom section, clarifying the execution steps. - Refactored `change_processor.rs` for improved readability by enhancing formatting and structure in name deduplication logic. - Cleaned up imports in `project.rs` and improved formatting in `file_names.rs` to enhance code clarity and maintainability. - Adjusted test assertions in `two_way_sync.rs` for better readability and consistency in checking file existence after renaming operations.
2.3 KiB
/ci - Complete CI Pipeline
Run the complete CI pipeline by executing the appropriate platform script.
Instructions
1. Run the CI Script
Always run the full suite including rbx-dom. No exceptions. No flags.
Windows (PowerShell):
.\scripts\ci.ps1
macOS/Linux (Bash):
bash scripts/ci.sh
Monitor the script output as it runs. After each step completes, check its result. If a step failed, kill the script and switch to manual fixing (step 2) — don't let it continue to the next step.
2. Fix Failures Between Steps
When a step fails, stop the script and fix the issue before continuing. Use targeted commands to speed up the feedback loop:
-
Formatting/linting failures — auto-fix with the relevant formatter (
cargo fmt,stylua), then verify with the specific check command only (e.g.cargo fmt --check). -
Test failures — investigate the implementation, not just the tests. For every failing test:
- Read the failing test to understand what behavior it asserts.
- Read the implementation code the test exercises.
- Determine the root cause:
- Implementation regression/bug: The feature is incomplete or broken. Fix the implementation so the test passes. Do not weaken or delete the test.
- Outdated test fixture: The test's snapshot or fixture data is stale because of an intentional change. Update the fixture with
cargo insta review/cargo insta accept, or regenerate the fixture data. Confirm the new fixture reflects correct behavior. - Incomplete feature: A new feature was added but doesn't fully handle all cases the tests cover. Complete the feature implementation rather than trimming the tests to match a partial implementation.
- Never delete or gut a test just to make CI green. Tests exist for a reason — the code must satisfy them, not the other way around.
- Re-run only the failing test(s) to verify fixes quickly (e.g.
cargo test <test_name>,cargo test -p <crate>). Do not re-run the entire suite until you believe all issues are resolved.
-
After all known issues are fixed, re-run the full CI script from step 1 to catch any remaining failures.
-
Repeat until the script exits with
Overall: PASS.
3. Report
Once CI passes clean, provide a brief summary of what was fixed (if anything) and confirm the final result.