Conversation
asyncapi-bot
requested review from
Mayaleeeee,
akshatnema,
anshgoyalevil,
asyncapi-bot-eve,
derberg,
princerajpoot20 and
sambhavgupta0705
as code owners
✅ Deploy Preview for asyncapi-website ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughThree configuration files updated: Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 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 #5115 +/- ##
=========================================
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-5115--asyncapi-website.netlify.app/ |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
config/tools.json (2)
1414-1446:⚠️ Potential issue | 🟡 MinorRemove duplicate AsyncAPI Studio entries pointing to test repositories.
The first AsyncAPI Studio entry (lines 1414–1441) correctly points to
https://github.com/asyncapi/studio. However, the second entry (lines 1443–1469) withrepoUrl: "https://github.com/Shurtu-gal/action-test-bed"and the third entry (around line 1471) withrepoUrl: "https://github.com/TahaShahid203/async-api-issue"are duplicate entries pointing to personal/test repositories. These should be removed from the tools list.
2938-2990:⚠️ Potential issue | 🟡 MinorRemove or add descriptions to personal fork entries with null descriptions.
Two new HTML Template entries (WSOL12/html-template and dipaksodani/async-gen) have
"description": nulland reference personal fork repositories, unlike the officialasyncapi/html-templateentry which includes a proper description. Either add meaningful descriptions for these entries or reconsider whether they should be included.
🤖 Fix all issues with AI agents
In `@config/all-tags.json`:
- Around line 88-92: The new tag entry uses the name "csharp" and a green color
scheme which duplicates the existing "C#" tag and will split filtering; remove
the duplicate object with "name": "csharp" (the block containing "name":
"csharp", "color": "bg-[`#57f281`]", "borderColor": "border-[`#37f069`]") OR rename
it to exactly "C#" and update its "color"/"borderColor" to match the existing
"C#" entry (bg-[`#E3AFE0`] / border-[`#9B4F96`]) so both entries unify under the
same language key; target the object keyed by the name "csharp" to apply the
change.
In `@config/tools-automated.json`:
- Around line 847-865: The "AsyncAPI CLI" entry points to a personal fork
(repoUrl "https://github.com/hkirat/asyncapi-fork") and duplicates the official
AsyncAPI CLI entry; update the entry to reference the official repository or
remove this duplicate to avoid confusion: either replace the repoUrl and
websiteUrl with the official AsyncAPI CLI repo/website (matching the existing
official entry) or delete this object so only the official "AsyncAPI CLI" entry
remains; locate the JSON object with "title": "AsyncAPI CLI" and adjust the
"repoUrl"/"websiteUrl" or remove the object accordingly.
- Around line 556-587: The two GitHub Action entries "GitHub Action for CLI" and
"GitHub Action for Generator" are mismatched (titles, description, technology
and repoUrl don't align); update the entry with title "GitHub Action for CLI" so
its repoUrl is "https://github.com/asyncapi/cli", set its description to the CLI
description ("CLI to work with your AsyncAPI files...") and technology to
"AsyncAPI CLI", and update the entry titled "GitHub Action for Generator" so its
repoUrl is
"https://github.com/actions-marketplace-validations/asyncapi_github-action-for-generator",
set its description to reflect a generator GitHub Action, and ensure its
technology field is "AsyncAPI Generator"; make the same corrections in the
duplicated block in config/tools.json to keep both files consistent.
In `@config/tools.json`:
- Around line 198-230: The language tag for the Bielu.AspNetCore.AsyncApi entry
is wrong: change filters.language.name from "csharp" to "C#" and update the
color values to match other C# tools (bg-[`#E3AFE0`] and border-[`#9B4F96`]); do
this for the Bielu.AspNetCore.AsyncApi tool entry (the object with "title":
"Bielu.AspNetCore.AsyncApi") and the second identical occurrence mentioned (both
instances where filters.language.name is "csharp") so the badge and filter match
the rest of the C# entries.
🧹 Nitpick comments (1)
config/all-tags.json (1)
306-324: Pre-existing duplicateVSCodeandSmartPasteentries.There are two identical
"VSCode"entries (lines 306–313) and two identical"SmartPaste"entries (lines 316–323). These appear to be pre-existing duplicates (one perasyncapi-previewfork), but worth deduplicating if the tag list is intended to be a unique set.
| { | ||
| "name": "csharp", | ||
| "color": "bg-[#57f281]", | ||
| "borderColor": "border-[#37f069]" | ||
| }, |
There was a problem hiding this comment.
Inconsistent language name: csharp vs existing C# at line 29.
The existing C# language tag (line 29) uses the name "C#" with colors bg-[#E3AFE0] / border-[#9B4F96]. This new entry uses "csharp" with completely different colors (bg-[#57f281] / border-[#37f069]). Tools tagged with "csharp" won't group with those tagged "C#" in filters, splitting the same language into two unrelated tags. Additionally, the green color scheme here matches Scala and .NET, not C#.
This entry should either be removed (since "C#" already exists) or, if it must remain, renamed to "C#" with matching colors.
Proposed fix
Either remove lines 88–92 entirely (the "C#" tag at line 29 already covers this), or align:
{
- "name": "csharp",
- "color": "bg-[`#57f281`]",
- "borderColor": "border-[`#37f069`]"
+ "name": "C#",
+ "color": "bg-[`#E3AFE0`]",
+ "borderColor": "border-[`#9B4F96`]"
},But since "C#" already exists at line 29, removing the duplicate is cleaner.
📝 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.
| { | |
| "name": "csharp", | |
| "color": "bg-[#57f281]", | |
| "borderColor": "border-[#37f069]" | |
| }, | |
| { | |
| "name": "C#", | |
| "color": "bg-[`#E3AFE0`]", | |
| "borderColor": "border-[`#9B4F96`]" | |
| }, |
🤖 Prompt for AI Agents
In `@config/all-tags.json` around lines 88 - 92, The new tag entry uses the name
"csharp" and a green color scheme which duplicates the existing "C#" tag and
will split filtering; remove the duplicate object with "name": "csharp" (the
block containing "name": "csharp", "color": "bg-[`#57f281`]", "borderColor":
"border-[`#37f069`]") OR rename it to exactly "C#" and update its
"color"/"borderColor" to match the existing "C#" entry (bg-[`#E3AFE0`] /
border-[`#9B4F96`]) so both entries unify under the same language key; target the
object keyed by the name "csharp" to apply the change.
| "title": "GitHub Action for CLI", | ||
| "description": null, | ||
| "links": { | ||
| "repoUrl": "https://github.com/asyncapi/cli" | ||
| "repoUrl": "https://github.com/actions-marketplace-validations/asyncapi_github-action-for-generator" | ||
| }, | ||
| "filters": { | ||
| "technology": [ | ||
| "AsyncAPI Generator" | ||
| "AsyncAPI CLI" | ||
| ], | ||
| "categories": [ | ||
| "github-actions" | ||
| "github-action" | ||
| ], | ||
| "hasCommercial": false, | ||
| "isAsyncAPIOwner": true | ||
| "isAsyncAPIOwner": false | ||
| } | ||
| }, | ||
| { | ||
| "title": "GitHub Action for CLI", | ||
| "description": null, | ||
| "title": "GitHub Action for Generator", | ||
| "description": "CLI to work with your AsyncAPI files. You can validate them and in the future use a generator and even bootstrap a new file. Contributions are welcomed!", | ||
| "links": { | ||
| "repoUrl": "https://github.com/actions-marketplace-validations/asyncapi_github-action-for-generator" | ||
| "repoUrl": "https://github.com/asyncapi/cli" | ||
| }, | ||
| "filters": { | ||
| "technology": [ | ||
| "AsyncAPI CLI" | ||
| "AsyncAPI Generator" | ||
| ], | ||
| "categories": [ | ||
| "github-action" | ||
| "github-actions" | ||
| ], | ||
| "hasCommercial": false, | ||
| "isAsyncAPIOwner": false | ||
| "isAsyncAPIOwner": true | ||
| } |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Check the exact content around lines 556-587 in tools-automated.json
echo "=== config/tools-automated.json lines 556-590 ==="
sed -n '556,590p' config/tools-automated.json | cat -n
echo ""
echo "=== config/tools.json lines 1860-1910 (GitHub Actions entries) ==="
sed -n '1860,1910p' config/tools.json | cat -nRepository: asyncapi/website
Length of output: 3713
🏁 Script executed:
#!/bin/bash
# Check git history to see what changed
echo "=== Recent commits affecting these lines ==="
git log --oneline -20 -- config/tools-automated.json config/tools.json 2>/dev/null | head -10
echo ""
echo "=== Git diff for these specific lines ==="
git diff HEAD~1 config/tools-automated.json 2>/dev/null | grep -A 20 -B 5 "GitHub Action" | head -50Repository: asyncapi/website
Length of output: 180
🏁 Script executed:
#!/bin/bash
# Search for information about these tools in the codebase
echo "=== Searching for references to asyncapi/cli ==="
rg "asyncapi/cli" --type json -A 2 -B 2
echo ""
echo "=== Searching for references to github-action-for-generator ==="
rg "github-action-for-generator" --type json -A 2 -B 2 | head -30Repository: asyncapi/website
Length of output: 6451
GitHub Actions entries have mismatched titles, descriptions, and repository URLs.
The data is internally inconsistent:
- "GitHub Action for CLI" (line 556) points to
asyncapi_github-action-for-generatorwith"description": null— the repository name explicitly references "generator", not CLI, yet the technology tag and title claim it's for CLI. - "GitHub Action for Generator" (line 573) points to
asyncapi/cliwith the description "CLI to work with your AsyncAPI files..." — this clearly describes the CLI tool, not a generator action, yet the technology tag and title claim it's for the generator.
The same inconsistency is present in config/tools.json (lines 1860–1899). Developers browsing the tools directory will encounter confusing information about which action performs which function.
🤖 Prompt for AI Agents
In `@config/tools-automated.json` around lines 556 - 587, The two GitHub Action
entries "GitHub Action for CLI" and "GitHub Action for Generator" are mismatched
(titles, description, technology and repoUrl don't align); update the entry with
title "GitHub Action for CLI" so its repoUrl is
"https://github.com/asyncapi/cli", set its description to the CLI description
("CLI to work with your AsyncAPI files...") and technology to "AsyncAPI CLI",
and update the entry titled "GitHub Action for Generator" so its repoUrl is
"https://github.com/actions-marketplace-validations/asyncapi_github-action-for-generator",
set its description to reflect a generator GitHub Action, and ensure its
technology field is "AsyncAPI Generator"; make the same corrections in the
duplicated block in config/tools.json to keep both files consistent.
| { | ||
| "title": "AsyncAPI CLI", | ||
| "description": "One CLI to rule them all. \nThis is a CLI that aims to integrate all AsyncAPI tools that you need while AsyncAPI document development and maintainance. \nYou can use it to generate docs or code, validate AsyncAPI document and event create new documents.\n", | ||
| "links": { | ||
| "websiteUrl": "https://www.asyncapi.com/tools/cli", | ||
| "repoUrl": "https://github.com/hkirat/asyncapi-fork" | ||
| }, | ||
| "filters": { | ||
| "technology": [ | ||
| "TypeScript" | ||
| ], | ||
| "categories": [ | ||
| "others", | ||
| "cli" | ||
| ], | ||
| "hasCommercial": false, | ||
| "isAsyncAPIOwner": false | ||
| } | ||
| }, |
There was a problem hiding this comment.
AsyncAPI CLI entry pointing to a personal fork hkirat/asyncapi-fork.
This entry duplicates the official AsyncAPI CLI (line 807) but points to a personal fork. The isAsyncAPIOwner is correctly false, but listing a personal fork as a standalone tool entry may confuse users. This also appears in tools.json (lines 2529–2551) and seems pre-existing.
🤖 Prompt for AI Agents
In `@config/tools-automated.json` around lines 847 - 865, The "AsyncAPI CLI" entry
points to a personal fork (repoUrl "https://github.com/hkirat/asyncapi-fork")
and duplicates the official AsyncAPI CLI entry; update the entry to reference
the official repository or remove this duplicate to avoid confusion: either
replace the repoUrl and websiteUrl with the official AsyncAPI CLI repo/website
(matching the existing official entry) or delete this object so only the
official "AsyncAPI CLI" entry remains; locate the JSON object with "title":
"AsyncAPI CLI" and adjust the "repoUrl"/"websiteUrl" or remove the object
accordingly.
| { | ||
| "title": "Bielu.AspNetCore.AsyncApi", | ||
| "description": "A library that provides built-in support for generating AsyncAPI documents from minimal or controller-based APIs in ASP.NET Core, bringing the same developer experience as Microsoft.AspNetCore.OpenApi but for AsyncAPI specifications.", | ||
| "links": { | ||
| "repoUrl": "https://github.com/bielu/Bielu.AspNetCore.AsyncApi" | ||
| }, | ||
| "filters": { | ||
| "language": [ | ||
| { | ||
| "name": "csharp", | ||
| "color": "bg-[#57f281]", | ||
| "borderColor": "border-[#37f069]" | ||
| } | ||
| ], | ||
| "technology": [ | ||
| { | ||
| "name": "ASP.NET Core", | ||
| "color": "bg-[#61d0f2]", | ||
| "borderColor": "border-[#40ccf7]" | ||
| }, | ||
| { | ||
| "name": ".NET", | ||
| "color": "bg-[#A184FF]", | ||
| "borderColor": "border-[#5026D4]" | ||
| } | ||
| ], | ||
| "categories": [ | ||
| "code-first", | ||
| "documentation-generator" | ||
| ], | ||
| "hasCommercial": false | ||
| } | ||
| }, |
There was a problem hiding this comment.
Language name "csharp" is inconsistent with the rest of the file.
Every other C# tool in this file (AsyncAPI.Net, AsyncAPI.NET, AsyncApi.Net.Generator, KnstEventBus, Neuroglia AsyncAPI, Saunter) uses "name": "C#" with colors bg-[#E3AFE0] / border-[#9B4F96]. This new entry uses "name": "csharp" with a green color scheme, so it won't match the same filter tag and will render with an inconsistent badge color.
This is the same issue noted in config/all-tags.json — the root cause is in the upstream .asyncapi-tool file for this repository, but it should be corrected here before merging.
Proposed fix (apply to both occurrences at lines 206-211 and 1207-1212)
"language": [
{
- "name": "csharp",
- "color": "bg-[`#57f281`]",
- "borderColor": "border-[`#37f069`]"
+ "name": "C#",
+ "color": "bg-[`#E3AFE0`]",
+ "borderColor": "border-[`#9B4F96`]"
}
],🤖 Prompt for AI Agents
In `@config/tools.json` around lines 198 - 230, The language tag for the
Bielu.AspNetCore.AsyncApi entry is wrong: change filters.language.name from
"csharp" to "C#" and update the color values to match other C# tools
(bg-[`#E3AFE0`] and border-[`#9B4F96`]); do this for the Bielu.AspNetCore.AsyncApi
tool entry (the object with "title": "Bielu.AspNetCore.AsyncApi") and the second
identical occurrence mentioned (both instances where filters.language.name is
"csharp") so the badge and filter match the rest of the C# entries.
2 participants
Automated changes by create-pull-request GitHub action
Summary by CodeRabbit
New Features
Updates