Skip to content

chore: update peer dependency @zenstackhq/orm to version 3.5.0#23

Closed
sanny-io wants to merge 1 commit intodevfrom
chore/update-peer-3-5-0
Closed

chore: update peer dependency @zenstackhq/orm to version 3.5.0#23
sanny-io wants to merge 1 commit intodevfrom
chore/update-peer-3-5-0

Conversation

@sanny-io
Copy link
Copy Markdown
Member

@sanny-io sanny-io commented Apr 9, 2026

Summary by CodeRabbit

  • Chores
    • Updated minimum required dependency version to 3.5.0 or higher for enhanced compatibility and stability.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 9, 2026

📝 Walkthrough

Walkthrough

The changes update version requirements across documentation and package configuration, raising the minimum ZenStack @zenstackhq/orm dependency version from ^3.3.0 to ^3.5.0.

Changes

Cohort / File(s) Summary
Version Requirements Update
README.md, package.json
Updates minimum @zenstackhq/orm peer dependency version requirement from ^3.3.0 to ^3.5.0 in both documentation and package configuration.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: updating the peer dependency for @zenstackhq/orm to version 3.5.0, which is reflected in both package.json and README.md updates.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/update-peer-3-5-0

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between 024ae1a and b9c91c6.

⛔ Files ignored due to path filters (1)
  • bun.lock is excluded by !**/*.lock
📒 Files selected for processing (2)
  • README.md
  • package.json

},
"peerDependencies": {
"@zenstackhq/orm": "^3.3.0"
"@zenstackhq/orm": "^3.5.0"
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

🧩 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 || true

Repository: 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 -20

Repository: 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.

@sanny-io sanny-io closed this Apr 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant