Skip to content

Commit

Permalink
Added a README in protoregistry folder
Browse files Browse the repository at this point in the history
  • Loading branch information
maoueh committed Jan 19, 2024
1 parent dc641a3 commit d466a71
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions protoregistry/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
### Protobuf Registry

The well-known Protobuf definitions are pulled from Buf Build Registry. This makes `firehose-core` able to decode some well-known block files directly.

#### Re-generate

To re-generate the well-known types, simply do:

```bash
go generate ./protoregistry
```

While being at the root of the **project** (if you run from this directory here, adjust `./protoregistry` to `.`). Before re-generating, ensure you have push to Buf Registry the latest version of the definitions.

#### Add new well-known types

Push your definitions to the Buf Registry. Edit file [./generator/generator.go](./generator/generator.go) and add the Buf Registry path of the package in `wellKnownProtoRepos` variables.

Then [re-generate Protobuf definitions](#re-generate) and send a PR with the changes.

0 comments on commit d466a71

Please sign in to comment.