generator icon indicating copy to clipboard operation
generator copied to clipboard

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

Open Gmin2 opened this issue 1 year ago • 4 comments

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?

  • [X] 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 avatar Aug 26 '24 10:08 Gmin2

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 -> https://github.com/asyncapi/html-template/pull/575

derberg avatar Aug 26 '24 12:08 derberg

@derberg @Gmin2

Is anyone working on this issue?

TheMarvelFan avatar Nov 13 '24 12:11 TheMarvelFan

Is anyone working on this issue?

This issue is mostly completed only, we need to make depreciating notice, feel free to pick other issues

Gmin2 avatar Nov 14 '24 14:11 Gmin2

This issue has been automatically marked as stale because it has not had recent activity :sleeping:

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience :heart:

github-actions[bot] avatar Mar 15 '25 00:03 github-actions[bot]

This issue has been automatically marked as stale because it has not had recent activity :sleeping:

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience :heart:

github-actions[bot] avatar Aug 14 '25 00:08 github-actions[bot]