Skip to content

Do not include js in the repository #476

Open

Description

@max-nextcloud

This tutorial should be used to develop apps that will most likely not be shipped with the server. So there's no need to include the compiled js.

We should avoid including the js in the repo when possible because:

  • It leads to conflicts on rebases that would otherwise be smooth.
  • It requires rebuilding the js as a production build for every pull request.
  • It requires additional consistency checks in ci to ensure js is updated.
  • It increases the repo size significantly.

Activity

  1. susnux commented on Feb 15, 2023

    @susnux
    Contributor

    I think ´js/` is included so users can directly test it without installing node dependencies and building the js assets:
    https://github.com/nextcloud/app-tutorial#try-it

  2. max-nextcloud commented on Feb 20, 2023

    @max-nextcloud
    Author

    I think ´js/` is included so users can directly test it without installing node dependencies and building the js assets: https://github.com/nextcloud/app-tutorial#try-it

    Good point. On the other hand if you want to make changes you will need to compile the js anyway. And if people use this as a template for their own app they will start with an included js which can be annoying.

    So I agree... not an obvious decision here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions