-
Notifications
You must be signed in to change notification settings - Fork 3.8k
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
docs: sync main with 0.52 branch #23415
Conversation
📝 WalkthroughWalkthroughThis pull request involves updating changelogs for multiple modules, including Changes
Possibly related PRs
Suggested labels
Suggested reviewers
📜 Recent review detailsConfiguration used: .coderabbit.yml 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (5)
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
Documentation and Community
|
There was a problem hiding this 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
🧹 Nitpick comments (1)
server/v2/cometbft/CHANGELOG.md (1)
27-29
: Improve changelog entry formatting.The changelog entries follow a consistent format and provide clear references to pull requests. However, consider adding more descriptive messages that explain the impact of these changes.
For example:
-* [#23365](https://github.com/cosmos/cosmos-sdk/pull/23365) Align default response for filter cmd when `handleQueryP2P`. +* [#23365](https://github.com/cosmos/cosmos-sdk/pull/23365) Align default response for filter command when handling P2P queries to ensure consistent behavior across the application.
📜 Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
server/v2/cometbft/CHANGELOG.md
(1 hunks)tools/confix/CHANGELOG.md
(1 hunks)tools/confix/data/v0.52-app.toml
(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- tools/confix/CHANGELOG.md
🧰 Additional context used
📓 Path-based instructions (1)
server/v2/cometbft/CHANGELOG.md (1)
Pattern **/*.md
: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Summary
🔇 Additional comments (2)
server/v2/cometbft/CHANGELOG.md (1)
Line range hint
1-31
: LGTM! Documentation follows guidelines.The changelog follows the guiding principles outlined in the header comment:
- Entries are for humans
- Each version has its own section
- Changes are grouped
- Versions are linkable
- Latest version is first
- Format is consistent
tools/confix/data/v0.52-app.toml (1)
172-174
: 🛠️ Refactor suggestionEnhance documentation for the new gRPC header check configuration.
The documentation for
skip-check-header
should be expanded to:
- Specify which headers are being skipped
- Explain the security implications
- Provide example use cases
- Document potential risks
Consider following the documentation style of other options in this file, which include detailed explanations and examples.
Let's verify the security implications of this change:
✅ Verification successful
Documentation improvement suggested for gRPC header check configuration
The
skip-check-header
option appears to be a standard gRPC server configuration for metadata handling, with no security implications found in the codebase. While the documentation could be more detailed, this is not a critical issue.Suggested documentation improvement:
# SkipCheckHeader defines if the gRPC server should bypass metadata header checks. # This can be useful for debugging or performance optimization in development environments. # Default: false (header checks enabled) skip-check-header = false🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Search for related header check implementations and security measures rg -A 5 -B 5 'CheckHeader|HeaderCheck|skip.*header' # Look for any security-related comments or documentation ast-grep --pattern 'func $_($$) { $$$ header $$$ }'Length of output: 66534
Script:
#!/bin/bash # Search for gRPC server implementations and header validation rg -A 5 -B 5 'grpc.*Server|grpc.*header|header.*validation' # Look for security-related gRPC configurations rg -A 3 -B 3 'grpc.*security|grpc.*auth|grpc.*middleware' # Find header-related patterns in gRPC context ast-grep --pattern 'func $_($$) { $$$ grpc $$$ header $$$ }'Length of output: 71158
Added changelog from #23433 |
There was a problem hiding this 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
🧹 Nitpick comments (3)
CHANGELOG.md (3)
Line range hint
1-1
: Add missing title headerThe CHANGELOG file should start with a # Changelog title header for consistency with other documentation.
+ # Changelog
66-70
: Improve version header formattingThe version header should include a clear release date and link to the release tag.
- ## [v0.52.0-rc.2](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.52.0-rc.2) - 2025-01-17 + ## [v0.52.0-rc.2] - 2025-01-17 + + [v0.52.0-rc.2]: https://github.com/cosmos/cosmos-sdk/releases/tag/v0.52.0-rc.2
82-88
: Fix inconsistent issue reference formatThe issue reference in the Bug Fixes section is missing the full URL format used elsewhere in the document.
- * (query) [23002](https://github.com/cosmos/cosmos-sdk/pull/23002) Fix collection filtered pagination. + * (query) [#23002](https://github.com/cosmos/cosmos-sdk/pull/23002) Fix collection filtered pagination.
📜 Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
CHANGELOG.md
(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
CHANGELOG.md (1)
Pattern **/*.md
: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Summary
🔇 Additional comments (1)
CHANGELOG.md (1)
Line range hint
1-1000
: Verify future dates in changelogThe changelog contains dates in 2025 which are in the future. Please verify if these dates are intentional or should be updated to reflect actual release dates.
✅ Verification successful
Future dates in changelog are expected for pre-release versions
The date 2025-01-17 appears in the changelog for v0.52.0-rc.2, which is a release candidate of an unreleased version. This is expected behavior as pre-release versions often use future placeholder dates until the actual release. No changes are needed.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Find all dates in 2025 in the changelog grep -n "2025" CHANGELOG.mdLength of output: 329
Description
We have beta.2 of everything but store (blocked on #23380).
This just syncs the changelog and a missing field that was present on confix 0.52 but not main (while it should have)
Author Checklist
All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.
I have...
!
in the type prefix if API or client breaking changeCHANGELOG.md
Reviewers Checklist
All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.
Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.
I have...
Summary by CodeRabbit
skip-check-header
for gRPC server header validationsims
moduleserver
modulex/auth/ante
modulev1.0.0-beta.2
tools/confix
versionv0.2.0-rc.2
app.toml
validation for improved consistency between baseapp chains and v2 chainscodec
modulequery
modulex/auth/tx
module whenAuthInfo.Fee
is optionalInvariants
and associated methods in themodules