Skip to content

Conversation

@asyncapi-bot
Copy link
Contributor

@asyncapi-bot asyncapi-bot commented Feb 14, 2025

Updated cli documentation is available and this PR introduces update to cli folder on the website

Summary by CodeRabbit

  • Documentation
    • Updated the CLI usage documentation to reflect the new release version (2.16.1).
    • Introduced an alternative command option (--v) for displaying version information alongside the existing (--version) option.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 14, 2025

Walkthrough

This pull request updates the AsyncAPI CLI usage documentation by incrementing the version number from 2.14.1 to 2.16.1. Additionally, it modifies the command-line options for displaying the version, supplementing the original --version with an alternative flag --v. The overall structure of the document remains unchanged, ensuring consistency with the current CLI release details.

Changes

File(s) Change Summary
markdown/.../usage.md Updated the CLI version from 2.14.1 to 2.16.1 and added the alternative option --v alongside --version

Possibly related PRs

Suggested labels

autoapproved, autoupdate

Suggested reviewers

  • quetzalliwrites
  • VaishnaviNandakumar
  • J0SAL
  • BhaswatiRoy
  • TRohit20
  • asyncapi-bot-eve

Poem

I'm a little bunny, coding with delight,
Hopping through version updates in the soft moonlight.
Carrots crunching, I nibble every change you see—
From version bumps to flags, as clear as can be!
With whiskers twitching, I celebrate our doc upgrade,
A joyful rabbit cheer for our new AsyncAPI parade!


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 4afb26d and d2d9b9c.

📒 Files selected for processing (1)
  • markdown/docs/tools/cli/usage.md (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • markdown/docs/tools/cli/usage.md
⏰ Context from checks skipped due to timeout of 180000ms (5)
  • GitHub Check: Redirect rules - asyncapi-website
  • GitHub Check: Header rules - asyncapi-website
  • GitHub Check: Pages changed - asyncapi-website
  • GitHub Check: Automerge PR autoapproved by a bot
  • GitHub Check: Lighthouse CI

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.

@netlify
Copy link

netlify bot commented Feb 14, 2025

Deploy Preview for asyncapi-website ready!

Name Link
🔨 Latest commit d2d9b9c
🔍 Latest deploy log https://app.netlify.com/sites/asyncapi-website/deploys/67aefaa035ef050008e9923b
😎 Deploy Preview https://deploy-preview-3679--asyncapi-website.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@codecov
Copy link

codecov bot commented Feb 14, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (4afb26d) to head (d2d9b9c).
Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff            @@
##            master     #3679   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           20        20           
  Lines          732       732           
=========================================
  Hits           732       732           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@asyncapi-bot asyncapi-bot merged commit 57c5837 into master Feb 14, 2025
29 of 30 checks passed
@asyncapi-bot asyncapi-bot deleted the update-cli-docs-5becbe3c19b40755b137012142a8689b9048e4e8 branch February 14, 2025 08:14
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.

3 participants