Skip to content

Commit

Permalink
Update vendoring in CONTRIBUTING (#2945)
Browse files Browse the repository at this point in the history
I'll mirror to TPGB on approval
  • Loading branch information
rileykarson authored Jan 28, 2019
1 parent 661cf81 commit 33628a5
Showing 1 changed file with 2 additions and 15 deletions.
17 changes: 2 additions & 15 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,22 +22,9 @@ Fields that are only available in beta versions of the Google Cloud Platform API

## Vendoring Libraries

When adding support for just-released GCP features, you'll often need to vendor a new version of the Google API client and
occasionally some of the downstream dependencies of that client. The Google Provider uses [govendor](https://github.com/kardianos/govendor)
in order to manage dependencies. To vendor a new package or update an existing package, run:
When adding support for just-released GCP features, you'll often need to vendor a new version of the Google API client. The Google provider uses Go Modules; use `GO111MODULES=on go get {{dependency}}`, and the new dependencies will be included in your PR.

```bash
govendor fetch {{path}}
```

For example:

```bash
govendor fetch google.golang.org/api/compute/v1
```

When updating a vendored library, try to submit the vendoring as a separate pull request and include the commands you ran in
the pull request description.
If you're developing against Magic Modules, vendoring changes is done automatically by the Magician at PR time; you may need to `go get` locally, but those changes don't need to be included in your PR.

## Tests

Expand Down

0 comments on commit 33628a5

Please sign in to comment.