letsencrypt
/
boulder
mirror of https://github.com/letsencrypt/boulder.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update instructions for updating and testing dependencies (#4905) 

Fixes #4896
This commit is contained in:
Aaron Gable 2020-06-29 09:57:18 -07:00 committed by GitHub
parent 203ec13750
commit 2f0d52e46b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
CONTRIBUTING.md
View File

@ -321,13 +321,16 @@ those containers you will want to set them yourself.
To add a dependency, add the import statement to your .go file, then run To add a dependency, add the import statement to your .go file, then run
`go build` on it. This will automatically add the dependency to go.mod. Next, `go build` on it. This will automatically add the dependency to go.mod. Next,
run `go mod vendor` to save a copy in the vendor folder. run `go mod vendor && git add vendor/` to save a copy in the vendor folder.
When vendorizing dependencies, it's important to make sure tests pass on the When vendorizing dependencies, it's important to make sure tests pass on the
version you are vendorizing. Currently we enforce this by requiring that pull version you are vendorizing. Currently we enforce this by requiring that pull
requests containing a dependency update include a comment indicating that you requests containing a dependency update to any version other than a tagged
ran the tests and that they succeeded, preferably with the command line you release include a comment indicating that you ran the tests and that they
run them with. succeeded, preferably with the command line you run them with. Note that you
may have to get a separate checkout of the dependency (using `go get` outside
of the boulder repository) in order to run its tests, as some vendored
modules do not bring their tests with them.
## Updating Dependencies ## Updating Dependencies
@ -335,8 +338,12 @@ To upgrade a dependency, [see the Go
docs](https://github.com/golang/go/wiki/Modules#how-to-upgrade-and-downgrade-dependencies). docs](https://github.com/golang/go/wiki/Modules#how-to-upgrade-and-downgrade-dependencies).
Typically you want `go get <dependency>` rather than `go get -u Typically you want `go get <dependency>` rather than `go get -u
<dependency>`, which can introduce a lot of unexpected updates. After running <dependency>`, which can introduce a lot of unexpected updates. After running
`go get`, make sure to run `go mod vendor` to update the vendor directory. If `go get`, make sure to run `go mod vendor && git add vendor/` to update the
you forget, Travis tests will catch this. vendor directory. If you forget, Travis tests will catch this.
If you are updating a dependency to a version which is not a tagged release,
see the note above about how to run all of a dependency's tests and note that
you have done so in the PR.
Note that updating dependencies can introduce new, transitive dependencies. In Note that updating dependencies can introduce new, transitive dependencies. In
general we try to keep our dependencies as narrow as possible in order to general we try to keep our dependencies as narrow as possible in order to