generator icon indicating copy to clipboard operation
generator copied to clipboard

Incoming changes for generator

Open derberg opened this issue 1 year ago • 3 comments

The purpose of this issue is to kida group all different issues that will change generator in coming months.

These are not new issues, some pretty old, some well discussed. So we just need to group them in a kind of roadmap.

  • Deprecations
    • We need to finally remove ag cli as we already very well support generator in AsyncAPI CLI https://github.com/asyncapi/generator/issues/1008
    • We need to set nunjucks rendering engine for deprecation and decide on details (like when will it be removed). We always wanted to remove it to make code less complex and focus fully on react that is much better than nunjucks. Unfortunately I could not quickly find any record of these old discussions. So we will have to do a deprecation with long time for template developers to plan migration
  • Monorepo
    • Basic monorepo intro work started already and we will have very simple projects included here first, like hooks (filters probably not as they are needed for nunjucks only, might be that some filters will change into reusable helpers for react templates) https://github.com/asyncapi/generator/issues/1044
    • Next big step is to include templates inside this generator monorepo as well. Template developers that want to work outside generator will still be able to do it, we should still support npm-like template installation. The goal is to focus currently very granular community of code generation (spread across different projects) in one repo, and work together on as many reusable helpers and react components as possible to make templates development and maintenance much easier

derberg avatar May 21 '24 16:05 derberg

Research on how and when deprecation should be done: https://github.com/orgs/asyncapi/projects/50/views/1?pane=issue&itemId=67997248

@lmgyuan so from previous discussions, research and past experience, I understand we want to:

  • announce deprecation in August 2024
  • perform removal in August 2025
  • deprecation approach should be imho that we do not add new flags/options to cli.js but of course provide bug fixes if needed. New features/options should be added to AsyncAPI CLI

derberg avatar Jul 24 '24 13:07 derberg

@derberg Yes that sounds good to me : )

lmgyuan avatar Jul 25 '24 23:07 lmgyuan

Thats sounds good to me !

Gmin2 avatar Jul 31 '24 14:07 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 Nov 29 '24 00:11 github-actions[bot]

Monorepo

we can count it is completed, as monorepo is in place, and there is an issue to track changes

Deprecations

pending

derberg avatar Jan 08 '25 15:01 derberg