Should I check in folder “node_modules” to Git when creating a Node.js app on Heroku?

by

Second Update

The FAQ is not available anymore.

From the documentation of shrinkwrap:

If you wish to lock down the specific bytes included in a package, for example to have 100% confidence in being able to reproduce a deployment or build, then you ought to check your dependencies into source control, or pursue some other mechanism that can verify contents rather than versions.

Shannon and Steven mentioned this before but I think it should be part of the accepted answer.

Update

The source listed for the below recommendation has been updated. They are no longer recommending the node_modules folder be committed.

Usually, no. Allow npm to resolve dependencies for your packages.

For packages you deploy, such as websites and apps, you should use npm
shrinkwrap to lock down your full dependency tree:

https://docs.npmjs.com/cli/shrinkwrap

Original Post

For reference, npm FAQ answers your question clearly:

Check node_modules into git for things you deploy, such as websites
and apps. Do not check node_modules into git for libraries and modules
intended to be reused. Use npm to manage dependencies in your dev
environment, but not in your deployment scripts.

and for some good rationale for this, read Mikeal Rogers’ post on this.

Source: https://docs.npmjs.com/misc/faq#should-i-check-my-node-modules-folder-into-git

More Related Contents:

  1. Should “node_modules” folder be included in the git repository
  2. update package.json version automatically
  3. Why do I obtain this error when deploying app to Heroku?
  4. How can I make Git "forget" about a file that was tracked, but is now in .gitignore?
  5. Make .gitignore ignore everything except a few files
  6. Global Git ignore
  7. How to ignore certain files in Git?
  8. npm ERR cb() never called
  9. Permission denied (publickey) when deploying heroku code. fatal: The remote end hung up unexpectedly
  10. How can I stop .gitignore from appearing in the list of untracked files?
  11. .gitignore after commit [duplicate]
  12. git ignore vs. exclude vs. assume-unchanged
  13. How to remove files that are listed in the .gitignore but still on the repository?
  14. Force add despite the .gitignore file
  15. Git is ignoring files that aren’t in gitignore
  16. gitignore binary files that have no extension
  17. Definitive retroactive .gitignore (how to make Git completely/retroactively forget about a file now in .gitignore)
  18. Getting an error pushing to github – Updates were rejected because a pushed branch tip is behind its remote
  19. How to ignore all hidden directories/files recursively in a git repository?
  20. Is there a way to tell git to only include certain files instead of ignoring certain files?
  21. git ignore exception
  22. After git push heroku – uploaded files on Heroku are lost
  23. How to use environment variables in package.json
  24. Why is .gitignore not ignoring my files?
  25. git ignore all files of a certain type, except those in a specific subfolder
  26. Git Ignores and Maven targets
  27. What is the reason for “Procfile declares types -> (none)” in Heroku?
  28. Can I include other .gitignore file in a .gitignore file? (like #include in c-like languages)
  29. How to push different local Git branches to Heroku/master
  30. Commit empty folder structure (with git) [duplicate]

Leave a Comment