Skip to content

Commit

Permalink
chore: update required version for buf tool
Browse files Browse the repository at this point in the history
The `buf` cli made a breaking change in `v1.32` [sic, 0], so we must
update the script invocations to keep it working. Touched up the docs
where appropriate, and ran the recommended `buf config migrate` cmd [1]
to get the files in sync with the new format. After rerunning `just
proto` on the migrated files, I see no changes.

[0] https://github.com/bufbuild/buf/releases/tag/v1.32.0
[1] https://buf.build/docs/migration-guides/migrate-v2-config-files

Co-authored-by: Conor Schaefer <[email protected]>
  • Loading branch information
TalDerei and conorsch committed Jun 20, 2024
1 parent 07cab47 commit b6ce49a
Show file tree
Hide file tree
Showing 9 changed files with 54 additions and 65 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/buf-pull-request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,10 @@ jobs:
shell: bash
run: |
cd proto/penumbra
buf mod update
buf dep update
s="$(git status --porcelain)"
if [[ -n "$s" ]]; then
echo "ERROR: run 'buf mod update' to synchronize buf.lock"
echo "ERROR: run 'buf dep update' to synchronize buf.lock"
echo "$s"
exit 1
else
Expand Down
2 changes: 1 addition & 1 deletion deployments/scripts/protobuf-codegen
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ done
echo "Pulling proto dependencies from BSR..."
pushd "${repo_root}/proto/"
# Make sure the lockfile is up to date.
buf mod update penumbra
buf dep update penumbra

# Pull our vendored cosmos/IBC proto defs so we can get reflection for service definitions.
# The penumbra dependencies will override some of these.
Expand Down
4 changes: 2 additions & 2 deletions docs/guide/src/dev/protobuf.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ The `buf` tool is required to update lockfiles used for version management in
the [Buf Schema Registry](https://buf.build/penumbra-zone/penumbra). Visit
the [buf download page](https://buf.build/docs/installation/) to obtain a version.
After installing, run `buf --version` and confirm you're running at least
`1.27.0` (or newer).
`1.32.0` (or newer).

## Building protos

Expand All @@ -62,7 +62,7 @@ We should review these deps periodically and bump them, as we would any other de
```shell
cd proto/penumbra
# edit buf.yaml to remove the tags, i.e. suffix `:<tag>`
buf mod update
buf dep update
```

Then commit and PR in the results.
Expand Down
14 changes: 8 additions & 6 deletions proto/buf.gen.yaml
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
version: v1
version: v2
managed:
enabled: true
go_package_prefix:
default: github.com/penumbra-zone/penumbra/proto/go/gen
except:
- buf.build/cosmos/ibc
disable:
- file_option: go_package
module: buf.build/cosmos/ibc
override:
- file_option: go_package_prefix
value: github.com/penumbra-zone/penumbra/proto/go/gen
plugins:
- plugin: buf.build/protocolbuffers/go
- remote: buf.build/protocolbuffers/go
out: go/gen
opt: paths=source_relative
21 changes: 21 additions & 0 deletions proto/buf.lock
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Generated by buf. DO NOT EDIT.
version: v2
deps:
- name: buf.build/cosmos/cosmos-proto
commit: 1935555c206d4afb9e94615dfd0fad31
digest: b5:0a29584117fe6433fa593d03fbda6b3964ddc59b986cd2277833ee01d4ac215a14b0286241462cd0dee6b460a108823dff5c7c42c9c1f4f7df861fcfa4bbebdf
- name: buf.build/cosmos/cosmos-sdk
commit: e7a85cef453e4b999ad9aff8714ae05f
digest: b5:78173376f272d38369c9e503118643f068b44a4f48c268a4a4e7af5a35807364ba52397ff5ed72e1ce18042df0d7cd757e7f862d429ccb844bd8bd7f8d0ab72b
- name: buf.build/cosmos/gogo-proto
commit: 34d970b699f84aa382f3c29773a60836
digest: b5:15d77a039fd9ab81ffb28ce9601eeb687840474dd11cf645341d50c1bba7f70b01acdf0e9781d09d42d0e4bcb720eac96451827b6cf24146e2a6b2bb3d65a96c
- name: buf.build/cosmos/ibc
commit: 7ab44ae956a0488ea04e04511efa5f70
digest: b5:17407a9bf53b990c5d362bc9bd357931aeb8516c1393b1de79823e09bcecc3c8217e0546d5be897599da6a60499bdda1bcf950eca6c4bad4209b98c937e725f1
- name: buf.build/cosmos/ics23
commit: 55085f7c710a45f58fa09947208eb70b
digest: b5:ab3cb4080c6974b1dd378d3e5602ae86ab7396dff1f4f25c5298c9827519ef0329e4be0e4f5f2d8cf61b1925f0c627cdfcf64955414c453036be05cab56994f0
- name: buf.build/googleapis/googleapis
commit: 75b4300737fb4efca0831636be94e517
digest: b5:d227a018d00bd477f62a1b3f394c87c142f7429b8bf046f7d5e6a1bb3d0e5293a96491d50825983683c295f038cdace614d258a083baa5f766985c9e618c5d2a
3 changes: 0 additions & 3 deletions proto/buf.work.yaml

This file was deleted.

20 changes: 20 additions & 0 deletions proto/buf.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
version: v2
modules:
- path: penumbra
name: buf.build/penumbra-zone/penumbra
deps:
- buf.build/cosmos/cosmos-sdk:e7a85cef453e4b999ad9aff8714ae05f
- buf.build/cosmos/ibc:7ab44ae956a0488ea04e04511efa5f70
lint:
use:
- DEFAULT
except:
- FIELD_NOT_REQUIRED
- PACKAGE_NO_IMPORT_CYCLE
disallow_comment_ignores: true
breaking:
use:
- FILE
except:
- EXTENSION_NO_DELETE
- FIELD_SAME_DEFAULT
33 changes: 0 additions & 33 deletions proto/penumbra/buf.lock

This file was deleted.

18 changes: 0 additions & 18 deletions proto/penumbra/buf.yaml

This file was deleted.

0 comments on commit b6ce49a

Please sign in to comment.