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

Commit

Permalink
Merge pull request #1076 from carolynvs/commit-vendor-faq
Browse files Browse the repository at this point in the history
Clarify when to run ensure when vendor is not committed
  • Loading branch information
carolynvs authored Sep 9, 2017
2 parents 6890c50 + 01d6b3a commit 16990a1
Showing 1 changed file with 12 additions and 8 deletions.
20 changes: 12 additions & 8 deletions docs/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,14 +116,14 @@ authenticated repository.

First, configure `git` to use the credentials option for the specific repository.

For example, if you use gitlab, and you wish to access `https://gitlab.example.com/example/package.git`,
For example, if you use gitlab, and you wish to access `https://gitlab.example.com/example/package.git`,
then you would want to use the following configuration:

```
$ git config --global credential.https://gitlab.example.com.example yourusername
```

In the example the hostname `gitlab.example.com.username` string seems incorrect, but
In the example the hostname `gitlab.example.com.username` string seems incorrect, but
it's actually the hostname plus the name of the repo you are accessing which is `username`.
The trailing 'yourusername' is the username you would use for the actual authentication.

Expand All @@ -137,8 +137,8 @@ $ git help -a | grep credential-
credential-osxkeychain remote-ftps
credential-store remote-http
```
You would then choose an appropriate provider. For example, to use the osxkeychain, you

You would then choose an appropriate provider. For example, to use the osxkeychain, you
would use the following:

```
Expand Down Expand Up @@ -296,13 +296,17 @@ It's up to you:

**Pros**

- It's the only way to get truly reproducible builds, as it guards against upstream renames, deletes and commit history overwrites.
- You don't need an extra `dep ensure` step (to fetch dependencies) on fresh clones to build your repo: you can use `go get` as usual.
- It's the only way to get truly reproducible builds, as it guards against upstream renames,
deletes and commit history overwrites.
- You don't need an extra `dep ensure` step to sync `vendor/` with Gopkg.lock after most operations,
such as `go get`, cloning, getting latest, merging, etc.

**Cons**

- Your repo will be bigger, potentially a lot bigger.
- PR diffs are more annoying (but files in `vendor/` are [hidden by default](https://github.com/github/linguist/blob/v5.2.0/lib/linguist/generated.rb#L328) on Github).
- Your repo will be bigger, potentially a lot bigger,
though `dep prune` can help minimize this problem.
- PR diffs will include changes for files under `vendor/` when Gopkg.lock is modified,
however files in `vendor/` are [hidden by default](https://github.com/github/linguist/blob/v5.2.0/lib/linguist/generated.rb#L328) on Github.

## How do I roll releases that `dep` will be able to use?

Expand Down

0 comments on commit 16990a1

Please sign in to comment.