diff options
| author | Karl Isenberg <karl@mesosphere.io> | 2015-12-08 13:23:59 -0800 |
|---|---|---|
| committer | Karl Isenberg <karl@mesosphere.io> | 2016-01-14 09:05:25 -0800 |
| commit | a32d464cc1b97a0ead97d83d541929679dc949fa (patch) | |
| tree | b58f0f41373ea447d1accf243836fbf2d038c09d /development.md | |
| parent | 629e14cd12f0568c4316f1948d41eb064215dc99 (diff) | |
Add hack/update-godep-licenses.sh to generate Godeps/LICENSES.md
- Add Godeps/LICENSES.md
- Add verify-godep-licenses to verify that Godeps/LICENSES.md is up to date
- Trigger verify-godep-licenses in the pre-commit hook only if the Godeps dir has changed
- Exclude verify-godep-licenses in verify-all
- Add verify-godep-licenses to make verify (used by travis)
- Add verify-godep-licenses to shippable
- Update dev docs to mention update-godep-licenses
Diffstat (limited to 'development.md')
| -rw-r--r-- | development.md | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/development.md b/development.md index 27ce1b8a..95dccaa9 100644 --- a/development.md +++ b/development.md @@ -219,7 +219,7 @@ _If `go get -u path/to/dependency` fails with compilation errors, instead try `g to fetch the dependencies without compiling them. This can happen when updating the cadvisor dependency._ -5) Before sending your PR, it's a good idea to sanity check that your Godeps.json file is ok by running hack/verify-godeps.sh +5) Before sending your PR, it's a good idea to sanity check that your Godeps.json file is ok by running `hack/verify-godeps.sh` _If hack/verify-godeps.sh fails after a `godep update`, it is possible that a transitive dependency was added or removed but not updated by godeps. It then may be necessary to perform a `godep save ./...` to pick up the transitive dependency changes._ @@ -228,6 +228,10 @@ It is sometimes expedient to manually fix the /Godeps/godeps.json file to minimi Please send dependency updates in separate commits within your PR, for easier reviewing. +6) If you updated the Godeps, please also update `Godeps/LICENSES.md` by running `hack/update-godep-licenses.sh`. + +_If Godep does not automatically vendor the proper license file for a new dependency, be sure to add an exception entry to `hack/update-godep-licenses.sh`._ + ## Unit tests ```sh |