Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add genproto error troubleshoot step for manual bumps #18431

Merged
merged 1 commit into from
Aug 12, 2024
Merged

Add genproto error troubleshoot step for manual bumps #18431

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions Documentation/contributor-guide/dependency_management.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,21 @@ Please close the related PRs which were automatically opened by dependabot.
When you bump multiple dependencies in one PR, it's recommended to create a separate commit for each dependency. But it isn't a must; for example,
you can get all dependencies bumping for the module `go.etcd.io/etcd/tools/v3` included in one commit.

#### Troubleshooting
ArkaSaha30 marked this conversation as resolved.
Show resolved Hide resolved

In an event of bumping the version of protoc, protoc plugins or grpc-gateway, it might change `*.proto` file which can result in the following error:

```bash
ArkaSaha30 marked this conversation as resolved.
Show resolved Hide resolved
[0;31mFAIL: 'genproto' FAILED at Wed Jul 31 07:09:08 UTC 2024
make: *** [Makefile:134: verify-genproto] Error 255


To fix the above error, run the following script from the root of etcd repository:

```bash
./scripts/genproto.sh
```

### Indirect dependencies

Usually, we don't bump a dependency if all modules just indirectly depend on it, such as `github.com/go-logr/logr`.
Expand Down
Loading