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

Outdated documentation is causing issues. #16

Open
mihainutiu-vtex opened this issue May 24, 2022 · 0 comments
Open

Outdated documentation is causing issues. #16

mihainutiu-vtex opened this issue May 24, 2022 · 0 comments
Labels
bug Something isn't working

Comments

@mihainutiu-vtex
Copy link

Describe the bug
In the documentation for installing this app, it is detailed in the 3rd step ( Implementing the app's blocks in your store theme) that the app should be added as a dependency in the manifest. Because this app has billing options it will throw an error when trying to build the theme: error: App build failed with message: Error with dependency [email protected]: App cannot contain billing options: [email protected]

To Reproduce
Steps to reproduce the behaviour:

  1. Add the [email protected] as a dependency in the store theme manifest
  2. Try to link the theme in a vtex account
  3. Building the theme will fail with the error message mentioned previously.

To solve

Update the documentation and specify that this app should be added as a peerDependency instead of a dependency.
peerDependencies apps are allowed to have billing options because they will be installed manually, but dependencies apps will be installed automatically, so they can not contain any billing options.

@mihainutiu-vtex mihainutiu-vtex added the bug Something isn't working label May 24, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant