docs: add v3.1 release notes#5034
Conversation
✅ Deploy Preview for asyncapi-website ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Warning Rate limit exceeded
⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📝 WalkthroughWalkthroughAdds a new release notes blog post and updates numerous documentation Markdown files to reference AsyncAPI spec version 3.1.0 (replacing 3.0.0) in examples and spec links; no public or exported API declarations changed. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
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. Comment |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #5034 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 22 22
Lines 796 796
Branches 146 146
=========================================
Hits 796 796 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-5034--asyncapi-website.netlify.app/ |
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Fix all issues with AI agents
In `@markdown/blog/release-notes-3.1.0.md`:
- Line 13: Update the excerpt text that currently reads 'AsyncAPI 3.1 is now
released with new RSO 2 binding.' to use the correct protocol name "ROS 2" by
changing 'RSO 2' to 'ROS 2' in the excerpt field (the line starting with
excerpt:). Ensure the corrected string reads 'AsyncAPI 3.1 is now released with
new ROS 2 binding.' so it matches the rest of the document.
- Line 32: Fix the typo in the release note sentence that currently reads "RSO 2
binding": locate the line containing "JSON Schema that supports validation of
AsyncAPI documents with RSO 2 binding is updated..." and change "RSO 2" to "ROS
2" so it reads "ROS 2 binding", leaving the rest of the sentence (and the
`@asyncapi/specs` version mention) unchanged.
- Around line 32-33: The release notes incorrectly reference AsyncAPI 3.1.0,
`@asyncapi/specs` v6.11.0, and an official ROS 2 binding; update the text to
reference the released AsyncAPI version 3.0.0 everywhere (replace "3.1.0" with
"3.0.0"), remove the claim that a ROS 2 binding is official (delete or mark as
"draft/community" if you must mention it), and correct the package statement
about `@asyncapi/specs` to reflect the actual published schemas (mention it
supports 3.0.0 only); also change the parser statement to say that parser-js
(parser-js) supports and validates 3.0.0 documents rather than 3.1.0.
🧹 Nitpick comments (1)
markdown/blog/release-notes-3.1.0.md (1)
45-45: Add newline at end of file.The file is missing a trailing newline, which is a common best practice for text files and helps with version control and text processing tools.
|
@thulieblack @Barbanio @TRohit20 Need your attention. Please take a look on this |
|
LGTM |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@markdown/docs/tutorials/kafka/managing-schemas-using-schema-registry.md`:
- Line 108: There are two occurrences of the AsyncAPI declaration set to
"asyncapi: 3.1.0"; update both instances (the top-level YAML key string
"asyncapi: 3.1.0" found in the two example documents) to "asyncapi: 3.0.0" so
the examples use the official AsyncAPI 3.0.0 spec and retain the existing
structures like channels, operations, and components.messages/$ref references.
|
don't worry there are so many files changed - focus on blog, rest is just 3.0.0 -> 3.1.0 update in docs |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@markdown/blog/release-notes-3.1.0.md`:
- Line 36: Replace the bare URL "https://studio.asyncapi.com/" with a proper
Markdown link; update the sentence that mentions "AsyncAPI Studio" so the URL is
wrapped (for example, link the text “AsyncAPI Studio” or the domain to
https://studio.asyncapi.com/) to satisfy MD034 and keep formatting consistent
with the existing line that references AsyncAPI Studio.
🧹 Nitpick comments (1)
markdown/blog/release-notes-3.1.0.md (1)
40-45: Reduce repetition in consecutive “Huge thanks” sentences.Three successive sentences start with “Huge thanks,” which reads repetitive; consider varying phrasing.
| - JSON Schema that supports validation of AsyncAPI documents with ROS 2 binding is updated in [this](https://github.com/asyncapi/spec-json-schemas/releases/tag/v6.11.1) repository. Also **@asyncapi/specs** package has been updated on NPM to version 6.11.1. | ||
| - [JavaScript Parser](https://github.com/asyncapi/parser-js/releases/tag/%40asyncapi%2Fparser%403.6.0) uses latest **@asyncapi/specs** package and can be used to parse and validate 3.1.0 documents. Upgrade to latest version. | ||
| - [JavaScript Converter](https://github.com/asyncapi/converter-js/releases/tag/v1.7.0) uses latest **@asyncapi/parser** package and can be used to convert to 3.1.0 documents. Upgrade to latest version. This conversion is just the version change in `asyncapi` field. | ||
| - [AsyncAPI Studio](https://github.com/asyncapi/studio) is also updated so just go to https://studio.asyncapi.com/ and see you can already write 3.1.0 documents. |
There was a problem hiding this comment.
Avoid bare URL in Markdown.
Line 36 uses a bare URL; wrap it in a proper Markdown link to satisfy MD034 and keep formatting consistent.
✅ Suggested fix
-- [AsyncAPI Studio](https://github.com/asyncapi/studio) is also updated so just go to https://studio.asyncapi.com/ and see you can already write 3.1.0 documents.
+- [AsyncAPI Studio](https://github.com/asyncapi/studio) is also updated so just go to [studio.asyncapi.com](https://studio.asyncapi.com/) and see you can already write 3.1.0 documents.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - [AsyncAPI Studio](https://github.com/asyncapi/studio) is also updated so just go to https://studio.asyncapi.com/ and see you can already write 3.1.0 documents. | |
| - [AsyncAPI Studio](https://github.com/asyncapi/studio) is also updated so just go to [studio.asyncapi.com](https://studio.asyncapi.com/) and see you can already write 3.1.0 documents. |
🧰 Tools
🪛 markdownlint-cli2 (0.20.0)
[warning] 36-36: Bare URL used
(MD034, no-bare-urls)
🤖 Prompt for AI Agents
In `@markdown/blog/release-notes-3.1.0.md` at line 36, Replace the bare URL
"https://studio.asyncapi.com/" with a proper Markdown link; update the sentence
that mentions "AsyncAPI Studio" so the URL is wrapped (for example, link the
text “AsyncAPI Studio” or the domain to https://studio.asyncapi.com/) to satisfy
MD034 and keep formatting consistent with the existing line that references
AsyncAPI Studio.
Updated release notes for AsyncAPI 3.1.0 to correct phrasing and improve clarity.
thulieblack
left a comment
There was a problem hiding this comment.
I also give you a round of applause 😉
|
/rtm |
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.