node icon indicating copy to clipboard operation
node copied to clipboard

chore: versions docs file

Open fadeev opened this issue 7 months ago • 4 comments

Summary by CodeRabbit

  • New Features
    • Introduced a centralized version tracking file displaying version, commit, and timestamp information for multiple components.

fadeev avatar Apr 30 '25 09:04 fadeev

[!IMPORTANT]

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

📝 Walkthrough

Walkthrough

A new file named versions.json has been introduced to the codebase. This file serves as a centralized manifest, detailing version information for several project components, including node, protocol-contracts, and additional protocol contract variants for Solana, Sui, and TON. For each component, the manifest records the version, commit hash, and timestamp. Currently, only node and protocol-contracts are populated with version data, while the Solana, Sui, and TON entries are placeholders with empty fields.

Changes

File(s) Change Summary
versions.json Added a new manifest file listing version, commit, and timestamp metadata for multiple components.

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant versions.json

    Developer->>versions.json: Add or update version, commit, and timestamp information
    Note right of versions.json: Serves as a manifest for component version tracking

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:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.

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.

coderabbitai[bot] avatar Apr 30 '25 09:04 coderabbitai[bot]

Replaced JSON with markdown. Since it's a regular table I think it's easier for us to just write down git tags (versions) without commits, timestamps, etc. Knowing a tag is enough to get all other info programmatically.

fadeev avatar May 09 '25 10:05 fadeev

We still don't have Sui version, though. We need to make a release.

fadeev avatar May 09 '25 10:05 fadeev

We still don't have Sui version, though. We need to make a release.

Created v1.0.0 https://github.com/zeta-chain/protocol-contracts-sui/releases/tag/v1.0.0

lumtis avatar May 13 '25 09:05 lumtis

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 64.18%. Comparing base (99a50da) to head (fabffb0). Report is 3 commits behind head on develop.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff            @@
##           develop    #3836   +/-   ##
========================================
  Coverage    64.18%   64.18%           
========================================
  Files          474      474           
  Lines        34804    34804           
========================================
  Hits         22338    22338           
  Misses       11437    11437           
  Partials      1029     1029           
:rocket: New features to boost your workflow:
  • :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

codecov[bot] avatar Jun 04 '25 08:06 codecov[bot]