chore: update peer dependency @zenstackhq/orm to version 3.5.0#23
chore: update peer dependency @zenstackhq/orm to version 3.5.0#23
@zenstackhq/orm to version 3.5.0#23Conversation
📝 WalkthroughWalkthroughThe changes update version requirements across documentation and package configuration, raising the minimum ZenStack Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 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.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@package.json`:
- Line 136: The package.json has introduced a breaking peer-dependency change by
raising "@zenstackhq/orm" to "^3.5.0" but the package version remains "1.0.6";
update the "version" field in package.json to "2.0.0" to reflect the major
breaking change so consumers and registries correctly recognize it as a major
release, and ensure any release notes/CHANGELOG and README references (if they
check package.json) are consistent with this bump.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: ee111078-fe62-4685-b20a-dcdabb6a0e75
⛔ Files ignored due to path filters (1)
bun.lockis excluded by!**/*.lock
📒 Files selected for processing (2)
README.mdpackage.json
| }, | ||
| "peerDependencies": { | ||
| "@zenstackhq/orm": "^3.3.0" | ||
| "@zenstackhq/orm": "^3.5.0" |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "== package version and peer dependency =="
cat package.json | jq '{version, peerDependencies}'
echo
echo "== release metadata (changesets/notes) =="
fd -HI --type f . .changeset 2>/dev/null || true
rg -n -C2 --hidden --glob '.changeset/**' 'major|breaking|peer|@zenstackhq/orm|zenstack-cache' || true
echo
echo "== CI/release workflows mentioning versioning =="
fd -HI --type f '.+\.ya?ml' .github/workflows 2>/dev/null || true
rg -n -C2 --hidden 'changeset|release|npm publish|version' .github/workflows 2>/dev/null || trueRepository: visualbravo/zenstack-cache
Length of output: 819
🏁 Script executed:
# Check for documentation of breaking changes
fd -HI --type f '(CHANGELOG|MIGRATION|BREAKING|RELEASE)' . 2>/dev/null | head -20
# Check for any git tags or version history
git tag -l 'v*' 2>/dev/null | sort -V | tail -5 || echo "No git tags found"
# Check if there's any documentation in docs/ or similar
fd -HI --type f 'README|GUIDE' . 2>/dev/null | head -10
# Look for any comments in package.json about versioning strategy
cat package.json | head -20Repository: visualbravo/zenstack-cache
Length of output: 588
🏁 Script executed:
# Check README for any migration or breaking change notes
cat README.md | grep -i -A5 -B5 'breaking\|migration\|upgrade\|version\|3\.5\|3\.3\|peer' || echo "No breaking/migration notes found"
# Check if there's a commit message or PR description in the repo
git log --oneline -20 2>/dev/null | head -10
# Verify actual peer dependency constraint before this change
git show HEAD~1:package.json 2>/dev/null | jq '.peerDependencies' || echo "Cannot retrieve previous version"Repository: visualbravo/zenstack-cache
Length of output: 1151
🏁 Script executed:
# Double-check current version and verify if there's a release plan
cat package.json | jq '{name, version, peerDependencies}'
# Check git diff to confirm the peer dependency change
git diff HEAD~1 HEAD -- package.json 2>/dev/null | grep -A2 -B2 '@zenstackhq/orm' || echo "No diff available"Repository: visualbravo/zenstack-cache
Length of output: 214
Peer dependency floor increase requires major version bump in package.json.
Line 136 raises the minimum supported @zenstackhq/orm to ^3.5.0, which is a breaking change for consumers on 3.3.x/3.4.x. While the README correctly documents the new requirement (version >= 3.5.0), the package version remains 1.0.6. This should be released as 2.0.0 to properly signal the breaking change and avoid accidental downgrades or incorrect dependency resolution. Update the version field in package.json accordingly.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@package.json` at line 136, The package.json has introduced a breaking
peer-dependency change by raising "@zenstackhq/orm" to "^3.5.0" but the package
version remains "1.0.6"; update the "version" field in package.json to "2.0.0"
to reflect the major breaking change so consumers and registries correctly
recognize it as a major release, and ensure any release notes/CHANGELOG and
README references (if they check package.json) are consistent with this bump.
Summary by CodeRabbit