Skip to content

Conversation

@asyncapi-bot
Copy link
Contributor

@asyncapi-bot asyncapi-bot commented Jan 27, 2025

Automated changes by create-pull-request GitHub action

Summary by CodeRabbit

Release Notes

  • New Features

    • Added AsyncAPI CLI to the list of technologies
    • Updated tools configuration with new and renamed tools across various categories
  • Changes

    • Restructured tools in categories like Code Generators, Validators, IDE Extensions, and Generator Templates
    • Introduced new tools and removed some existing ones
    • Updated descriptions and links for multiple tools
  • Documentation

    • Refreshed configuration files to provide more comprehensive tool information

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 27, 2025

Walkthrough

This pull request involves updates to three configuration files in the AsyncAPI project: config/all-tags.json, config/tools-automated.json, and config/tools.json. The changes primarily focus on adding a new technology entry for AsyncAPI CLI, restructuring tool categories, and completely replacing the tools.json file with an updated configuration. The modifications aim to enhance the documentation and organization of AsyncAPI-related tools and technologies.

Changes

File Change Summary
config/all-tags.json Added new technology entry: AsyncAPI CLI with specific color and border color
config/tools-automated.json Significant restructuring of tools across categories:
- Removed/added tools in Code-first tools, Code Generators
- Updated Validators, IDE Extensions
- Overhauled AsyncAPI Generator Templates
- Modified GitHub Actions and Mocking and Testing sections
config/tools.json Completely replaced with a new JSON structure containing updated tool descriptions, links, and categories

Possibly related PRs

Suggested labels

autoapproved, autoupdate

Suggested reviewers

  • derberg
  • akshatnema
  • magicmatatjahu
  • anshgoyalevil
  • Mayaleeeee
  • devilkiller-ag
  • sambhavgupta0705
  • asyncapi-bot-eve

Poem

🐰 In the realm of config and code,
A rabbit hops with a playful mode,
AsyncAPI CLI takes its stand,
Tools reshuffled by a gentle hand,
A configuration dance, light and bright,
Bringing order with pure delight! 🛠️


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.

@codecov
Copy link

codecov bot commented Jan 27, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (93fd10f) to head (c53d2fb).
Report is 2 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff            @@
##            master     #3611   +/-   ##
=========================================
  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.

@netlify
Copy link

netlify bot commented Jan 27, 2025

Deploy Preview for asyncapi-website ready!

Name Link
🔨 Latest commit c53d2fb
🔍 Latest deploy log https://app.netlify.com/sites/asyncapi-website/deploys/6796d468a6a7d70008176765
😎 Deploy Preview https://deploy-preview-3611--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.

@asyncapi-bot asyncapi-bot merged commit 61b3af2 into master Jan 27, 2025
32 of 34 checks passed
@asyncapi-bot asyncapi-bot deleted the update-tools/regenerateTools branch January 27, 2025 00:37
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🔭 Outside diff range comments (1)
config/tools-automated.json (1)

Line range hint 443-457: Fix duplicate and inconsistent entries in GitHub Actions section.

There are two issues:

  1. Duplicate entries for "GitHub Action for Generator"
  2. Inconsistent category name: "github-actions" vs "github-action" used elsewhere

Apply this fix:

  1. Remove the duplicate entry
  2. Standardize the category name to "github-action"
-        "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/asyncapi/cli"
-        },
-        "filters": {
-          "technology": [
-            "AsyncAPI Generator"
-          ],
-          "categories": [
-            "github-actions"
-          ],
-          "hasCommercial": false,
-          "isAsyncAPIOwner": true
-        }
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 93fd10f and c53d2fb.

📒 Files selected for processing (3)
  • config/all-tags.json (1 hunks)
  • config/tools-automated.json (14 hunks)
  • config/tools.json (1 hunks)
⏰ 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
🔇 Additional comments (3)
config/all-tags.json (1)

1-1: LGTM! New technology entry follows consistent structure.

The addition of "AsyncAPI CLI" technology maintains the established format and color scheme used throughout the file.

Let's verify the color consistency with other entries:

✅ Verification successful

Color scheme follows established pattern

The AsyncAPI CLI entry uses the most common color combination in the file (bg-[#61d0f2] border-[#40ccf7]), which is shared by 21 other technology entries. This appears to be an intentional default color scheme for related technologies.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check if the new color values are used consistently across other entries

# Extract unique color combinations
echo "Unique color combinations:"
cat config/all-tags.json | jq -r '.technologies[] | "\(.color) \(.borderColor)"' | sort | uniq -c

Length of output: 732

config/tools-automated.json (1)

409-422: LGTM! GitHub Action for CLI entry is well-documented.

The entry is properly structured with clear description and appropriate technology tags.

config/tools.json (1)

1-1: LGTM! Comprehensive reorganization of tools catalog.

The complete replacement of tools.json provides:

  • Clear categorization of tools
  • Consistent metadata structure
  • Comprehensive tool descriptions
  • Proper technology and language tagging

Let's verify the JSON structure integrity:

#!/bin/bash
# Description: Validate JSON structure and check for required fields

# Verify JSON syntax
jq '.' config/tools.json > /dev/null

# Check that all tool entries have required fields
jq -r '
  . as $root 
  | keys[] as $category 
  | $root[$category].toolsList[] 
  | select(
      .title == null or
      .description == null or
      .links == null or
      .filters == null
    ) 
  | "\($category): \(.title // "NO_TITLE")"
' config/tools.json

Comment on lines +427 to +439
"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"
],
"categories": [
"github-actions"
"github-action"
],
"hasCommercial": false,
"isAsyncAPIOwner": true
"isAsyncAPIOwner": false
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Add missing description for GitHub Action for Generator.

The description field is set to null, which should be populated with appropriate information.

@asyncapi-bot
Copy link
Contributor Author

⚡️ Lighthouse report for the changes in this PR:

Category Score
🔴 Performance 41
🟢 Accessibility 98
🟢 Best practices 92
🟢 SEO 100
🔴 PWA 33

Lighthouse ran on https://deploy-preview-3611--asyncapi-website.netlify.app/

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