-
-
Notifications
You must be signed in to change notification settings - Fork 980
chore: update tools.json #4417
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
chore: update tools.json #4417
Conversation
WalkthroughUpdates three config files: swaps two tag names in config/all-tags.json; extensively reorganizes and updates tool metadata, sections, and links in config/tools-automated.json; and adjusts descriptions and repoUrl values across entries in config/tools.json. Changes
Sequence Diagram(s)Estimated code review effort🎯 4 (Complex) | ⏱️ ~60 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests
Tip 👮 Agentic pre-merge checks are now available in preview!Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.
Please see the documentation for more information. Example: reviews:
pre_merge_checks:
custom_checks:
- name: "Undocumented Breaking Changes"
mode: "warning"
instructions: |
Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).Please share your feedback with us on this Discord post. 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 |
✅ Deploy Preview for asyncapi-website ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #4417 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 22 22
Lines 778 778
Branches 144 144
=========================================
Hits 778 778 ☔ 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-4417--asyncapi-website.netlify.app/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 7
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (5)
config/tools.json (2)
2450-2451: Wrong repository for AsyncAPI-formatThis should link to thim81/asyncapi-format, not converter-go.
- "repoUrl": "https://github.com/asyncapi/converter-go" + "repoUrl": "https://github.com/thim81/asyncapi-format"
1775-1793: Category typo: "github-actions" vs "github-action"Category value should be consistent with the rest of the catalog to keep filters working.
- "github-actions" + "github-action"config/tools-automated.json (3)
520-525: Category typo: "github-actions" vs "github-action"Unify category values for GitHub Actions.
- "categories": [ - "github-actions" - ], + "categories": [ + "github-action" + ],
764-799: Remove forked AsyncAPI CLI entry; keep official entry canonicalconfig/tools-automated.json contains two "AsyncAPI CLI" entries — github.com/hkirat/asyncapi-fork (isAsyncAPIOwner: false) and github.com/asyncapi/cli (isAsyncAPIOwner: true). Remove the forked entry or move it to an internal/testing list to avoid user confusion.
File: config/tools-automated.json (duplicate entries around lines ~740–820).
1-1097: Unify taxonomy, normalize casing, and replace non‑canonical repo links
- Canonicalize category tags — mixed values found (e.g., "github-action" vs "github-actions" across config/tools.json, config/tools-manual.json, config/tools-automated.json).
- Normalize language/technology casing — lower-case values found (e.g., "golang", "python", "kotlin", "javascript" in config/tools-automated.json); standardize to canonical names (Go, Python, Kotlin, JavaScript, TypeScript, etc.).
- Replace or mark non‑official repoUrl entries (examples: hkirat/asyncapi-fork, WaleedAshraf/asyncapi-github-action, bump-sh/github-action, actions-marketplace-validations/asyncapi_github-action-for-generator, Shurtu-gal/action-test-bed, TahaShahid203/async-api-issue) — point to official repos or explicitly flag as forks/test repos.
- Add an automated audit/CI check to enforce canonical tag list (all-tags.json) and a repo whitelist to prevent regressions.
🧹 Nitpick comments (10)
config/tools-automated.json (9)
116-136: AsyncAPI.Net vs AsyncAPI.NET: naming consistencyTitles differ only by casing/punctuation across entries; align with canonical names to avoid duplicates in the UI.
186-199: New: Golang codegen entry — language value casingUse a consistent language tag; elsewhere this file uses "Go" (and sometimes "Go/Golang"). Recommend "Go".
- "language": "golang", + "language": "Go",
396-400: Casing: "React js" should be "React JS"Keep technology tags consistent with all-tags.json.
- "React js", + "React JS",
555-575: Mokapi: language/technology casing consistency"Go/Golang" vs "Go", and tech tags casing varies. Normalize for reliable filtering.
- "language": "Go/Golang", + "language": "Go", - "JavaScript", - "TypeScript", + "JavaScript", + "TypeScript",
918-937: Java Spring Template: language tag should be "JavaScript" (capitalized)Align casing with other entries and tags.
- "language": [ - "javascript" - ], + "language": [ + "JavaScript" + ],
960-978: Java Spring Cloud Stream Template: language tag casingSame issue.
- "language": [ - "javascript" - ], + "language": [ + "JavaScript" + ],
999-1014: Node.js Multiprotocol Template: language casingCapitalize "JavaScript".
- "language": "javascript", + "language": "JavaScript",
1017-1032: Node.js Websockets Template: set language to "JavaScript"Consistency fix.
- "language": "javascript", + "language": "JavaScript",
676-693: Compare tools: jasyncapicmp — solid addition; check docsUrl duplication across entriesMake sure only one compare-tool entry per project to avoid duplication.
config/tools.json (1)
3143-3145: Good: Official CLI repo — deduplicate entriesconfig/tools.json contains multiple entries pointing to the AsyncAPI CLI (website: https://www.asyncapi.com/tools/cli, repo: https://github.com/asyncapi/cli); consolidate/remove duplicates into a single canonical entry. Locations: config/tools.json — root.GitHub Actions.toolsList[4].links; root.CLIs.toolsList[1].links; root.Others.toolsList[1].links. (Also present: fork entries at root.CLIs.toolsList[0].links and root.Others.toolsList[0].links.)
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
config/all-tags.json(1 hunks)config/tools-automated.json(25 hunks)config/tools.json(11 hunks)
⏰ Context from checks skipped due to timeout of 180000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (7)
- 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: Test NodeJS PR - windows-latest
- GitHub Check: Test NodeJS PR - macos-13
- GitHub Check: Lighthouse CI
🔇 Additional comments (8)
config/tools.json (4)
1310-1314: Good: restored canonical AsyncAPI Studio repo and useful description
2664-2665: Good: asyncapi-preview now links to official repo
2833-2837: Good: HTML Template entry correctly points to official repo
2424-2429: Deduplicate AsyncAPI CLI entry
Two identical "AsyncAPI CLI" entries point to the official repo — remove the duplicate to avoid confusion. Check for other occurrences (config/tools.json ~lines 2424–2429) and keep a single canonical entry.config/tools-automated.json (3)
1051-1051: Good: HTML Template now official and owner=trueLGTM after earlier fix suggestions are applied consistently.
856-872: Good: asyncapi-preview now points to official repo and isAsyncAPIOwner=true
874-892: Good: jAsyncAPI IDEA plugin upgraded to owner entry with proper linksLGTM.
config/all-tags.json (1)
281-289: Duplicate tag introduced: SmartPaste now appears twice; JetBrains de-duplicatedSwapping these two names created a duplicate SmartPaste entry and removed a unique JetBrains tag in this vicinity, likely breaking filters/badges.
- "name": "SmartPaste", + "name": "JetBrains", ... - "name": "JetBrains", + "name": "SmartPaste",Likely an incorrect or invalid review comment.
| "title": "HTML Template", | ||
| "description": null, | ||
| "links": { | ||
| "repoUrl": "https://github.com/asyncapi/nodejs-template" | ||
| "repoUrl": "https://github.com/dipaksodani/async-gen" | ||
| }, | ||
| "filters": { | ||
| "language": "javascript", | ||
| "technology": [ | ||
| "Node.js" | ||
| "HTML" | ||
| ], | ||
| "categories": [ | ||
| "generator-template" | ||
| ], | ||
| "hasCommercial": false, | ||
| "isAsyncAPIOwner": true | ||
| "isAsyncAPIOwner": false | ||
| } |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
HTML Template: non‑canonical repo and missing description
Point to official html-template and restore short description.
- "title": "HTML Template",
- "description": null,
+ "title": "HTML Template",
+ "description": "HTML template for AsyncAPI Generator. Generates static docs using the AsyncAPI React component.",
"links": {
- "repoUrl": "https://github.com/dipaksodani/async-gen"
+ "repoUrl": "https://github.com/asyncapi/html-template"
},📝 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.
| "title": "HTML Template", | |
| "description": null, | |
| "links": { | |
| "repoUrl": "https://github.com/asyncapi/nodejs-template" | |
| "repoUrl": "https://github.com/dipaksodani/async-gen" | |
| }, | |
| "filters": { | |
| "language": "javascript", | |
| "technology": [ | |
| "Node.js" | |
| "HTML" | |
| ], | |
| "categories": [ | |
| "generator-template" | |
| ], | |
| "hasCommercial": false, | |
| "isAsyncAPIOwner": true | |
| "isAsyncAPIOwner": false | |
| } | |
| "title": "HTML Template", | |
| "description": "HTML template for AsyncAPI Generator. Generates static docs using the AsyncAPI React component.", | |
| "links": { | |
| "repoUrl": "https://github.com/asyncapi/html-template" | |
| }, | |
| "filters": { | |
| "language": "javascript", | |
| "technology": [ | |
| "HTML" | |
| ], | |
| "categories": [ | |
| "generator-template" | |
| ], | |
| "hasCommercial": false, | |
| "isAsyncAPIOwner": false | |
| } |
🤖 Prompt for AI Agents
In config/tools-automated.json around lines 981–996, the "HTML Template" entry
points to a non‑canonical repo and has a null description; update
"links.repoUrl" to the official HTML template repo
(https://github.com/asyncapi/html-template) and replace "description": null with
a short, meaningful description such as "Official AsyncAPI HTML template for
rendering API documentation" so the entry points to the canonical source and has
a clear description.
| "repoUrl": "https://github.com/Shurtu-gal/action-test-bed" | ||
| }, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Non‑canonical repo linked for AsyncAPI Studio
This entry points to a user test repo. Link to the official repo to avoid misleading users.
- "repoUrl": "https://github.com/Shurtu-gal/action-test-bed"
+ "repoUrl": "https://github.com/asyncapi/studio"📝 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.
| "repoUrl": "https://github.com/Shurtu-gal/action-test-bed" | |
| }, | |
| "repoUrl": "https://github.com/asyncapi/studio" | |
| }, |
🤖 Prompt for AI Agents
In config/tools.json around lines 1340 to 1341, the AsyncAPI Studio entry points
to a non-canonical user test repository
("https://github.com/Shurtu-gal/action-test-bed"); replace that URL with the
official AsyncAPI Studio repository URL to avoid misleading users (update the
"repoUrl" value to the project's authoritative GitHub repo).
| "description": null, | ||
| "links": { | ||
| "websiteUrl": "https://studio.asyncapi.com", | ||
| "repoUrl": "https://github.com/asyncapi/studio" | ||
| "repoUrl": "https://github.com/TahaShahid203/async-api-issue" | ||
| }, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Non‑canonical repo linked for AsyncAPI Studio (duplicate entry)
Same issue; use official repo or remove duplicate.
- "repoUrl": "https://github.com/TahaShahid203/async-api-issue"
+ "repoUrl": "https://github.com/asyncapi/studio"📝 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.
| "description": null, | |
| "links": { | |
| "websiteUrl": "https://studio.asyncapi.com", | |
| "repoUrl": "https://github.com/asyncapi/studio" | |
| "repoUrl": "https://github.com/TahaShahid203/async-api-issue" | |
| }, | |
| "description": null, | |
| "links": { | |
| "websiteUrl": "https://studio.asyncapi.com", | |
| "repoUrl": "https://github.com/asyncapi/studio" | |
| }, |
🤖 Prompt for AI Agents
In config/tools.json around lines 1364 to 1368, the AsyncAPI Studio entry
references a non‑canonical GitHub repo
(https://github.com/TahaShahid203/async-api-issue) and appears to be a
duplicate; replace the repoUrl with the official AsyncAPI Studio repository URL
or remove this duplicate entry entirely. Ensure the entry's links.repoUrl points
to the official source (e.g., the AsyncAPI Studio org/repo) and verify there are
no other duplicate tool entries for AsyncAPI Studio in the file to avoid
redundancy.
| "repoUrl": "https://github.com/hkirat/asyncapi-fork" | ||
| }, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
AsyncAPI CLI linking to a fork
Use the official CLI repo to avoid trust and maintenance issues.
- "repoUrl": "https://github.com/hkirat/asyncapi-fork"
+ "repoUrl": "https://github.com/asyncapi/cli"📝 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.
| "repoUrl": "https://github.com/hkirat/asyncapi-fork" | |
| }, | |
| "repoUrl": "https://github.com/asyncapi/cli" | |
| }, |
🤖 Prompt for AI Agents
In config/tools.json around lines 2405 to 2406, the tool entry is pointing to a
personal fork (https://github.com/hkirat/asyncapi-fork); replace the repoUrl
with the official AsyncAPI CLI repository (https://github.com/asyncapi/cli),
update any ref/version to the intended release or tag if needed, and run a quick
dependency/tool validation (or CI) to ensure the change does not break installs
or references.
| "repoUrl": "https://github.com/Savio629/testing2" | ||
| }, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Non‑canonical asyncapi-preview repo
Points to a test repo; link to official extension or drop duplicate.
- "repoUrl": "https://github.com/Savio629/testing2"
+ "repoUrl": "https://github.com/asyncapi/vs-asyncapi-preview"📝 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.
| "repoUrl": "https://github.com/Savio629/testing2" | |
| }, | |
| "repoUrl": "https://github.com/asyncapi/vs-asyncapi-preview" | |
| }, |
🤖 Prompt for AI Agents
In config/tools.json around lines 2690-2691 the "repoUrl" points to a test
repository (https://github.com/Savio629/testing2) which is non-canonical;
replace this URL with the official asyncapi-preview extension repository URL (or
remove the duplicate tool entry if this entry is redundant) so the tool
configuration references the authoritative source; ensure the updated URL is
valid and matches the tool's name and other metadata in this JSON section.
| "description": null, | ||
| "links": { | ||
| "repoUrl": "https://github.com/asyncapi/html-template" | ||
| "repoUrl": "https://github.com/dipaksodani/async-gen" | ||
| }, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
HTML Template points to unrelated repo
This should reference the official AsyncAPI HTML template.
- "description": null,
- "links": {
- "repoUrl": "https://github.com/dipaksodani/async-gen"
+ "description": "HTML template for AsyncAPI Generator. Use it to generate static docs. It uses the AsyncAPI React component under the hood.",
+ "links": {
+ "repoUrl": "https://github.com/asyncapi/html-template"📝 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.
| "description": null, | |
| "links": { | |
| "repoUrl": "https://github.com/asyncapi/html-template" | |
| "repoUrl": "https://github.com/dipaksodani/async-gen" | |
| }, | |
| "description": "HTML template for AsyncAPI Generator. Use it to generate static docs. It uses the AsyncAPI React component under the hood.", | |
| "links": { | |
| "repoUrl": "https://github.com/asyncapi/html-template" | |
| }, |
🤖 Prompt for AI Agents
In config/tools.json around lines 2807 to 2810 the "links.repoUrl" points to an
unrelated GitHub repo (https://github.com/dipaksodani/async-gen); update this to
the official AsyncAPI HTML template repository URL (replace the current value
with the correct canonical repo URL for the AsyncAPI HTML template), verify the
"description" field is set appropriately (not null) if required, and run a quick
JSON validation to ensure no syntax changes were introduced.
| "websiteUrl": "https://www.asyncapi.com/tools/cli", | ||
| "repoUrl": "https://github.com/asyncapi/cli" | ||
| "repoUrl": "https://github.com/hkirat/asyncapi-fork" | ||
| }, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
AsyncAPI CLI (Others) still points to fork
Mirror of earlier issue; please point to the official repo.
- "repoUrl": "https://github.com/hkirat/asyncapi-fork"
+ "repoUrl": "https://github.com/asyncapi/cli"📝 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.
| "websiteUrl": "https://www.asyncapi.com/tools/cli", | |
| "repoUrl": "https://github.com/asyncapi/cli" | |
| "repoUrl": "https://github.com/hkirat/asyncapi-fork" | |
| }, | |
| "websiteUrl": "https://www.asyncapi.com/tools/cli", | |
| "repoUrl": "https://github.com/asyncapi/cli" | |
| }, |
🤖 Prompt for AI Agents
In config/tools.json around lines 3120 to 3122, the AsyncAPI CLI entry currently
points to a forked repository; update the "repoUrl" value to the official
AsyncAPI CLI repository (https://github.com/asyncapi/cli) so the entry
references the upstream project instead of hkirat's fork; leave "websiteUrl"
unchanged.
* docs(community): update latest community documentation (#4407) * chore: update meetings.json and newsrooom_videos.json (#4410) * chore: update meetings.json and newsrooom_videos.json (#4405) * chore: update meetings.json, newsrooom_videos.json and dashboard.json * Update meetings.json --------- Co-authored-by: asyncapi-bot <[email protected]> Co-authored-by: Eve <[email protected]> Co-authored-by: Sambhav Gupta <[email protected]> * chore: update meetings.json and newsrooom_videos.json (#4411) * fix: #4065 Made Case Studies page table section mobile responsive (#4403) * fixes #4065. Made Case Studie page mobile responsive * fixes #4065. Made Case Studie page mobile responsive * fix: #4381 --------- Co-authored-by: Sambhav Gupta <[email protected]> * chore(deps): bump axios from 1.8.2 to 1.12.1 (#4413) * chore(deps): bump @babel/runtime and next-language-detector (#4414) * chore: update tools.json (#4417) * chore: update meetings.json and newsrooom_videos.json (#4419) * ci: update of files from global .github repo (#4418) * fix: broken AsyncAPI contributing guidelines link (#4395) (#4398) Co-authored-by: SanidhyaMadheshia <[email protected]> Co-authored-by: Sambhav Gupta <[email protected]> Co-authored-by: V Thulisile Sibanda <[email protected]> --------- Co-authored-by: Chan <[email protected]> Co-authored-by: asyncapi-bot <[email protected]> Co-authored-by: Eve <[email protected]> Co-authored-by: namanjain24-sudo <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: SanidhyaMadheshia <[email protected]> Co-authored-by: SanidhyaMadheshia <[email protected]> Co-authored-by: V Thulisile Sibanda <[email protected]>
Automated changes by create-pull-request GitHub action
Summary by CodeRabbit
New Features
Bug Fixes
Documentation