Skip to content
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

[FEATURE]: Make compile option default to false in future major release #1259

Open
2 tasks done
Gmin2 opened this issue Aug 26, 2024 · 1 comment
Open
2 tasks done
Labels
enhancement New feature or request

Comments

@Gmin2
Copy link
Collaborator

Gmin2 commented Aug 26, 2024

Why do we need this improvement?

In PR #1177, we introduced the compile option in the generator and set its default value to true. This was implemented to ensure that transpilation runs by default

However, our initial plan was to have transpilation disabled by default, with an option to enable it when needed. In our next major release, we should change the default value of the compile option back to false to align with our initial plan.

This change should be implemented as part of our next major version release to avoid introducing a breaking change in a minor or patch release.

How will this change help?

This change will have transpilation disabled by default, with an option to enable it when needed. Users who rely on the current behavior will need to explicitly set compile: true after upgrading to the new major version.

🚧 Breaking changes

Yes

👀 Have you checked for similar open issues?

  • I checked and didn't find a similar issue

🏢 Have you read the Contributing Guidelines?

Are you willing to work on this issue?

Yes I am willing to submit a PR!

@Gmin2 Gmin2 added the enhancement New feature or request label Aug 26, 2024
@derberg
Copy link
Member

derberg commented Aug 26, 2024

this has to be done together with additional documentation that explains the compilation/transpilation concept + explanation on how to publish a template with transpilation files included -> asyncapi/html-template#575

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants
@derberg @Gmin2 and others