fix: updated commands for generator on website #3545
Conversation
SahilDahekar
requested review from
derberg,
akshatnema,
magicmatatjahu,
anshgoyalevil,
Mayaleeeee and
asyncapi-bot-eve
as code owners
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 due to trivial changes (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 180000ms (3)
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. |
SahilDahekar
changed the title
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-3545--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: 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.0is 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-generatorensures 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.0helps 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=productionparameter remains valid for all usage scenarios.
14-15: Node.js WebSockets template pinned to3.0.0with 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.
There was a problem hiding this comment.
lgtm, but there is one more thing, a nit pick from coderabbit, about --network host and security
we need to add some kind of info there about it, more importandly, we just need to make it clear to person that copies the command that --network host is there only because in the link we use URL link to AsyncAPI document, and if people use it differently, pointing to local resource, the flag would not be needed
Where should this doc change be ? Should it be added here |
|
best above the docker command, as a code comment |
|
Done 👍 |
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
components/GeneratorInstallation.tsx(2 hunks)
🧰 Additional context used
🪛 eslint
components/GeneratorInstallation.tsx
[error] 66-66: Strings must use singlequote.
(quotes)
[error] 66-66: Operator '+' must be spaced.
(space-infix-ops)
[error] 66-66: Unexpected string concatenation of literals.
(no-useless-concat)
[error] 66-66: Insert ⏎······
(prettier/prettier)
🪛 GitHub Actions: PR testing - if Node project
components/GeneratorInstallation.tsx
[error] 66-66: Strings must use singlequote
[error] 66-66: Operator '+' must be spaced
[error] 66-66: Unexpected string concatenation of literals
[error] 66-66: Insert line break with proper indentation
🔇 Additional comments (2)
components/GeneratorInstallation.tsx (2)
65-68: Good addition of network flag documentation!The comment clearly explains when the
--network hostflag is needed, which addresses the discussion in the PR comments.🧰 Tools
🪛 eslint
[error] 66-66: Strings must use singlequote.
(quotes)
[error] 66-66: Operator '+' must be spaced.
(space-infix-ops)
[error] 66-66: Unexpected string concatenation of literals.
(no-useless-concat)
[error] 66-66: Insert
⏎······(prettier/prettier)
🪛 GitHub Actions: PR testing - if Node project
[error] 66-66: Strings must use singlequote
[error] 66-66: Operator '+' must be spaced
[error] 66-66: Unexpected string concatenation of literals
[error] 66-66: Insert line break with proper indentation
24-24: LGTM! Version pinning and new generator flag added.The changes correctly update the template version and add the required
--use-new-generatorflag.Let's verify these changes align with the generator configuration:
Also applies to: 26-26
✅ Verification successful
Version and flag changes verified against configuration files
The template version
@asyncapi/[email protected]and--use-new-generatorflag are correctly aligned with the configuration in bothgenerator-templates.jsonandgenerator-flags.json.🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Verify template version and flags in config files rg -l "3.0.0" config/ rg --json "use-new-generator" config/Length of output: 1024
Script:
#!/bin/bash # Check template configuration details cat config/generator-templates.json cat config/generator-flags.jsonLength of output: 1577
Description
/tools/generatorpage 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-generatorflag to generator commands.--network hostoption.Improvements