From 58ec6b2bdb5101b46db8b2b797836aa285f24b99 Mon Sep 17 00:00:00 2001 From: ArkaSaha30 Date: Mon, 12 Aug 2024 14:59:31 +0530 Subject: [PATCH] Add `genproto` error troubleshoot step for manual bumps This commit will add the troubleshooting step in case of `genproto` errors while performing manual dependency bumps of `grpc-*` Signed-off-by: ArkaSaha30 Co-authored-by: Benjamin Wang Co-authored-by: James Blair --- .../contributor-guide/dependency_management.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/Documentation/contributor-guide/dependency_management.md b/Documentation/contributor-guide/dependency_management.md index 8c5ce4cbb3a7..9b648b89e3d2 100644 --- a/Documentation/contributor-guide/dependency_management.md +++ b/Documentation/contributor-guide/dependency_management.md @@ -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 + +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 +[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`.