Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: create v1beta2 gov proto types #10589

Merged
merged 1 commit into from
Nov 22, 2021
Merged

feat: create v1beta2 gov proto types #10589

merged 1 commit into from
Nov 22, 2021

Conversation

cmwaters
Copy link
Contributor

Description

Ref: #9810

Bumps gov proto files to v1beta2 and creates new Proposal type


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title
  • added ! to the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • followed the guidelines for building modules
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • reviewed "Files changed" and left comments if necessary
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

Copy link
Member

@aaronc aaronc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great now let's change the go package of the v1beta1 types to types/v1beta and generate those as well. So we basically have the two API versions side by side.

@cmwaters cmwaters requested a review from aaronc November 22, 2021 14:16
@cmwaters cmwaters changed the title !feat: create v1beta2 gov proto types feat: create v1beta2 gov proto types Nov 22, 2021
@cmwaters
Copy link
Contributor Author

cmwaters commented Nov 22, 2021

@aaronc did you also want to have v1beta2 in its own types subdirectory or just v1beta1? This also messes with a lot of the imports

import "gogoproto/gogo.proto";
import "cosmos/gov/v1beta2/gov.proto";

option go_package = "github.com/cosmos/cosmos-sdk/x/gov/types";
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the pattern that the latest version is just used as /types with no version in the package?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is what I've defaulted to doing but also a question I had myself

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well I don't actually think we have a good pattern right now. I proposed a pattern here which just uses the proto package as the go package more or less: #10582. But that's a bigger refactoring. And for now this seems the most logical and least intrusive. But open to other suggestions

@aaronc aaronc added the A:automerge Automatically merge PR once all prerequisites pass. label Nov 22, 2021
@cmwaters
Copy link
Contributor Author

@aaronc I decided to revert the proto generation changes. I would have spent all day trying to get all the imports to work and it would basically end up looking mostly like the original PR

@mergify mergify bot merged commit ed01c21 into master Nov 22, 2021
@mergify mergify bot deleted the callum/gov-proto branch November 22, 2021 16:40
@tac0turtle
Copy link
Member

I think we have to revert this pr on master as its blocking people from generating new Proto files.

tac0turtle added a commit that referenced this pull request Nov 26, 2021
blewater pushed a commit to e-money/cosmos-sdk that referenced this pull request Dec 8, 2021
## Description

Ref: cosmos#9810

Bumps gov proto files to v1beta2 and creates new `Proposal` type

---

### Author Checklist

*All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.*

I have...

- [ ] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [ ] added `!` to the type prefix if API or client breaking change
- [ ] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting))
- [ ] provided a link to the relevant issue or specification
- [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules)
- [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing)
- [ ] added a changelog entry to `CHANGELOG.md`
- [ ] included comments for [documenting Go code](https://blog.golang.org/godoc)
- [ ] updated the relevant documentation or specification
- [ ] reviewed "Files changed" and left comments if necessary
- [ ] confirmed all CI checks have passed

### Reviewers Checklist

*All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.*

I have...

- [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [ ] confirmed `!` in the type prefix if API or client breaking change
- [ ] confirmed all author checklist items have been addressed 
- [ ] reviewed state machine logic
- [ ] reviewed API design and naming
- [ ] reviewed documentation is accurate
- [ ] reviewed tests and test coverage
- [ ] manually tested (if applicable)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A:automerge Automatically merge PR once all prerequisites pass.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants