chore: release #124
chore: release #124
Conversation
WalkthroughThis change updates package versions and adds changelog entries: Changes
Sequence Diagram(s)Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Pre-merge checks and finishing touches❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: defaults Review profile: CHILL Plan: Pro ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (4)
🚧 Files skipped from review as they are similar to previous changes (2)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
🔇 Additional comments (1)
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 |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: defaults
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
Cargo.lockis excluded by!**/*.lock
📒 Files selected for processing (4)
CHANGELOG.mdcrates/soar-cli/Cargo.tomlcrates/soar-core/CHANGELOG.mdcrates/soar-core/Cargo.toml
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: coverage
- GitHub Check: test
🔇 Additional comments (3)
crates/soar-cli/Cargo.toml (1)
3-3: LGTM: Patch version bump is appropriate.The version bump from 0.8.1 to 0.8.2 aligns with the non-breaking changes documented in the changelog (declarative installation feature, integration refactor, and documentation fixes).
CHANGELOG.md (1)
2-15: LGTM: Changelog entry is well-structured.The 0.8.2 changelog entry properly documents the declarative installation feature, integration refactor, and documentation fixes with appropriate commit references and PR links.
crates/soar-core/CHANGELOG.md (1)
2-11: LGTM: Changelog entry is consistent and complete.The 0.9.0 changelog entry appropriately documents the modular crates integration refactor and documentation fixes. The entry format is consistent with the existing changelog structure.
| [package] | ||
| name = "soar-core" | ||
| version = "0.8.1" | ||
| version = "0.9.0" |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Search for documentation files related to breaking changes, migration guides, changelog, etc.
echo "=== Looking for documentation files ==="
find . -maxdepth 3 -type f \( -iname "*changelog*" -o -iname "*migration*" -o -iname "*breaking*" -o -iname "*upgrade*" -o -iname "*release*notes*" \) 2>/dev/null | head -20
echo ""
echo "=== Checking root directory for common doc files ==="
ls -la . | grep -i -E "(changelog|migration|breaking|upgrade|release|readme|doc)"
echo ""
echo "=== Searching for 0.9.0 version mentions in documentation ==="
fd -t f -e md . | xargs rg "0\.9\.0" 2>/dev/null | head -20
echo ""
echo "=== Checking crates/soar-core directory structure ==="
ls -la crates/soar-core/ 2>/dev/null | head -30
echo ""
echo "=== Looking for CHANGELOG or similar in soar-core directory ==="
find crates/soar-core -maxdepth 2 -type f \( -iname "*changelog*" -o -iname "*migration*" -o -iname "*breaking*" \) 2>/dev/nullRepository: pkgforge/soar
Length of output: 1033
🏁 Script executed:
#!/bin/bash
# Read the soar-core CHANGELOG.md to check the 0.9.0 release notes
echo "=== Content of crates/soar-core/CHANGELOG.md (focusing on 0.9.0) ==="
sed -n '/## \[0.9.0\]/,/## \[0.8.1\]/p' crates/soar-core/CHANGELOG.md | head -100Repository: pkgforge/soar
Length of output: 696
🏁 Script executed:
#!/bin/bash
# Search for migration guide, additional docs, or references to breaking changes
echo "=== Checking for migration/upgrade guide files ==="
find . -type f -name "*.md" | xargs rg -l "migration|upgrade|breaking change" | head -10
echo ""
echo "=== Looking at root CHANGELOG to see if there's 0.9.0 info there ==="
sed -n '/## \[0.9.0\]/,/## \[0.8/p' CHANGELOG.md | head -50
echo ""
echo "=== Checking if there's a docs directory with API changes ==="
find . -maxdepth 3 -type d -name "docs" -o -name "doc" | head -5
echo ""
echo "=== Searching for any mention of 'breaking' in documentation files ==="
fd -t f -e md . | xargs rg -i "breaking" 2>/dev/null | head -20Repository: pkgforge/soar
Length of output: 531
Document breaking changes in the 0.9.0 release notes and provide a migration guide.
The CHANGELOG.md entry for 0.9.0 currently lacks detail about the breaking changes. The refactor commit "Integrate soar with modular crates" is too vague for downstream consumers to understand which APIs were removed or renamed. Expand the 0.9.0 CHANGELOG entry to explicitly document:
- Removed/renamed enums, functions, and structs
- Required code changes for users updating from 0.8.1
- A link or reference to a migration guide if one exists
This helps downstream users quickly identify and fix breaking changes in their code.
🤖 Prompt for AI Agents
In crates/soar-core/Cargo.toml around line 3 (version = "0.9.0"), the release
bumped to 0.9.0 but CHANGELOG.md lacks explicit breaking-change details; update
the 0.9.0 changelog entry (and add a migration guide file or section) to
enumerate exactly which enums, structs, and functions were removed or renamed,
provide concrete code migration steps for users upgrading from 0.8.1
(before/after code snippets or call replacements), and include a link/reference
to the migration guide or PR that introduced the refactor so downstream
consumers can apply fixes quickly.
QaidVoid
force-pushed
the
release-plz-2025-12-23T06-39-18Z
branch
2 times, most recently
from
9391b9d to
e499aa4
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: defaults
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
Cargo.lockis excluded by!**/*.lock
📒 Files selected for processing (4)
CHANGELOG.mdcrates/soar-cli/Cargo.tomlcrates/soar-core/CHANGELOG.mdcrates/soar-core/Cargo.toml
🚧 Files skipped from review as they are similar to previous changes (3)
- CHANGELOG.md
- crates/soar-core/Cargo.toml
- crates/soar-cli/Cargo.toml
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: coverage
- GitHub Check: test
| ## [0.9.0](https://github.com/pkgforge/soar/compare/soar-core-v0.8.1...soar-core-v0.9.0) - 2025-12-23 | ||
|
|
||
| ### ⛰️ Features | ||
|
|
||
| - *(install)* Allow remote package install - ([e060033](https://github.com/pkgforge/soar/commit/e060033ed1da14a9370650c5eddce6fc1f771c8d)) | ||
|
|
||
| ### 🚜 Refactor | ||
|
|
||
| - *(integration)* Integrate soar with modular crates ([#123](https://github.com/pkgforge/soar/pull/123)) - ([2d340e5](https://github.com/pkgforge/soar/commit/2d340e54ac79fd31087370712f4e189b3391bd16)) | ||
|
|
||
| ### ⚙️ Miscellaneous Tasks | ||
|
|
||
| - *(ci)* Ignore libsqlite-sys from machete - ([ca0f988](https://github.com/pkgforge/soar/commit/ca0f988df9973df521e73f50fb5ef1745f2295ea)) | ||
| - *(docs)* Update readme, bump msrv - ([5158af0](https://github.com/pkgforge/soar/commit/5158af067ecf3981585aad4f3097d675f65331d1)) | ||
| - *(docs)* Fix readme - ([90d8abb](https://github.com/pkgforge/soar/commit/90d8abb9206a304be4c3d8cd5d11ae40584242d6)) | ||
|
|
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
# Find and examine the full CHANGELOG.md file
find . -name "CHANGELOG.md" -path "*soar-core*" -type fRepository: pkgforge/soar
Length of output: 88
🏁 Script executed:
# Check git log for the v0.9.0 release or related commits
git log --oneline --all | grep -i "0.9.0\|release" | head -20Repository: pkgforge/soar
Length of output: 777
🏁 Script executed:
# Look for any breaking changes documentation in the repo
rg -i "breaking.*change|migration.*guide" --type md | head -20Repository: pkgforge/soar
Length of output: 39
🏁 Script executed:
# Search for cargo-semver-checks configuration
fd -e "cargo.*\|\.toml" | xargs rg -l "semver" 2>/dev/null | head -10Repository: pkgforge/soar
Length of output: 143
🏁 Script executed:
# Read the full CHANGELOG.md file
cat -n ./crates/soar-core/CHANGELOG.md | head -100Repository: pkgforge/soar
Length of output: 5678
🏁 Script executed:
# Check soar-core Cargo.toml for version
cat ./crates/soar-core/Cargo.toml | grep -A 5 "^\[package\]"Repository: pkgforge/soar
Length of output: 207
🏁 Script executed:
# Look for PR #123 reference in git history
git log --all --oneline --grep="#123\|modular" | head -10Repository: pkgforge/soar
Length of output: 129
🏁 Script executed:
# Check if there's any semver-checks output or CI config mentioning it
fd -e "yml\|yaml\|toml" | xargs rg -l "semver-check" 2>/dev/nullRepository: pkgforge/soar
Length of output: 41
🏁 Script executed:
# Examine the actual commit for breaking changes
git show 2d340e5 --stat | head -50Repository: pkgforge/soar
Length of output: 2978
🏁 Script executed:
# Look for any lib.rs public API exports or major structural changes
git show 2d340e5 -- "*/lib.rs" | head -100Repository: pkgforge/soar
Length of output: 3475
🏁 Script executed:
# Check if there's a PR template or discussion about breaking changes
fd -e "md" | xargs rg -l "PR #123\|pr.*123" 2>/dev/nullRepository: pkgforge/soar
Length of output: 41
🏁 Script executed:
# Look at version history to see if major bumps (0.x.0) have breaking changes sections in past
cat ./crates/soar-core/CHANGELOG.md | grep -A 20 "## \[0.8.0\]"Repository: pkgforge/soar
Length of output: 934
🏁 Script executed:
# Check if there's a contributing guide or changelog template
fd -e "md" -i contributing | head -5Repository: pkgforge/soar
Length of output: 72
🏁 Script executed:
# Check CONTRIBUTING guide for changelog conventions
cat ./CONTRIBUTING.mdRepository: pkgforge/soar
Length of output: 3292
🏁 Script executed:
# Check soar-db's old vs new public API by looking at the full error module changes
git show 2d340e5 -- "crates/soar-db/src/error.rs" "soar-db/src/error.rs" 2>/dev/null | head -150Repository: pkgforge/soar
Length of output: 2811
🏁 Script executed:
# Look for any migration guides or breaking change documentation elsewhere
fd -e "md" | xargs rg -l "migrat|breaking|breaking.*change" -i 2>/dev/null | head -10Repository: pkgforge/soar
Length of output: 99
🏁 Script executed:
# Check if there are Cargo.toml version constraints that would require semver checks
rg "soar-core|soar-db|soar-config" Cargo.toml | grep -E "version|path" | head -20Repository: pkgforge/soar
Length of output: 182
🏁 Script executed:
# Final check: Look at soar-core specifically for actual breaking changes evidence
git show 2d340e5 -- "crates/soar-core/src/error.rs" "crates/soar-core/src/lib.rs" 2>/dev/null | grep -A 5 "^+\|^-" | head -80Repository: pkgforge/soar
Length of output: 2399
🏁 Script executed:
# Check if soar-core is itself a library that other crates depend on
rg "soar-core.*=" crates/*/Cargo.toml | grep -E "path|version"Repository: pkgforge/soar
Length of output: 39
Add Breaking Changes section for major version bump.
The 0.9.0 release bumps the major version and includes API-breaking changes (e.g., soar-db API restructured with new connection/repository/error modules). The changelog lacks a dedicated "Breaking Changes" section to inform users migrating from 0.8.1 what broke and how to update their code.
Per semantic versioning conventions, breaking changes should be explicitly documented. At minimum, include a high-level summary of affected public APIs and migration guidance.
🤖 Prompt for AI Agents
In crates/soar-core/CHANGELOG.md around lines 2 to 17, add a top-level "Breaking
Changes" section for v0.9.0 that succinctly lists the API-breaking changes
(e.g., soar-db restructured into connection/, repository/, and error/ modules),
describes the impact on public APIs, and provides concise migration guidance for
consumers (what to replace/import and any behavior changes), reference the
relevant commits/PR/issue links, and note any required minimum MSRV or runtime
expectations so users can update their code when migrating from 0.8.1 to 0.9.0.
e499aa4 to
8d83330
Compare
QaidVoid
force-pushed
the
release-plz-2025-12-23T06-39-18Z
branch
from
8d83330 to
b6a9466
Compare
🤖 New release
soar-core: 0.8.1 -> 0.9.0 (⚠ API breaking changes)soar-cli: 0.8.1 -> 0.8.2⚠
soar-corebreaking changesChangelog
soar-coresoar-cliThis PR was generated with release-plz.
Summary by CodeRabbit
New Features
Bug Fixes
Refactor
Documentation
✏️ Tip: You can customize this high-level summary in your review settings.