Add FAQ about committing deps
parent
ccc6fa3714
commit
c9d1e7a918
|
@ -0,0 +1,26 @@
|
||||||
|
# Should I commit the dependencies in my vendor directory?
|
||||||
|
|
||||||
|
The general recommendation is **no**. The vendor directory (or wherever your
|
||||||
|
dependencies are installed) should be added to `.gitignore`/`svn:ignore`/etc.
|
||||||
|
|
||||||
|
The best practice is to then have all the developers use Composer to install
|
||||||
|
the dependencies. Similarly, the build server, CI, deployment tools etc should
|
||||||
|
be adapted to run Composer as part of their project bootstrapping.
|
||||||
|
|
||||||
|
While it can be tempting to commit it in some environment, it leads to a few
|
||||||
|
problems:
|
||||||
|
|
||||||
|
- Large VCS repository size and diffs when you update code.
|
||||||
|
- Duplication of the history of all your dependencies in your own VCS.
|
||||||
|
- Adding dependencies installed via git to a git repo will show them as
|
||||||
|
submodules. This is problematic because they are not real submodules, and you
|
||||||
|
will run into issues.
|
||||||
|
|
||||||
|
If you really feel like you must do this, you have two options:
|
||||||
|
|
||||||
|
- Limit yourself to installing tagged releases (no dev versions), so that you
|
||||||
|
only get zipped installs, and avoid problems with the git "submodules".
|
||||||
|
- Remove the .git directory of every dependency after the installation, then
|
||||||
|
you can add them to your git repo. You can do that with `rm -rf vendor/**/.git`
|
||||||
|
but this means you will have to delete those dependencies from disk before
|
||||||
|
running composer update.
|
Loading…
Reference in New Issue