Vendoring Go dependencies ¶
kOps uses go mod to manage vendored dependencies.
Prerequisites ¶
The following software must be installed prior to running the update commands:
Adding a dependency to the vendor directory ¶
Go modules will manage required dependencies based on the imports found in the source code. Follow these steps to run the update process:
- Add the desired import to a
.go
file. - Run
make gomod
to start the update process. If this step is successful, the imported dependency will be added to thevendor
subdirectory. - Commit any changes, including changes to the
vendor
directory,go.mod
, andgo.sum
. - Open a pull request with these changes separately from other work so that it is easier to review.
Updating a dependency in the vendor directory (e.g. aws-sdk-go) ¶
- Update the locked version as specified in
go.mod
- Run
make gomod
. - Review the changes to ensure that they are as intended / trustworthy.
- Commit any changes, including changes to the
vendor
directory,go.mod
andgo.sum
. - Open a pull request with these changes separately from other work so that it is easier to review. Please include any significant changes you observed.