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: changelog for v23 #3190

Merged
merged 2 commits into from
Nov 22, 2024
Merged

docs: changelog for v23 #3190

merged 2 commits into from
Nov 22, 2024

Conversation

lumtis
Copy link
Member

@lumtis lumtis commented Nov 20, 2024

Description

Update changelog for v23
Reorganize from previous fixes we make

Summary by CodeRabbit

  • New Features

    • Whitelist SPL tokens on Solana.
    • Integration of SPL deposits and withdrawals.
    • Enabled zetaclient pprof server on port 6061.
  • Improvements

    • Enhanced build reproducibility.
    • Added new end-to-end tests for version 2 deposits and emissions.
  • Bug Fixes

    • Resolved issues with emissions module registration and outbound transaction handling.
    • Fixed potential panic situations in Bitcoin inscription parsing.
  • Documentation

    • Updated changelog to reflect new and previous version details.

Copy link
Contributor

coderabbitai bot commented Nov 20, 2024

📝 Walkthrough

Walkthrough

The pull request updates the changelog.md file to document the release of version v23.0.0, which introduces new features, improvements, and bug fixes. Key enhancements include whitelisting SPL tokens on Solana, improved build reproducibility, and the integration of SPL deposits and withdrawals. The testing framework has been enhanced with new tests and configurations. Additionally, several refactoring efforts have been made, including the removal of certain components and updates to the application context. Previous versions are also documented in the changelog.

Changes

File Change Summary
changelog.md Updated to include version v23.0.0 and previous versions v22.1.2, v22.1.1, v22.1.0, v22.0.2, v22.0.1, v22.0.0, v21.0.0. Added details on new features, improvements, refactoring, and fixes.

Possibly related PRs

  • chore: fix changelog for v21 #3052: The changelog update for version v21.0.0 is directly related as it involves similar changes to the changelog file, reflecting updates and new features in the ZetaChain protocol.

Suggested labels

no-changelog

Suggested reviewers

  • fbac
  • skosito
  • kingpinXD
  • ws4charlie
  • brewmaster012
  • swift1337
  • gartnera

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

@lumtis lumtis marked this pull request as ready for review November 22, 2024 11:27
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 (2)
changelog.md (2)

Line range hint 3-40: Ensure consistent formatting in version 23.0.0 section.

The changelog entries are well-organized by category, but there are some inconsistencies in the formatting:

  • Some entries use bullet points with asterisks (*) while others use dashes (-)
  • Some PR links are wrapped in square brackets while others aren't

Apply consistent formatting throughout:

### Features

- [2984](https://github.com/zeta-chain/node/pull/2984) - add Whitelist message ability to whitelist SPL tokens on Solana
- [3091](https://github.com/zeta-chain/node/pull/3091) - improve build reproducability. `make release{,-build-only}` checksums should now be stable.
- [3124](https://github.com/zeta-chain/node/pull/3124) - integrate SPL deposits

41-81: Consolidate duplicate section headings.

There are multiple instances of duplicate section headings (e.g., "Fixes") across different versions. While this is common in changelogs, consider using subsection markers or version-specific prefixes for better navigation.

Consider restructuring sections to avoid duplicate headings:

## v22.1.2

### v22.1.2 Fixes
- [3181] - add lock around pingRTT to prevent crash

## v22.1.1

### v22.1.1 Fixes
- [3171] - infinite discovery address leak
🧰 Tools
🪛 Markdownlint (0.35.0)

45-45: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)


51-51: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)


57-57: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)


61-61: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)


62-62: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)


68-68: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)


74-74: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)


49-49: null
Multiple headings with the same content

(MD024, no-duplicate-heading)


59-59: null
Multiple headings with the same content

(MD024, no-duplicate-heading)


66-66: null
Multiple headings with the same content

(MD024, no-duplicate-heading)


72-72: null
Multiple headings with the same content

(MD024, no-duplicate-heading)

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 8998ccf and 0ff30b3.

📒 Files selected for processing (1)
  • changelog.md (2 hunks)
🧰 Additional context used
🪛 Markdownlint (0.35.0)
changelog.md

45-45: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)


51-51: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)


57-57: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)


61-61: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)


62-62: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)


68-68: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)


74-74: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)


49-49: null
Multiple headings with the same content

(MD024, no-duplicate-heading)


59-59: null
Multiple headings with the same content

(MD024, no-duplicate-heading)


66-66: null
Multiple headings with the same content

(MD024, no-duplicate-heading)


72-72: null
Multiple headings with the same content

(MD024, no-duplicate-heading)

🔇 Additional comments (1)
changelog.md (1)

Line range hint 1-81: LGTM! The changelog is well-structured and informative.

The changelog effectively documents the changes across versions with:

  • Clear version numbering
  • Categorized changes (Features, Tests, Refactor, Fixes)
  • PR references with links
  • Concise descriptions of changes
🧰 Tools
🪛 Markdownlint (0.35.0)

45-45: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)


51-51: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)


57-57: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)


61-61: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)


62-62: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)


68-68: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)


74-74: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)


49-49: null
Multiple headings with the same content

(MD024, no-duplicate-heading)


59-59: null
Multiple headings with the same content

(MD024, no-duplicate-heading)


66-66: null
Multiple headings with the same content

(MD024, no-duplicate-heading)


72-72: null
Multiple headings with the same content

(MD024, no-duplicate-heading)

@lumtis lumtis added this pull request to the merge queue Nov 22, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Nov 22, 2024
@lumtis lumtis added this pull request to the merge queue Nov 22, 2024
Merged via the queue into develop with commit 162753f Nov 22, 2024
43 checks passed
@lumtis lumtis deleted the chore/prepare-v23 branch November 22, 2024 12:43
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.

4 participants