Skip to content

Commit

Permalink
docs: set buf commit for v0.47.x (#14675)
Browse files Browse the repository at this point in the history
  • Loading branch information
julienrbrt authored Jan 20, 2023
1 parent b73462f commit c8f2f1d
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 7 deletions.
2 changes: 2 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -187,13 +187,15 @@ 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)
* Configure SonarCloud
* 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

Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
4 changes: 3 additions & 1 deletion UPGRADING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
11 changes: 6 additions & 5 deletions proto/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 | |

0 comments on commit c8f2f1d

Please sign in to comment.