docs: broken link to Generator Github Actions(#3190) #3299
Conversation
TanmayChaurasia24
requested review from
quetzalliwrites and
asyncapi-bot-eve
as code owners
WalkthroughThe changes made in the pull request focus on updating the installation instructions for the AsyncAPI CLI and generator library. The document's content has been revised for clarity, specifically enhancing the note regarding the use of the generator in CI/CD pipelines. The link to GitHub Actions has been corrected to reflect the new URL, which provides broader functionality. The overall structure and formatting remain intact, ensuring clear accessibility of prerequisites and installation instructions. Changes
Assessment against linked issues
Poem
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
CodeRabbit Configuration File (
|
✅ Deploy Preview for asyncapi-website ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.
asyncapi-bot
requested review from
devilkiller-ag,
sambhavgupta0705,
BhaswatiRoy,
J0SAL,
TRohit20 and
VaishnaviNandakumar
![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
🧹 Outside diff range and nitpick comments (1)
markdown/docs/tools/generator/installation-guide.md (1)
76-76: Approved: Link updated successfully.The change successfully addresses the issue of the broken link to GitHub Actions for Generator. The new link is more comprehensive and accurately reflects the expanded functionality of the GitHub Action.
Consider adding a brief description of the additional features included in the new GitHub Action (validator, converter, etc.) to give users a better understanding of its capabilities. For example:
> :memo: **Note:** To use the generator in your CI/CD pipeline to automate whatever you generate for your event-driven architecture apps, install the AsyncAPI CLI in your pipeline. If you are using GitHub Actions, use [Github Actions for Generator](https://github.com/marketplace/actions/generator-validator-converter-and-others-all-in-one-for-your-asyncapi-docs), which includes additional features like validation and conversion for your AsyncAPI documents.
TanmayChaurasia24
changed the title
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-3299--asyncapi-website.netlify.app/ |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #3299 +/- ##
=======================================
Coverage 49.14% 49.14%
=======================================
Files 21 21
Lines 647 647
=======================================
Hits 318 318
Misses 329 329 ☔ View full report in Codecov by Sentry. |
Changed markdown/docs/tools/generator/installation-guide.md
Resolves #3190
Summary by CodeRabbit