Skip to content

chore: deprecate group module #24571

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

Merged
merged 6 commits into from
Apr 29, 2025
Merged

chore: deprecate group module #24571

merged 6 commits into from
Apr 29, 2025

Conversation

aljo242
Copy link
Contributor

@aljo242 aljo242 commented Apr 24, 2025

deprecate so that we can move it out to its own repo in the future

Summary by CodeRabbit

  • Documentation
    • Added deprecation notices to the x/group module documentation and related files, indicating that the module will be removed in the next major release and relocated to a new repository.

Copy link

ironbird-prod bot commented Apr 24, 2025

Ironbird - launch a network To use Ironbird, you can use the following commands:
  • /ironbird start OR /ironbird start --load-test-config= - Launch a testnet with the specified chain and load test configuration.
  • /ironbird chains - List of chain images that ironbird can use to spin-up testnet
  • /ironbird loadtests - List of load test modes that ironbird can run against testnet
Custom Load Test Configuration You can provide a custom load test configuration using the `--load-test-config=` flag:
/ironbird start cosmos --load-test-config={
  "block_gas_limit_target": 0.75,
  "num_of_blocks": 50,
  "msgs": [
    {"weight": 0.3, "type": "MsgSend"},
    {"weight": 0.3, "type": "MsgMultiSend"},
	{"weight": 0.4, "type": "MsgArr", "ContainedType": "MsgSend", "NumMsgs": 3300}
  ]
}

Use /ironbird loadtests to see more examples.

Copy link
Contributor

coderabbitai bot commented Apr 24, 2025

📝 Walkthrough

Walkthrough

The changes introduce deprecation notices to the x/group module within the codebase. Deprecation comments were added to the top of key Go source files (keeper.go, module.go, types.go) and a deprecation notice was inserted at the beginning of the module's README. These notices inform users that the x/group module is deprecated, will be removed in the next major release, and will be moved to a new repository (github.com/cosmos/cosmos-sdk-legacy). No changes were made to the code logic, APIs, or functionality.

Changes

File(s) Change Summary
x/group/README.md Added a deprecation notice at the start of the README, indicating future removal and repository move.
x/group/keeper/keeper.go Added a package-level deprecation comment at the top of the file.
x/group/module/module.go Added a package-level deprecation comment at the top of the file.
x/group/types.go Added a package-level deprecation comment at the top of the file.

📜 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 e2c7604 and 105eb4d.

📒 Files selected for processing (4)
  • x/group/README.md (1 hunks)
  • x/group/keeper/keeper.go (1 hunks)
  • x/group/module/module.go (1 hunks)
  • x/group/types.go (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (12)
  • GitHub Check: test-sim-nondeterminism
  • GitHub Check: test-integration
  • GitHub Check: test-e2e
  • GitHub Check: Check up to date mocks
  • GitHub Check: build (arm64)
  • GitHub Check: Analyze
  • GitHub Check: build (amd64)
  • GitHub Check: Check docs build
  • GitHub Check: golangci-lint
  • GitHub Check: Gosec
  • GitHub Check: dependency-review
  • GitHub Check: Summary
🔇 Additional comments (4)
x/group/types.go (1)

1-1: Deprecation notice added correctly.
The // Deprecated: comment clearly informs users that this package will be removed in the next major release and points to the new legacy repository. It matches the style and content in the other module files.

x/group/module/module.go (1)

1-1: Module package deprecation is consistent.
The package-level deprecation comment is properly formatted, prominently placed, and aligns with the notices added in related files (types.go, keeper.go, README).

x/group/README.md (1)

7-7: README deprecation notice is clear.
The warning banner at the top of the README effectively communicates the deprecation and upcoming migration to the legacy repo. No additional changes needed.

x/group/keeper/keeper.go (1)

1-1: Keeper package deprecation notice is in place.
The // Deprecated: comment at the top of the keeper file uniformly signals deprecation alongside other core files, ensuring consistency across the module.

✨ Finishing Touches
  • 📝 Generate Docstrings

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • 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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @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.

@aljo242 aljo242 added this pull request to the merge queue Apr 29, 2025
Merged via the queue into main with commit 72e88c9 Apr 29, 2025
47 checks passed
@aljo242 aljo242 deleted the chore/deprecate-group branch April 29, 2025 13:21
warpbuild-benchmark-bot bot added a commit to WarpBuilds/cosmos-sdk that referenced this pull request Apr 29, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants