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

chore: rename snapshot proto package #14597

Merged
merged 11 commits into from
Jan 16, 2023
Merged

chore: rename snapshot proto package #14597

merged 11 commits into from
Jan 16, 2023

Conversation

julienrbrt
Copy link
Member

@julienrbrt julienrbrt commented Jan 12, 2023

Description

See #14591 (comment)
As per #14597 (comment) this PR renames the package to v1 but not re-add the fields compared to #14608 (on release/v0.47.x)


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)

@julienrbrt julienrbrt added the backport/v0.47.x PR scheduled for inclusion in the v0.47's next stable release label Jan 12, 2023
@julienrbrt
Copy link
Member Author

julienrbrt commented Jan 12, 2023

One thing actually, we've changed the package name in 0.48 vs <= 0.47 (3222be3).
So it will be proto breaking anyway in v0.48 I think.

@julienrbrt julienrbrt changed the title chore: deprecated unused field instead of removing them chore: deprecate unused messages instead of removing them Jan 12, 2023
@amaury1093
Copy link
Contributor

amaury1093 commented Jan 12, 2023

One thing actually, we've changed the package name in 0.48 vs <= 0.47 (3222be3).
So it will be proto breaking anyway in v0.48 I think.

Oh, if we changed package names, then we can remove fields freely in the newly-named package. It's not actually a rename, but basically leaving the old one cosmos.base.snapshots.v1beta1 as-is (it's on buf anyways), and creating a new one cosmos.base.store.snapshots.v1beta1. So we're free to do anything in the new one.

Also, maybe we can use v1 for the new one?

@julienrbrt julienrbrt changed the base branch from main to release/v0.47.x January 12, 2023 21:13
@julienrbrt julienrbrt changed the base branch from release/v0.47.x to main January 12, 2023 21:14
@julienrbrt
Copy link
Member Author

julienrbrt commented Jan 12, 2023

One thing actually, we've changed the package name in 0.48 vs <= 0.47 (3222be3).
So it will be proto breaking anyway in v0.48 I think.

Oh, if we changed package names, then we can remove fields freely in the newly-named package. It's not actually a rename, but basically leaving the old one cosmos.base.snapshots.v1beta1 as-is (it's on buf anyways), and creating a new one cosmos.base.store.snapshots.v1beta1. So we're free to do anything in the new one.

Also, maybe we can use v1 for the new one?

Okay, so I am not re-adding it here, but only rename it to v1 and in v0.47 (where it is not yet renamed, I can add it as deprecated if that is what is wanted)

@julienrbrt julienrbrt changed the title chore: deprecate unused messages instead of removing them chore: rename snapshot proto package Jan 12, 2023
@julienrbrt julienrbrt removed the backport/v0.47.x PR scheduled for inclusion in the v0.47's next stable release label Jan 13, 2023
@julienrbrt julienrbrt marked this pull request as ready for review January 13, 2023 01:21
@julienrbrt julienrbrt requested a review from a team as a code owner January 13, 2023 01:21
CHANGELOG.md Outdated
@@ -154,6 +154,7 @@ Ref: https://keepachangelog.com/en/1.0.0/

### API Breaking Changes

* (snapshots) [#14597](https://github.com/cosmos/cosmos-sdk/pull/14597) Move `snapshots` to `store/snapshots` and rename bump proto package to v1.
Copy link
Member Author

@julienrbrt julienrbrt Jan 13, 2023

Choose a reason for hiding this comment

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

We had no changelog for the package moving (I am noticing that we mostly forgot to add a changelog for all store refactors). Precising the renaming as well.

@julienrbrt julienrbrt force-pushed the julien/snapshots branch 2 times, most recently from ff2aae2 to c8e055e Compare January 13, 2023 12:15
Copy link
Member

@tac0turtle tac0turtle left a comment

Choose a reason for hiding this comment

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

do we want to keep the old one around?

@julienrbrt
Copy link
Member Author

do we want to keep the old one around?

Don't think it's necessary as it isn't used.

@julienrbrt julienrbrt enabled auto-merge (squash) January 16, 2023 11:56
@julienrbrt julienrbrt merged commit ae1c29b into main Jan 16, 2023
@julienrbrt julienrbrt deleted the julien/snapshots branch January 16, 2023 12:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants