chore(release): update changelog and version to 1.6.0 #2360
Conversation
WalkthroughThe changes in this pull request involve updates to versioning across multiple packages within the Dashpay platform, transitioning from development versions ( Changes
Possibly related PRs
Suggested labels
Suggested reviewers
Warning Rate limit exceeded@shumkov has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 10 minutes and 10 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
shumkov
dismissed stale reviews from lklimek and QuantumExplorer
via
1f20f47
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (3)
packages/rs-dapi-client/Cargo.toml (1)
Several dependencies have newer versions available - updates recommended
Several dependencies in the project are behind their latest versions, with some having significant version differences:
backon: 1.2 → 1.3.0thiserror: 1.0.64 → 2.0.3tracing: 0.1.40 → 0.1.41tokio: 1.40 → 1.41.1lru: 0.12.3 → 0.12.5serde: 1.0.197 → 1.0.215serde_json: 1.0.120 → 1.0.133While no direct security vulnerabilities were found for the current dependencies, updating to the latest versions is recommended as they often include security patches and improvements. The major version bump in
thiserror(1.x to 2.x) may require code changes.🔗 Analysis chain
Line range hint
1-50: Verify dependency versions for potential security updatesSeveral dependencies are pinned to specific versions. While this is good for stability, it's important to regularly check for security updates.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Check for latest versions and security advisories of key dependencies # List of dependencies to check DEPS=("backon" "futures" "thiserror" "tracing" "tokio" "sha2" "hex" "lru" "serde" "serde_json" "chrono") echo "Checking latest versions on crates.io..." for dep in "${DEPS[@]}"; do echo "=== $dep ===" curl -s "https://crates.io/api/v1/crates/$dep" | jq -r '.crate.max_version' done # Check for any security advisories echo -e "\nChecking for security advisories..." gh api graphql -f query=' { securityVulnerabilities(first: 10, ecosystem: RUST) { nodes { package { name } advisory { summary severity publishedAt } vulnerableVersionRange } } }'Length of output: 4405
packages/rs-drive-proof-verifier/Cargo.toml (1)
Dependency stability concerns identified
The verification reveals two significant stability concerns:
- The
bincodedependency (version 2.0.0-rc.3) is used consistently across multiple packages in the workspace, indicating a systematic reliance on a release candidate version- Multiple GitHub dependencies are used with specific branches or tags, some pointing to forks (e.g., QuantumExplorer/tower, qrayven/ciborium)
While the tenderdash-abci tag (v1.2.1+1.3.0) exists and appears stable, the overall dependency strategy needs attention for production readiness.
- Consider upgrading bincode to a stable version when available or document the specific need for the RC version
- Review GitHub dependencies, especially those pointing to forks, to ensure long-term maintainability
- Document the rationale for using specific branches/forks in the project documentation
🔗 Analysis chain
Line range hint
1-65: Verify dependency stability for production releaseSome dependencies are using release candidate versions (e.g., bincode 2.0.0-rc.3). While this might be intentional, it's worth verifying the stability of these RC versions for a production release.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Check latest versions of critical dependencies and their stability status # Check if there are newer stable versions of bincode cargo search bincode --limit 1 # Check if tenderdash-abci tag exists and is stable gh api repos/dashpay/rs-tenderdash-abci/git/refs/tags/v1.2.1+1.3.0 # List all workspace package versions to ensure consistency fd -e toml -x grep -H "^version = " {} \;Length of output: 2217
Script:
#!/bin/bash # Let's try a different approach to check dependency versions and stability # Search for RC/beta/alpha dependencies in all Cargo.toml files rg -U 'version = ".*-(rc|alpha|beta)' --type toml # Check if bincode is used in other workspace packages rg 'bincode.*=' --type toml # Check if there are any GitHub dependencies (which might be less stable) rg 'git = "https://' --type tomlLength of output: 4541
packages/wasm-dpp/Cargo.toml (1)
Dependency stability concerns confirmed - Action required
wasm-bindgenversion synchronization:
- Cargo.toml: 0.2.86
- Dockerfile: 0.2.86 (wasm-bindgen-cli)
- While versions are currently in sync, the manual process remains risky
Fork dependency issues:
- The
serde-wasm-bindgenfork hasn't been updated since March 2023- Using an unmaintained fork poses stability risks
🔗 Analysis chain
Line range hint
12-31: Verify dependency stability for releaseTwo potential stability concerns in the dependencies:
- The TODO comment indicates that wasm-bindgen version needs manual synchronization across multiple files
- Using a git dependency (
serde-wasm-bindgen) from a fork could impact release stabilityLet's verify the wasm-bindgen version synchronization:
Consider:
- Automating the wasm-bindgen version synchronization
- Planning to migrate away from the forked dependency if possible
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Check wasm-bindgen version consistency across mentioned files echo "Checking wasm-bindgen version in Dockerfile:" rg -A 1 "wasm-bindgen" Dockerfile echo "\nChecking wasm-bindgen version in build script:" cat packages/wasm-dpp/scripts/build-wasm.sh | rg "wasm-bindgen" echo "\nChecking if the forked serde-wasm-bindgen repo is maintained:" gh api repos/QuantumExplorer/serde-wasm-bindgen/commits/feat/not_human_readable --jq '.commit.committer.date'Length of output: 1283
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
⛔ Files ignored due to path filters (1)
Cargo.lockis excluded by!**/*.lock
📒 Files selected for processing (46)
CHANGELOG.md(1 hunks)package.json(1 hunks)packages/bench-suite/package.json(1 hunks)packages/check-features/Cargo.toml(1 hunks)packages/dapi-grpc/Cargo.toml(1 hunks)packages/dapi-grpc/package.json(1 hunks)packages/dapi/package.json(1 hunks)packages/dash-spv/package.json(1 hunks)packages/dashmate/configs/getConfigFileMigrationsFactory.js(1 hunks)packages/dashmate/package.json(1 hunks)packages/dashpay-contract/Cargo.toml(1 hunks)packages/dashpay-contract/package.json(1 hunks)packages/data-contracts/Cargo.toml(1 hunks)packages/dpns-contract/Cargo.toml(1 hunks)packages/dpns-contract/package.json(1 hunks)packages/feature-flags-contract/Cargo.toml(1 hunks)packages/feature-flags-contract/package.json(1 hunks)packages/js-dapi-client/package.json(1 hunks)packages/js-dash-sdk/package.json(1 hunks)packages/js-grpc-common/package.json(1 hunks)packages/masternode-reward-shares-contract/Cargo.toml(1 hunks)packages/masternode-reward-shares-contract/package.json(1 hunks)packages/platform-test-suite/package.json(1 hunks)packages/rs-dapi-client/Cargo.toml(1 hunks)packages/rs-dapi-grpc-macros/Cargo.toml(1 hunks)packages/rs-dpp/Cargo.toml(1 hunks)packages/rs-drive-abci/Cargo.toml(1 hunks)packages/rs-drive-proof-verifier/Cargo.toml(1 hunks)packages/rs-drive/Cargo.toml(1 hunks)packages/rs-json-schema-compatibility-validator/Cargo.toml(1 hunks)packages/rs-platform-serialization-derive/Cargo.toml(1 hunks)packages/rs-platform-serialization/Cargo.toml(1 hunks)packages/rs-platform-value-convertible/Cargo.toml(1 hunks)packages/rs-platform-value/Cargo.toml(1 hunks)packages/rs-platform-version/Cargo.toml(1 hunks)packages/rs-platform-versioning/Cargo.toml(1 hunks)packages/rs-sdk/Cargo.toml(1 hunks)packages/simple-signer/Cargo.toml(1 hunks)packages/strategy-tests/Cargo.toml(1 hunks)packages/wallet-lib/package.json(1 hunks)packages/wallet-utils-contract/Cargo.toml(1 hunks)packages/wallet-utils-contract/package.json(1 hunks)packages/wasm-dpp/Cargo.toml(1 hunks)packages/wasm-dpp/package.json(1 hunks)packages/withdrawals-contract/Cargo.toml(1 hunks)packages/withdrawals-contract/package.json(1 hunks)
✅ Files skipped from review due to trivial changes (40)
- package.json
- packages/bench-suite/package.json
- packages/check-features/Cargo.toml
- packages/dapi-grpc/Cargo.toml
- packages/dapi-grpc/package.json
- packages/dapi/package.json
- packages/dash-spv/package.json
- packages/dashmate/configs/getConfigFileMigrationsFactory.js
- packages/dashmate/package.json
- packages/dashpay-contract/Cargo.toml
- packages/dashpay-contract/package.json
- packages/data-contracts/Cargo.toml
- packages/dpns-contract/Cargo.toml
- packages/dpns-contract/package.json
- packages/feature-flags-contract/Cargo.toml
- packages/feature-flags-contract/package.json
- packages/js-dapi-client/package.json
- packages/js-dash-sdk/package.json
- packages/js-grpc-common/package.json
- packages/masternode-reward-shares-contract/Cargo.toml
- packages/masternode-reward-shares-contract/package.json
- packages/platform-test-suite/package.json
- packages/rs-dapi-grpc-macros/Cargo.toml
- packages/rs-drive/Cargo.toml
- packages/rs-json-schema-compatibility-validator/Cargo.toml
- packages/rs-platform-serialization-derive/Cargo.toml
- packages/rs-platform-serialization/Cargo.toml
- packages/rs-platform-value-convertible/Cargo.toml
- packages/rs-platform-value/Cargo.toml
- packages/rs-platform-version/Cargo.toml
- packages/rs-platform-versioning/Cargo.toml
- packages/rs-sdk/Cargo.toml
- packages/simple-signer/Cargo.toml
- packages/strategy-tests/Cargo.toml
- packages/wallet-lib/package.json
- packages/wallet-utils-contract/Cargo.toml
- packages/wallet-utils-contract/package.json
- packages/wasm-dpp/package.json
- packages/withdrawals-contract/Cargo.toml
- packages/withdrawals-contract/package.json
🔇 Additional comments (10)
packages/rs-dapi-client/Cargo.toml (1)
3-3: LGTM: Version update aligns with release objectives
The version update from "1.6.0-dev.2" to "1.6.0" is consistent with the release process and matches the version updates across other packages.
packages/rs-drive-proof-verifier/Cargo.toml (1)
3-3: LGTM: Version bump aligns with release objectives
The version update from 1.6.0-dev.2 to 1.6.0 follows semantic versioning and correctly transitions from development to stable release.
packages/wasm-dpp/Cargo.toml (1)
3-3: LGTM: Version update aligns with release objectives
The version update from "1.6.0-dev.2" to "1.6.0" follows semantic versioning and matches the PR's release objectives.
packages/rs-drive-abci/Cargo.toml (1)
3-3: LGTM: Version bump to 1.6.0
The version update from development to stable release aligns with the PR objectives for releasing version 1.6.0.
packages/rs-dpp/Cargo.toml (2)
3-3: LGTM: Version bump aligns with release objectives.
The version change from 1.6.0-dev.2 to 1.6.0 correctly reflects the transition from development to stable release as intended in the PR.
3-3: Verify version consistency across workspace packages.
Let's ensure the version is consistently updated across all related packages in the workspace.
✅ Verification successful
Version consistency verified across workspace packages
All Rust packages in the workspace are at version 1.6.0, with only one exception:
rs-drive-verify-c-bindingat version 1.1.0
The JavaScript/Node.js packages are also consistently at version 1.6.0, with a few expected exceptions for external dependencies:
@dashevo/wallet-lib: 8.6.0@dashevo/dash-spv: 2.6.0dash: 4.6.0
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Check version consistency across workspace packages
# Expected: All related packages should be at version 1.6.0
# Find and check versions in all Cargo.toml files
fd -e toml -x grep -H "^version = " {} \;
# Find and check versions in all package.json files
fd -e json -x jq -r '. | select(.version != null) | .name + ": " + .version' {} \;
Length of output: 95544
CHANGELOG.md (4)
1-1: Well-structured changelog that follows best practices
The changelog follows proper semantic versioning, conventional commits format, and includes comprehensive documentation of changes. Breaking changes are clearly marked and explained.
3-10: Good organization of PR objectives section
The PR objectives section provides clear context about the purpose and scope of changes, including important metadata like PR number and author.
12-18: Comprehensive AI-generated summary
The AI summary effectively condenses the key changes and provides a high-level overview of the modifications across packages.
Line range hint 1-2360: Thorough version history documentation
The changelog maintains a detailed history of changes across versions, with proper categorization of changes (features, fixes, etc.) and clear marking of breaking changes. Each change links back to its PR for reference.
Issue being fixed or feature implemented
Release new Dash Platform version
What was done?
How Has This Been Tested?
None
Breaking Changes
None
Checklist:
For repository code-owners and collaborators only
Summary by CodeRabbit
Release Notes for Version 1.6.0
New Features
Bug Fixes
Version Updates
Documentation