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

Separate current templates from generator repository #237

Closed
derberg opened this issue Mar 4, 2020 · 4 comments
Closed

Separate current templates from generator repository #237

derberg opened this issue Mar 4, 2020 · 4 comments
Labels
enhancement New feature or request

Comments

@derberg
Copy link
Member

derberg commented Mar 4, 2020

Reason:

Generator repo should only consist of the "core" of the generator and once we have 'remote-templates' support, templates should be developed and released separately. This will make onboarding and development aka contributions easier

Description:

  • move templates to a separate repo. One with monorepo setup with lerna or other tool that will simplify development, or as many as we have templates, but then introduce some naming convention.
  • think about pros and cons of monorepo vs separate. For sure with monorepo we won't be able to use GitHub releases, and tagging will be strange because if here Introduce remote-templates support #235 we go with NPM and sem-ver, then proper versioning will be important for a project

Hints:

  • Except for Introduce remote-templates support #235 that blocks this issue, it would be also nice to have this Avoid code repetition in templates filters #212 done first, before we move templates to separate repositories (if we do not do monorepo)
  • Conventional commits support monorepos by allowing to have a scope indication on the commit message, like feat(markdown): add some new thing to markdown template so CI can properly identify that the version bump should be done only for markdown template
@RobertDiebels
Copy link

RobertDiebels commented Mar 5, 2020

Might I propose creating an @asyncapi scope on npm.

  • Will aid users when searching for AsyncAPI related packages.
  • Will clarify which packages with asyncapi in their name are maintained by AsyncAPI collaborators.
  • May be useful in the future if there are going to be more separate templates maintained by AsyncAPI collaborators.

I'm not sure whether this should be a stand-alone issue or part of this one. Just thought I would mention it.

Side-note: Not withstanding the issues you mentioned of a monorepo. I'm a big fan of separate repositories. If only for the reduction in cognitive load when only dealing with with a small amount of folders and files.

@derberg
Copy link
Member Author

derberg commented Mar 5, 2020

@RobertDiebels we have it already https://www.npmjs.com/search?q=%40asyncapi and templates are already published with the scope. Other packages? should to. I'm now working on release automation for generator #225 , and then parser and I will make sure we publish with @asyncapi scope

@RobertDiebels
Copy link

@derberg Ah nice! Before I commented I only checked the main packages generator, parser, etc. I was not aware that we already had separate packages for the templates 👍 . You can disregard my comment in that case.

@fmvilas
Copy link
Member

fmvilas commented Mar 30, 2020

This was fixed by #261

@fmvilas fmvilas closed this as completed Mar 30, 2020
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