docs(billing): document MongoDB ≥ 5.2 minimum (#3630)#3638
docs(billing): document MongoDB ≥ 5.2 minimum (#3630)#3638PierreBrisorgueil merged 2 commits intomasterfrom
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (2)
WalkthroughThis pull request updates project documentation to specify MongoDB ≥ 5.2 as a minimum version requirement. The changes document that the billing module's aggregation pipeline uses the ChangesMongoDB Version Requirement Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
There was a problem hiding this comment.
Pull request overview
Documents MongoDB ≥ 5.2 as the minimum supported version to prevent local dev/test failures caused by the billing module’s use of the $sortArray aggregation operator (MongoDB 5.2+).
Changes:
- Updates root prerequisites to explicitly require MongoDB ≥ 5.2 and explains the reason.
- Adds a MongoDB version requirement note to the billing Stripe setup documentation, including the typical failure symptom on older MongoDB versions.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| README.md | Updates project prerequisites to specify MongoDB ≥ 5.2 due to billing aggregation usage. |
| modules/billing/STRIPE_SETUP.md | Adds a Requirements section documenting MongoDB ≥ 5.2 and the common error on older versions. |
Summary
Document MongoDB ≥ 5.2 as the minimum supported version. The
billingmodule uses the\$sortArrayaggregation operator (introduced in 5.2). CI already runsmongo:7so production is unaffected — this is a local DX fix.Changes
README.md— bump install instruction + Prerequisites blockmodules/billing/STRIPE_SETUP.md— add Requirements section with the version + symptomWhy option 1 (docs)?
Per the issue, three options were considered:
\$sortArrayOption 1 was selected to keep the change local DX-only and avoid touching billing aggregation code for an LSE local-Mongo issue.
Test plan
closes #3630
Summary by CodeRabbit