github/paralus
1
0
Fork 0
mirror of https://github.com/paralus/paralus.git synced 2026-05-08 17:36:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #35 from paralus/doc-proto

Browse Source 
Update contributing guide for regenerating proto files
This commit is contained in:
Abin Simon
2022-07-07 13:05:10 +05:30
committed by GitHub
parent daa3c065ec aa120cd87e
commit 2bbdf16424
1 changed files with 9 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
CONTRIBUTING.md
View File

@@ -140,13 +140,15 @@ go run github.com/paralus/paralus
#### Updating Proto Files?
If you're making changes to any of the proto files, you'll have to perform the following steps:
- `make build` - build binary artifacts.
- `make test` - run all tests.
- `make check` - perform check like fmt and vet.
- `make clean` - clean all binary artifacts.
- `make build-proto` - rebuild all proto files.
- Make sure you have `[buf](https://github.com/bufbuild/buf)` installed
- Install dependencies:
```
go install github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-grpc-gateway@latest
go install github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-openapiv2@latest
go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest
```
- Run `make build-proto` to regenerate proto artifacts
## Need Help?