Mirroristas/etcd
2
0
Fork 0
mirror of https://github.com/etcd-io/etcd.git synced 2024-09-27 06:25:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add genproto error troubleshoot step for manual bumps

Browse Source 
This commit will add the troubleshooting step in case of `genproto`
errors while performing manual dependency bumps of `grpc-*`

Signed-off-by: ArkaSaha30 <arkasaha30@gmail.com>
Co-authored-by: Benjamin Wang <benjamin.wang@broadcom.com>
Co-authored-by: James Blair <mail@jamesblair.net>
This commit is contained in:
ArkaSaha30
2024-08-12 14:59:31 +05:30
parent 00a609751a
commit 58ec6b2bdb
1 changed files with 15 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
Documentation/contributor-guide/dependency_management.md
View File

@@ -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`.