Skip to content

Update protobuffer usage guide #229

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

Open
vipulsodha wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Update protobuffer usage guide #229

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
78cdaf3
Add protoc-gen-orion usage into readme
cs-lexliu Sep 27, 2022
7cb229f
update documentation
vipulsodha Mar 19, 2024
3e3cad9
remove old generation
vipulsodha Mar 19, 2024
bd95c95
remove old doc
vipulsodha Mar 19, 2024
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
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,23 @@ install the protoc plugin for orion
go get -u github.com/carousell/Orion/protoc-gen-orion
```

## Protobuffer Generation

### Usage

#### Working with `protocgen` generation tool (shared-proto).
Protogen generation tool is used for generating protobuffer for services using `shared-proto` repository.
It helps in generating protobuffer within the service itself.
Please refer to this [link](https://carousell.atlassian.net/wiki/spaces/RFC/pages/434471178/How+to+onboard+your+service+to+protogen) for more details.

**This tool is only used for services using `shared-proto` repository.**

#### Working with `<bu>-proto-gen-go` generation tool (service-proto).
`<bu>-proto-gen-go` generation tool is used for generating protobuffer for services using `<bu>-proto` repository.
This tool automatically generates the protobuffer for the service and also generates the go mod to be imported for the
generated protobuffers.
Please refer to this [link](https://carousell.atlassian.net/wiki/spaces/CTF/pages/2216689780/Protobuffer+Management+Guide) for more details.

## Project Status
Orion is in use at production at Carousell and powers multiple (100+) services serving thousands of requests per second,
we ensure all updates are backward compatible unless it involves a major bug or security issue.
Expand Down