diff options
author | Grzegorz Bizon <grzegorz@gitlab.com> | 2019-08-16 10:03:50 +0300 |
---|---|---|
committer | Grzegorz Bizon <grzegorz@gitlab.com> | 2019-08-16 10:03:50 +0300 |
commit | 2bb475adbaf751f6f410fbdcc3c0066082ddd73b (patch) | |
tree | 365cdd6ba37bcd562760e74e7d1dc82ea7d74779 /doc | |
parent | a41ae62c207275bbd619b2fd19c33f05de868549 (diff) | |
parent | 89bccb02d1aadb6f336576a16598ba95aad14115 (diff) |
Merge branch 'do-not-vendor-go-mod' into 'master'
Don't use go mod vendor
See merge request gitlab-org/gitlab-ce!31721
Diffstat (limited to 'doc')
-rw-r--r-- | doc/development/go_guide/index.md | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/doc/development/go_guide/index.md b/doc/development/go_guide/index.md index 9f0ac8cc753..83444093f9c 100644 --- a/doc/development/go_guide/index.md +++ b/doc/development/go_guide/index.md @@ -107,6 +107,32 @@ Modules](https://github.com/golang/go/wiki/Modules). It provides a way to define and lock dependencies for reproducible builds. It should be used whenever possible. +When Go Modules are in use, there should not be a `vendor/` directory. Instead, +Go will automatically download dependencies when they are needed to build the +project. This is in line with how dependencies are handled with Bundler in Ruby +projects, and makes merge requests easier to review. + +In some cases, such as building a Go project for it to act as a dependency of a +CI run for another project, removing the `vendor/` directory means the code must +be downloaded repeatedly, which can lead to intermittent problems due to rate +limiting or network failures. In these circumstances, you should cache the +downloaded code between runs with a `.gitlab-ci.yml` snippet like this: + +```yaml +.go-cache: + variables: + GOPATH: $CI_PROJECT_DIR/.go + before_script: + - mkdir -p .go + cache: + paths: + - .go/pkg/mod/ + +test: + extends: .go-cache + # ... +``` + There was a [bug on modules checksums](https://github.com/golang/go/issues/29278) in Go < v1.11.4, so make sure to use at least this version to avoid `checksum mismatch` errors. |