Skip to content

feat: add CLI v5 usage and expand generator compatibility for html-template#766

Merged
asyncapi-bot merged 5 commits intoasyncapi:masterfrom
Varadraj75:varad-dev
Jan 6, 2026
Merged

feat: add CLI v5 usage and expand generator compatibility for html-template#766
asyncapi-bot merged 5 commits intoasyncapi:masterfrom
Varadraj75:varad-dev

Conversation

@Varadraj75
Copy link
Contributor

Description

  • Update html-template generator compatibility to support AsyncAPI Generator v3 (CLI v5)
  • Document correct usage for html-template v3.5 with AsyncAPI CLI v5 in the README.md

Related issue(s)
Resolves #765

Copilot AI review requested due to automatic review settings January 5, 2026 17:38
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

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.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR updates the html-template generator to support AsyncAPI Generator v3 (CLI v5) and adds documentation for using the updated template version. The changes enable broader compatibility while maintaining backward compatibility with Generator v2.

  • Expanded generator version compatibility range to include v3.x.x
  • Added documentation for using template v3.5 with AsyncAPI Generator v3 and CLI v5

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
package.json Updated generator version compatibility from <3.0.0 to <4.0.0 to support AsyncAPI Generator v3
README.md Added usage instructions for template v3.5 with AsyncAPI Generator v3 and CLI v5

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@Varadraj75 Varadraj75 changed the title Add CLI v5 usage and expand generator compatibility for html-template fix: add CLI v5 usage and expand generator compatibility for html-template Jan 5, 2026
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@Varadraj75
Copy link
Contributor Author

hey @derberg,
I have updated the generator compatibility and added CLI v5 usage as discussed
could you please review and let me know if this looks good or needs any changes?
Thanks!

derberg
derberg previously approved these changes Jan 6, 2026
@derberg
Copy link
Member

derberg commented Jan 6, 2026

@Varadraj75 please adjust PR, make sure you refer to version 3.5.0 and not 3.4.0

we need to release minor release, so change PR prefix to feat:

@Varadraj75
Copy link
Contributor Author

Hey @derberg,
I have pushed the requested update to reference v3.5.0.
Please let me know if this looks good now.
Thanks!

@Varadraj75 Varadraj75 changed the title fix: add CLI v5 usage and expand generator compatibility for html-template feat: add CLI v5 usage and expand generator compatibility for html-template Jan 6, 2026
@derberg
Copy link
Member

derberg commented Jan 6, 2026

Please do not rush and be careful.

When changes are made quickly and without sufficient care, you may save your own time, but you end up consuming the maintainer’s time instead.

You did not update the references from 3.4 to 3.5 in all parts of your PR.

@sonarqubecloud
Copy link

sonarqubecloud bot commented Jan 6, 2026

@Varadraj75
Copy link
Contributor Author

Hi @derberg ,
I am truly sorry for rushing and unintentionally wasting your time ,
I genuinely regret that.
Thank you for your patience and guidance, I will slow down and be much more careful going forward.

@derberg
Copy link
Member

derberg commented Jan 6, 2026

@Varadraj75 remember, open source is not a race, it is a very, very long journey.

Thanks for taking time to open this PR

/rtm

@asyncapi-bot asyncapi-bot merged commit 98281ae into asyncapi:master Jan 6, 2026
11 checks passed
@asyncapi-bot
Copy link
Contributor

🎉 This PR is included in version 3.5.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

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.

[BUG] CLI v5 does not accept html-template v3.0.0+

3 participants