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

docs: sync main with 0.52 branch #23415

Merged
merged 7 commits into from
Jan 17, 2025
Merged

docs: sync main with 0.52 branch #23415

merged 7 commits into from
Jan 17, 2025

Conversation

julienrbrt
Copy link
Member

@julienrbrt julienrbrt commented Jan 16, 2025

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...

  • included the correct type prefix in the PR title, you can find examples of the prefixes below:
  • confirmed ! in the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • updated the relevant documentation or specification, including comments for documenting Go code
  • confirmed all CI checks have passed

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...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

  • New Features
    • Added new configuration option skip-check-header for gRPC server header validation
    • Integrated with app v2 in the sims module
    • Added custom rollback command option in the server module
    • Allowed custom verification of public keys in the x/auth/ante module
  • Releases
    • Updated CometBFT module to version v1.0.0-beta.2
    • Released tools/confix version v0.2.0-rc.2
  • Improvements
    • Loosened app.toml validation for improved consistency between baseapp chains and v2 chains
    • Improved edge case handling for recursion limits in the codec module
  • Bug Fixes
    • Fixed collection filtered pagination in the query module
    • Avoided panic in the x/auth/tx module when AuthInfo.Fee is optional
  • Deprecated
    • Deprecated Invariants and associated methods in the modules

@julienrbrt julienrbrt requested a review from a team as a code owner January 16, 2025 09:57
Copy link
Contributor

coderabbitai bot commented Jan 16, 2025

📝 Walkthrough

Walkthrough

This pull request involves updating changelogs for multiple modules, including server/v2/cometbft, tools/confix, and a general CHANGELOG.md. The server/v2/cometbft changelog is updated to version v1.0.0-beta.2, detailing several specific changes. The tools/confix changelog introduces version v0.2.0-rc.2, documenting a modification to app.toml validation. Additionally, a new configuration option skip-check-header is added to the gRPC section of the TOML file. A comprehensive update is also made to the general CHANGELOG.md, covering new features, improvements, bug fixes, and deprecated functionalities.

Changes

File Change Summary
server/v2/cometbft/CHANGELOG.md Version updated from v1.0.0-beta.1 to v1.0.0-beta.2 with new entries detailing changes.
tools/confix/CHANGELOG.md Added version v0.2.0-rc.2 with a change to app.toml validation.
tools/confix/data/v0.52-app.toml Added skip-check-header = false in [grpc] section.
CHANGELOG.md Added new section for version v0.52.0-rc.2 with entries for features, improvements, bug fixes, and deprecations.
server/v2/appmanager/CHANGELOG.md Updated URL for version v1.0.0-beta.2.

Possibly related PRs

Suggested labels

C:Store, C:server/v2 appmanager, backport/v0.52.x

Suggested reviewers

  • sontrinh16
  • akhilkumarpilli

📜 Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4f10f75 and fbe0686.

📒 Files selected for processing (1)
  • server/v2/appmanager/CHANGELOG.md (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • server/v2/appmanager/CHANGELOG.md
⏰ Context from checks skipped due to timeout of 90000ms (5)
  • GitHub Check: repo-analysis
  • GitHub Check: build (arm64)
  • GitHub Check: build (amd64)
  • GitHub Check: dependency-review
  • GitHub Check: Summary

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. (Beta)
  • @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.

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.

@github-actions github-actions bot added C:Confix Issues and PR related to Confix C:server/v2 Issues related to server/v2 C:server/v2 cometbft labels Jan 16, 2025
@julienrbrt julienrbrt requested review from alpe and aljo242 January 16, 2025 09:57
@julienrbrt julienrbrt enabled auto-merge January 16, 2025 10:03
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: 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

📥 Commits

Reviewing files that changed from the base of the PR and between 85682ac and a596833.

📒 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 suggestion

Enhance 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

server/v2/cometbft/CHANGELOG.md Outdated Show resolved Hide resolved
@julienrbrt julienrbrt disabled auto-merge January 17, 2025 09:09
@julienrbrt
Copy link
Member Author

Added changelog from #23433

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

🧹 Nitpick comments (3)
CHANGELOG.md (3)

Line range hint 1-1: Add missing title header

The CHANGELOG file should start with a # Changelog title header for consistency with other documentation.

+ # Changelog

66-70: Improve version header formatting

The 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 format

The 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

📥 Commits

Reviewing files that changed from the base of the PR and between 584d16c and 4f10f75.

📒 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 changelog

The 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.md

Length of output: 329

@julienrbrt julienrbrt changed the title docs: sync main with 0.52 banch docs: sync main with 0.52 branch Jan 17, 2025
@julienrbrt julienrbrt added this pull request to the merge queue Jan 17, 2025
Merged via the queue into main with commit b5dada3 Jan 17, 2025
73 checks passed
@julienrbrt julienrbrt deleted the julien/sync branch January 17, 2025 10:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C:Confix Issues and PR related to Confix C:server/v2 appmanager C:server/v2 cometbft C:server/v2 Issues related to server/v2
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants