How to commit Composer vendor folder into Git repository?

Question

Can I setup .gitignore in such a way to allow Composer dependencies (the vendor directory) to live inside my repository?

Composers officially recommends that you "should not" do this. And it provides three reasons (https://getcomposer.org/doc/faqs/should-i-commit-the-dependencies-in-my-vendor-directory.md):

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.

All these three reasons do not matter to me. Also it may be possible that reason three could be obviated by a clever .gitignore.

If it is necessary for me to state a motivation for this question then my motivation is: CocoaPods does it this way and I like how CocoaPods works.

What exactly should I do in .gitignore to achieve this?

Just version the lock file. An Install on that will give 100% sane results — exussum
– exussum, Commented Dec 5, 2016 at 23:08
@exussum, composer install with a versioned composer.lock "will give 100% sane results"… provided all of the dependencies defined therein are still available and can be retrieved. There are ways it can still fail, and there are situations where one might actually want to include vendor/ in their repository. — Chris
– Chris, Commented Dec 6, 2016 at 15:59

ClickLabs · Accepted Answer · 2016-12-05 23:17:34Z

8

Simply remove any reference to /vendor from your .gitignore file. Then add and commit the vendor files.

Just be prepared to add 100+ megs of vendor library files to your repository.

answered Dec 5, 2016 at 23:17

ClickLabs

5573 silver badges5 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

Disk space is cheap. Fixing broken dependencies is less cheap.

Dave Mackey · Accepted Answer · 2020-02-03 22:03:33Z

2

In my case the following worked:

answered Feb 3, 2020 at 22:03

Dave Mackey

4,45221 gold badges84 silver badges147 bronze badges

Milan · Accepted Answer · 2018-08-17 13:07:09Z

0

Do the following to commit vendor directory:

git add vendor 
git commit -m "Added vendor directory to source control"

answered Aug 17, 2018 at 13:07

Milan

7779 silver badges17 bronze badges