From c8f2f1d5949b0f96e5302af3ad8cbfff242a0448 Mon Sep 17 00:00:00 2001 From: Julien Robert Date: Fri, 20 Jan 2023 13:43:53 +0100 Subject: [PATCH] docs: set buf commit for v0.47.x (#14675) --- CONTRIBUTING.md | 2 ++ Makefile | 2 +- UPGRADING.md | 4 +++- proto/README.md | 11 ++++++----- 4 files changed, 12 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 19ac50f6835..f52b1afc0cb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -187,6 +187,7 @@ For consistency between our CI and the local tests, `GOWORK=off` is set in the ` When extracting a package to its own go modules, some extra steps are required, for keeping our CI checks and Dev UX: * Add a CHANGELOG.md / README.md under the new package folder +* Add the package in [`labeler.yml`](./.github/labeler.yml) * Add the package in [`go.work.example`](./go.work.example) * Add weekly dependabot checks (see [dependabot.yml](./.github/dependabot.yml)) * Add tests to github workflow [test.yml](.github/workflows/test.yml) (under submodules) @@ -194,6 +195,7 @@ When extracting a package to its own go modules, some extra steps are required, * Add `sonar-projects.properties` (see math [sonar-projects.properties](./math/sonar-projects.properties) for example) * Add a GitHub Workflow entry for running the scans (see [test.yml](.github/workflows/test.yml)) * Ask the team to add the project to SonarCloud +* (optional) Configure a `cosmossdk.io` vanity url by submitting a PR to [cosmos/vanity](https://github.com/cosmos/vanity). ## Protobuf diff --git a/Makefile b/Makefile index 8831a339c9a..a6782ebddb0 100644 --- a/Makefile +++ b/Makefile @@ -395,7 +395,7 @@ devdoc-update: ### Protobuf ### ############################################################################### -protoVer=0.11.4 +protoVer=0.11.5 protoImageName=ghcr.io/cosmos/proto-builder:$(protoVer) protoImage=$(DOCKER) run --rm -v $(CURDIR):/workspace --workdir /workspace $(protoImageName) diff --git a/UPGRADING.md b/UPGRADING.md index 714b73f4b76..b8c0a995504 100644 --- a/UPGRADING.md +++ b/UPGRADING.md @@ -102,7 +102,9 @@ The SDK has migrated from `gogo/protobuf` (which is currently unmaintained), to This means you should replace all imports of `github.com/gogo/protobuf` to `github.com/cosmos/gogoproto`. 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. -Please use the `ghcr.io/cosmos/proto-builder` image (version >= `0.11.0`) for generating protobuf files. +Please use the `ghcr.io/cosmos/proto-builder` image (version >= `0.11.5`) for generating protobuf files. + +See which buf commit for `cosmos/cosmos-sdk` to pin in your `buf.yaml` file [here](./proto/README.md) #### `{accepts,implements}_interface` proto annotations diff --git a/proto/README.md b/proto/README.md index 49ee9509980..ae9374762d5 100644 --- a/proto/README.md +++ b/proto/README.md @@ -10,8 +10,9 @@ https://docs.buf.build/bsr/documentation. ## SDK x Buf -| Cosmos SDK Version | Buf Commit Version | -| ------------------ | ---------------------------------------------------------- | -| Prior v0.46.0 | [Unavailable](https://github.com/bufbuild/buf/issues/1415) | -| v0.46.x | 8cb30a2c4de74dc9bd8d260b1e75e176 | -| v0.47.x | | +| Cosmos SDK Version | Buf Commit Version | +| ------------------ | ------------------------------------------------------------------------------------------------------------- | +| Prior v0.46.0 | [Unavailable](https://github.com/bufbuild/buf/issues/1415) | +| v0.46.x | [8cb30a2c4de74dc9bd8d260b1e75e176](https://buf.build/cosmos/cosmos-sdk/docs/8cb30a2c4de74dc9bd8d260b1e75e176) | +| v0.47.x | [8c515ebc07ee4514aabcaf3a584a1d1a](https://buf.build/cosmos/cosmos-sdk/docs/8c515ebc07ee4514aabcaf3a584a1d1a) | +| v0.48.x | |