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

docs: add protobuf codegen instructions to the README #180

Merged
merged 1 commit into from
Dec 10, 2024
Merged

docs: add protobuf codegen instructions to the README #180

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
24 changes: 24 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,27 @@ Releases indicate changes to the repository itself. API versions are defined wit

We provide generated code to allow developers to focus on features rather than stub generation:
- [Go](./go)
- [TS](./ts)

## How to run protobuf codegen

If there is a need to run regenerate protobuf (in case of API or documentation changes):

1. Install [direnv](https://direnv.net) and hook it to the [shell](https://direnv.net/docs/hook.html)
- **MacOS**
```shell
brew install make direnv
```
2. Allow direnv within project
```shell
direnv allow
```

3. Run codegen. This will
- Install all required tools into local cache
- generate changes for both `Go` and `TS` packages.

```shell
make proto-gen
```

Loading