-
-
Notifications
You must be signed in to change notification settings - Fork 728
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
fix: updated commands for generator on website #3545
base: master
Are you sure you want to change the base?
Conversation
WalkthroughThe pull request focuses on updating AsyncAPI generator templates and configurations to version 3.0.0. Changes are made across multiple configuration files and a React component, specifically updating template references, adding the Changes
Assessment against linked issues
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
📜 Recent review detailsConfiguration used: .coderabbit.yaml 📒 Files selected for processing (2)
🚧 Files skipped from review as they are similar to previous changes (2)
Finishing Touches
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
Documentation and Community
|
✅ Deploy Preview for asyncapi-website ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #3545 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 19 19
Lines 668 668
=========================================
Hits 668 668 ☔ View full report in Codecov by Sentry. |
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-3545--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: 0
🧹 Nitpick comments (2)
components/GeneratorInstallation.tsx (1)
65-65
: Docker command updated with--network host
.
Consider adding a note in the documentation about potential security or networking implications when using the host network.config/generator-flags.json (1)
22-23
: Java Spring Boot template pinned and flagged for the new generator.
Ensure relevant documentation is updated so users know that3.0.0
is the default now.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
components/GeneratorInstallation.tsx
(2 hunks)config/generator-flags.json
(1 hunks)config/generator-templates.json
(1 hunks)
🔇 Additional comments (9)
components/GeneratorInstallation.tsx (2)
24-24
: Pinning the template to a specific version helps avoid unexpected breaking changes.
Great job specifying@asyncapi/[email protected]
. This prevents users from accidentally pulling future major versions with potentially breaking changes.
26-26
: Adding--use-new-generator
ensures compatibility with the updated generator.
This aligns with the PR objective to maintain consistent usage with the new generator.config/generator-templates.json (1)
2-8
: Version pinning is consistent across all templates.
Explicitly referencing@asyncapi/…@3.0.0
helps ensure the correct version is used. This is aligned with best practices for stable deployments.config/generator-flags.json (6)
2-3
: Update to@asyncapi/[email protected]
and appended--use-new-generator
.
Pinning and adding the new generator flag aligns with the objective of ensuring compatibility with the latest generator changes.
6-7
: Markdown template pinned and updated flags.
Looks good. Keep an eye on upstream updates to ensure ongoing compatibility.
10-11
: Node.js production server flags integrated with the new generator.
Be sure to verify that the-p server=production
parameter remains valid for all usage scenarios.
14-15
: Node.js WebSockets template pinned to3.0.0
with new generator flag.
This is consistent with the rest of the pinned templates.
18-19
: Java Spring Cloud Stream template pinned & updated.
No issues found.
26-27
: Python Paho template pinned & updated.
Everything looks consistent.
Description
/tools/generator
page to work with new generator and templates for both normal cli and dockerScreenshots
Before :
Normal command -
Docker command -
After :
Normal command -
Docker command -
Related issue(s)
Fixes #3522
Summary by CodeRabbit
New Features
--use-new-generator
flag to generator commands.--network host
option.Improvements