Skip to content

Commit

Permalink
docs: add protobuf codegen instructions to the README (#180)
Browse files Browse the repository at this point in the history
Signed-off-by: Artur Troian <[email protected]>
  • Loading branch information
troian authored Dec 10, 2024
1 parent 5b29114 commit 15b9893
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions README.md
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
```

0 comments on commit 15b9893

Please sign in to comment.