Skip to content
This repository has been archived by the owner on Sep 9, 2020. It is now read-only.

Clarify when to run ensure when vendor is not committed #1076

Merged
merged 1 commit into from
Sep 9, 2017

Conversation

carolynvs
Copy link
Collaborator

What does this do / why do we need it?

The current FAQ is misleading. When you don't commit vendor, you must run dep ensure after most git operations, not just a fresh clone. Otherwise you will have an out-of-date vendor/ whenever someone updates the Gopkg.lock.

Honestly, based on this, I have now completely flipped positions on committing vendor, and tell everyone who asks "Yes, commit it!" 😀

What should your reviewer look out for in this PR?

Let me know if I'm totally misunderstanding when you have to run dep ensure if you don't commit vendor.

Do you need help or clarification on anything?

Nope.

Copy link
Collaborator

@ibrasho ibrasho left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@ibrasho
Copy link
Collaborator

ibrasho commented Sep 9, 2017

Should be merged after a rebase.

docs/FAQ.md Outdated

**Cons**

- your repo will be bigger, potentially a lot bigger
- PR diffs are more annoying
- Your repo will be bigger, potentially a lot bigger. Pruning can help minimize this problem.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor nit:

Let's remove "Pruning can help minimize this problem." when prune is merged into ensure. Since it will feel like an additional step is required to have that benefit.

@ibrasho ibrasho added the docs label Sep 9, 2017
@carolynvs carolynvs force-pushed the commit-vendor-faq branch 3 times, most recently from 60b4442 to a36e40d Compare September 9, 2017 23:26
@carolynvs carolynvs merged commit 16990a1 into golang:master Sep 9, 2017
@carolynvs carolynvs deleted the commit-vendor-faq branch September 9, 2017 23:27
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants