Skip to content

Commit 504acae

Browse files
docs: set buf commit for v0.47.x (backport #14675) (#14711)
Co-authored-by: Julien Robert <julien@rbrt.fr>
1 parent c3b8933 commit 504acae

File tree

4 files changed

+11
-7
lines changed

4 files changed

+11
-7
lines changed

CONTRIBUTING.md

+2
Original file line numberDiff line numberDiff line change
@@ -187,13 +187,15 @@ For consistency between our CI and the local tests, `GOWORK=off` is set in the `
187187
When extracting a package to its own go modules, some extra steps are required, for keeping our CI checks and Dev UX:
188188

189189
* Add a CHANGELOG.md / README.md under the new package folder
190+
* Add the package in [`labeler.yml`](./.github/labeler.yml)
190191
* Add the package in [`go.work.example`](./go.work.example)
191192
* Add weekly dependabot checks (see [dependabot.yml](./.github/dependabot.yml))
192193
* Add tests to github workflow [test.yml](.github/workflows/test.yml) (under submodules)
193194
* Configure SonarCloud
194195
* Add `sonar-projects.properties` (see math [sonar-projects.properties](./math/sonar-projects.properties) for example)
195196
* Add a GitHub Workflow entry for running the scans (see [test.yml](.github/workflows/test.yml))
196197
* Ask the team to add the project to SonarCloud
198+
* (optional) Configure a `cosmossdk.io` vanity url by submitting a PR to [cosmos/vanity](https://github.com/cosmos/vanity).
197199

198200
## Protobuf
199201

Makefile

+1-1
Original file line numberDiff line numberDiff line change
@@ -408,7 +408,7 @@ devdoc-update:
408408
### Protobuf ###
409409
###############################################################################
410410

411-
protoVer=0.11.2
411+
protoVer=0.11.5
412412
protoImageName=ghcr.io/cosmos/proto-builder:$(protoVer)
413413
protoImage=$(DOCKER) run --rm -v $(CURDIR):/workspace --workdir /workspace $(protoImageName)
414414

UPGRADING.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,9 @@ The SDK has migrated from `gogo/protobuf` (which is currently unmaintained), to
7272
This means you should replace all imports of `github.com/gogo/protobuf` to `github.com/cosmos/gogoproto`.
7373
This allows you to remove the replace directive `replace github.com/gogo/protobuf => github.com/regen-network/protobuf v1.3.3-alpha.regen.1` from your `go.mod` file.
7474

75-
Please use the `ghcr.io/cosmos/proto-builder` image (version >= `0.11.2`) for generating protobuf files.
75+
Please use the `ghcr.io/cosmos/proto-builder` image (version >= `0.11.5`) for generating protobuf files.
76+
77+
See which buf commit for `cosmos/cosmos-sdk` to pin in your `buf.yaml` file [here](./proto/README.md).
7678

7779
#### `{accepts,implements}_interface` proto annotations
7880

proto/README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ https://docs.buf.build/bsr/documentation.
1010

1111
## SDK x Buf
1212

13-
| Cosmos SDK Version | Buf Commit Version |
14-
| ------------------ | ---------------------------------------------------------- |
15-
| Prior v0.46.0 | [Unavailable](https://github.com/bufbuild/buf/issues/1415) |
16-
| v0.46.x | 8cb30a2c4de74dc9bd8d260b1e75e176 |
17-
| v0.47.x | |
13+
| Cosmos SDK Version | Buf Commit Version |
14+
| ------------------ | ------------------------------------------------------------------------------------------------------------- |
15+
| Prior v0.46.0 | [Unavailable](https://github.com/bufbuild/buf/issues/1415) |
16+
| v0.46.x | [8cb30a2c4de74dc9bd8d260b1e75e176](https://buf.build/cosmos/cosmos-sdk/docs/8cb30a2c4de74dc9bd8d260b1e75e176) |
17+
| v0.47.x | [8c515ebc07ee4514aabcaf3a584a1d1a](https://buf.build/cosmos/cosmos-sdk/docs/8c515ebc07ee4514aabcaf3a584a1d1a) |

0 commit comments

Comments
 (0)