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

Docs(addon-author-guide)/ remove the out-of-date part about alternative to monorepos #1765

Conversation

BlueCutOfficial
Copy link
Collaborator

Closes #1754

This PR removes the out-of-date paragraph presenting an alternative to monorepos in addon-author-guide, with ember-welcome-page as an example. ember-welcome-page is now a monorepo.

@BlueCutOfficial BlueCutOfficial changed the title Docs(addon-author-guide)/ remove ewp as an example of … Docs(addon-author-guide)/ remove the out-of-date part about alternative to monorepos Jan 22, 2024
@@ -67,7 +67,7 @@ Another good way to learn about v2 addons is to look at some examples:
- [ember-stargate](https://github.com/simonihmig/ember-stargate)
- [glimmer-apollo](https://github.com/josemarluedke/glimmer-apollo)

Several of these examples use a monorepo as a way to keep a clean separation between the addon and the application that holds their test suite. If you're comfortable working with monorepos this is a good solution. On the other hand, monorepos have some tradeoffs and are not always well-supported by all tools, so it's also OK to keep your test app in a subdirectory of your addon. This is closer to how V1 addons work, where `tests/dummy` serves this purpose. See [ember-welcome-page](https://github.com/ember-cli/ember-welcome-page) for an example of not using a monorepo -- instead it has a `test-app` subdirectory and uses the `addon-dev` command from `@embroider/addon-dev` to manage linkage between the addon and the test-app and to manage combining of dependencies from both into a single top-level package.json
These examples use a monorepo as a way to keep a clean separation between the addon and the application that holds their test suite. This is currently the recommended solution.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Should probably say why it's recommend or link to something that explains how you want to assure deps and package.json#exports are configured correctly, etc.

Thanks!

Copy link
Member

Choose a reason for hiding this comment

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

I don't think that should be a blocker for merging this PR 🤔 maybe we can get this merged and we can discuss your point in the meeting tomorrow @NullVoxPopuli ?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Yeah, seems fine

@NullVoxPopuli NullVoxPopuli merged commit d015c8d into embroider-build:main Jan 22, 2024
95 checks passed
@github-actions github-actions bot mentioned this pull request Jan 22, 2024
@BlueCutOfficial BlueCutOfficial deleted the docs-addon-author-guide-remove-out-of-date branch January 22, 2024 14:51
@github-actions github-actions bot mentioned this pull request Apr 4, 2024
@github-actions github-actions bot mentioned this pull request Apr 15, 2024
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.

docs: inconsistency between addon-author-guide.md and ember-welcome-page
3 participants