Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(release): update changelog and bump version to 1.7.0 #2387

Merged
merged 3 commits into from
Dec 13, 2024

Conversation

shumkov
Copy link
Member

@shumkov shumkov commented Dec 13, 2024

Issue being fixed or feature implemented

Release new Dash Platform version

What was done?

  • Updated changelog
  • Bumped packages version

How Has This Been Tested?

None

Breaking Changes

None

Checklist:

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have added or updated relevant unit/integration/functional/e2e tests
  • I have made corresponding changes to the documentation

For repository code-owners and collaborators only

  • I have assigned this pull request to a milestone

Summary by CodeRabbit

  • New Features

    • Implementation of address bans in the SDK for enhanced security.
  • Bug Fixes

    • Resolved security vulnerability in the hashbrown library.
    • Fixed channel creation error due to empty addresses.
  • Breaking Changes

    • Removal of AddressList.available in the SDK.
    • Requirement to use Waitable for calling wait_for_response().
    • Changes to multiple arguments in functions related to state transition broadcast logic.
    • Updated error handling in the SDK for creating channels with empty addresses.
  • Build System Updates

    • Explicitly require tonic version 1.12.3 for compatibility.
  • Continuous Integration Updates

    • Removed manage runs workflow.
    • Upgraded actions/upload-artifact from version 3 to version 4.
  • Version Updates

    • Incremented version numbers across multiple packages from 1.6.2 to 1.7.0.

@shumkov shumkov added this to the v1.6.x milestone Dec 13, 2024
Copy link
Contributor

coderabbitai bot commented Dec 13, 2024

Walkthrough

The pull request introduces version 1.7.0 of the Dashpay platform, documenting several breaking changes, new features, bug fixes, and updates to the build and continuous integration systems. Key breaking changes involve error handling in the SDK, unification of state transitions, and the banning of certain addresses. The release also includes security enhancements, a required update for the tonic dependency, and improvements in CI processes, such as the removal of outdated workflows and upgrades to artifact handling. Additionally, various package version numbers have been incremented across multiple components.

Changes

File Path Change Summary
CHANGELOG.md Documented release of version 1.7.0, including breaking changes, features, bug fixes, and CI updates.
package.json Updated version from "1.6.2" to "1.7.0".
packages/bench-suite/package.json Updated version from 1.6.2 to 1.7.0.
packages/check-features/Cargo.toml Updated version from 1.6.2 to 1.7.0.
packages/dapi-grpc/Cargo.toml Updated version from 1.6.2 to 1.7.0.
packages/dapi-grpc/package.json Updated version from 1.6.2 to 1.7.0.
packages/dapi/package.json Updated version from 1.6.2 to 1.7.0.
packages/dash-spv/package.json Updated version from 2.6.2 to 2.7.0.
packages/dashmate/package.json Updated version from 1.6.2 to 1.7.0.
packages/dashpay-contract/Cargo.toml Updated version from 1.6.2 to 1.7.0.
packages/dashpay-contract/package.json Updated version from 1.6.2 to 1.7.0.
packages/data-contracts/Cargo.toml Updated version from 1.6.2 to 1.7.0.
packages/dpns-contract/Cargo.toml Updated version from 1.6.2 to 1.7.0.
packages/dpns-contract/package.json Updated version from 1.6.2 to 1.7.0.
packages/feature-flags-contract/Cargo.toml Updated version from 1.6.2 to 1.7.0.
packages/feature-flags-contract/package.json Updated version from 1.6.2 to 1.7.0.
packages/js-dapi-client/package.json Updated version from 1.6.2 to 1.7.0.
packages/js-dash-sdk/package.json Updated version from 4.6.2 to 4.7.0.
packages/js-grpc-common/package.json Updated version from 1.6.2 to 1.7.0.
packages/masternode-reward-shares-contract/Cargo.toml Updated version from 1.6.2 to 1.7.0.
packages/masternode-reward-shares-contract/package.json Updated version from 1.6.2 to 1.7.0.
packages/platform-test-suite/package.json Updated version from 1.6.2 to 1.7.0.
packages/rs-dapi-client/Cargo.toml Updated version from 1.6.2 to 1.7.0.
packages/rs-dapi-grpc-macros/Cargo.toml Updated version from 1.6.2 to 1.7.0.
packages/rs-dpp/Cargo.toml Updated version from 1.6.2 to 1.7.0.
packages/rs-drive-abci/Cargo.toml Updated version from 1.6.2 to 1.7.0.
packages/rs-drive-proof-verifier/Cargo.toml Updated version from 1.6.2 to 1.7.0.
packages/rs-drive/Cargo.toml Updated version from 1.6.2 to 1.7.0, corrected author email, updated dependencies.
packages/rs-json-schema-compatibility-validator/Cargo.toml Updated version from 1.6.2 to 1.7.0.
packages/rs-platform-serialization-derive/Cargo.toml Updated version from 1.6.2 to 1.7.0.
packages/rs-platform-serialization/Cargo.toml Updated version from 1.6.2 to 1.7.0, updated bincode dependency.
packages/rs-platform-value-convertible/Cargo.toml Updated version from 1.6.2 to 1.7.0.
packages/rs-platform-value/Cargo.toml Updated version from 1.6.2 to 1.7.0.
packages/rs-platform-version/Cargo.toml Updated version from 1.6.2 to 1.7.0.
packages/rs-platform-versioning/Cargo.toml Updated version from 1.6.2 to 1.7.0.
packages/rs-sdk/Cargo.toml Updated version from 1.6.2 to 1.7.0.
packages/simple-signer/Cargo.toml Updated version from 1.6.2 to 1.7.0.
packages/strategy-tests/Cargo.toml Updated version from 1.6.2 to 1.7.0.
packages/wallet-lib/package.json Updated version from 8.6.2 to 8.7.0.
packages/wallet-utils-contract/Cargo.toml Updated version from 1.6.2 to 1.7.0.
packages/wallet-utils-contract/package.json Updated version from 1.6.2 to 1.7.0.
packages/wasm-dpp/Cargo.toml Updated version from 1.6.2 to 1.7.0.
packages/wasm-dpp/package.json Updated version from 1.6.2 to 1.7.0.
packages/withdrawals-contract/Cargo.toml Updated version from 1.6.2 to 1.7.0.
packages/withdrawals-contract/package.json Updated version from 1.6.2 to 1.7.0.

Possibly related PRs

Suggested labels

dashmate, cleanup

Suggested reviewers

  • QuantumExplorer
  • lklimek

🐇 In the garden, changes bloom bright,
Version numbers rise, a joyful sight!
SDKs unite, with features anew,
Bugs fixed, and CI flows too!
Hop along, let’s celebrate this cheer,
Dashpay’s progress is crystal clear! 🌼


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 61f544f and aa65e57.

📒 Files selected for processing (1)
  • CHANGELOG.md (1 hunks)
🔇 Additional comments (1)
CHANGELOG.md (1)

1-44: LGTM! The changelog for version 1.7.0 follows the conventional commit format and clearly documents breaking changes.

The changelog properly documents:

  • Breaking changes with clear descriptions
  • New features and enhancements
  • Bug fixes and security updates
  • Build system and CI changes

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?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Experiment)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@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: 0

🧹 Outside diff range and nitpick comments (1)
CHANGELOG.md (1)

21-40: Consider adding migration guides for breaking changes

While the breaking changes are well documented, consider adding migration guides or code examples to help users update their code for the breaking changes.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 257e3da and 6d85b25.

⛔ Files ignored due to path filters (1)
  • Cargo.lock is excluded by !**/*.lock
📒 Files selected for processing (45)
  • 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/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 (44)
  • packages/simple-signer/Cargo.toml
  • packages/dpns-contract/Cargo.toml
  • packages/rs-platform-serialization-derive/Cargo.toml
  • packages/rs-platform-value-convertible/Cargo.toml
  • packages/wasm-dpp/Cargo.toml
  • packages/dashpay-contract/Cargo.toml
  • packages/check-features/Cargo.toml
  • packages/data-contracts/Cargo.toml
  • packages/rs-platform-value/Cargo.toml
  • packages/wallet-utils-contract/Cargo.toml
  • packages/feature-flags-contract/package.json
  • packages/rs-platform-versioning/Cargo.toml
  • packages/masternode-reward-shares-contract/Cargo.toml
  • packages/dpns-contract/package.json
  • packages/bench-suite/package.json
  • packages/rs-platform-version/Cargo.toml
  • packages/js-dapi-client/package.json
  • packages/wallet-lib/package.json
  • packages/js-grpc-common/package.json
  • packages/rs-json-schema-compatibility-validator/Cargo.toml
  • packages/dashpay-contract/package.json
  • packages/strategy-tests/Cargo.toml
  • package.json
  • packages/dash-spv/package.json
  • packages/dapi-grpc/Cargo.toml
  • packages/feature-flags-contract/Cargo.toml
  • packages/dashmate/package.json
  • packages/platform-test-suite/package.json
  • packages/rs-dapi-grpc-macros/Cargo.toml
  • packages/withdrawals-contract/Cargo.toml
  • packages/dapi-grpc/package.json
  • packages/rs-dapi-client/Cargo.toml
  • packages/wallet-utils-contract/package.json
  • packages/dapi/package.json
  • packages/rs-platform-serialization/Cargo.toml
  • packages/js-dash-sdk/package.json
  • packages/rs-drive-proof-verifier/Cargo.toml
  • packages/masternode-reward-shares-contract/package.json
  • packages/withdrawals-contract/package.json
  • packages/wasm-dpp/package.json
  • packages/rs-dpp/Cargo.toml
  • packages/rs-sdk/Cargo.toml
  • packages/rs-drive-abci/Cargo.toml
  • packages/rs-drive/Cargo.toml
🔇 Additional comments (5)
CHANGELOG.md (5)

1-1: LGTM! Version number follows semantic versioning

The version number 1.6.3 follows semantic versioning format (MAJOR.MINOR.PATCH) correctly.


4-9: Breaking changes are well documented

Breaking changes section properly documents the major changes that could affect compatibility:

  • SDK error handling changes
  • State transition processing unification
  • Address banning functionality

This helps users understand what changes may require updates to their code.


11-12: Features section is concise and clear

The features section clearly documents the new functionality added in this version.


15-18: Bug fixes are properly documented

Bug fixes section provides clear descriptions of what was fixed, with references to issue numbers.


Line range hint 1-1000: Overall changelog structure follows best practices

The changelog follows conventional changelog format with:

  • Proper version numbers and dates
  • Clear categorization of changes (breaking, features, fixes etc.)
  • Issue references
  • Consistent formatting throughout

This makes it easy for users to understand changes between versions.

@shumkov shumkov changed the title chore(release): update changelog and bump version to 1.6.3 chore(release): update changelog and bump version to 1.7.0 Dec 13, 2024
@shumkov shumkov merged commit 40ae73f into v1.7-dev Dec 13, 2024
129 checks passed
@shumkov shumkov deleted the release_1.6.3 branch December 13, 2024 10:35
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.

2 participants