-
Notifications
You must be signed in to change notification settings - Fork 41
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
Mark v1.20.0-rc1. #2180
Mark v1.20.0-rc1. #2180
Conversation
* Fix sed command in prep-release that was causing minor version validation to fail. * At the end of prep-release, if it was a release candidate, copy the summary back into unrleased. * Reformat the go bump dependency entries to match the others. * Add a period messing from one of the changelog entries. * Update the version in the require entry for the sdk to match the version that the replace line is based on. * Mark v1.20.0-rc1.
WalkthroughThe changes in this pull request involve multiple updates to the codebase, including enhancements to the Changes
Possibly related issues
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
CHANGELOG.md (1)
Line range hint
1-1938
: Overall CHANGELOG.md structure and consistencyThe CHANGELOG.md file maintains a good structure with separate sections for each release, including features, improvements, bug fixes, and breaking changes. This format is consistent throughout the file, which is excellent for readability and tracking changes over time.
To further improve the changelog:
- Consider adding a table of contents at the beginning for easier navigation, especially as the file grows.
- Ensure that all links to issues and pull requests are functioning correctly.
- Maintain consistent formatting for version headers and section titles across all entries.
Consider adding a table of contents at the beginning of the CHANGELOG.md file to improve navigation, especially for users looking for specific versions or changes.
🧰 Tools
🪛 Markdownlint
181-181: null
Bare URL used(MD034, no-bare-urls)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (59)
- .changelog/prep-release.sh (2 hunks)
- .changelog/unreleased/api-breaking/2137-bank-scope-value-owners.md (0 hunks)
- .changelog/unreleased/api-breaking/2176-delete-params.md (0 hunks)
- .changelog/unreleased/bug-fixes/2110-marker-feegrant-fix.md (0 hunks)
- .changelog/unreleased/bug-fixes/2135-openapiv2.md (0 hunks)
- .changelog/unreleased/bug-fixes/2144-remove-metadata-count-telemetry.md (0 hunks)
- .changelog/unreleased/bug-fixes/2177-add-store-telemetry.md (0 hunks)
- .changelog/unreleased/bug-fixes/376-fix-markdown-gen.md (0 hunks)
- .changelog/unreleased/client-breaking/2119-remove-deprecated-bindings.md (0 hunks)
- .changelog/unreleased/client-breaking/2153-keccak.md (0 hunks)
- .changelog/unreleased/client-breaking/2158-fix-metadata-nav-example.md (0 hunks)
- .changelog/unreleased/dependencies/2100-cosmossdk-io-client-v2-2-0-0-beta-4.md (0 hunks)
- .changelog/unreleased/dependencies/2107-cosmossdk-io-core-0-11-1.md (0 hunks)
- .changelog/unreleased/dependencies/2113-cosmossdk-io-x-tx-0-13-4.md (0 hunks)
- .changelog/unreleased/dependencies/2114-github-com-spf13-cast-1-7-0.md (0 hunks)
- .changelog/unreleased/dependencies/2115-golang-org-x-text-0-17-0.md (0 hunks)
- .changelog/unreleased/dependencies/2116-cosmossdk-io-log-1-4-0.md (0 hunks)
- .changelog/unreleased/dependencies/2120-github-com-cometbft-cometbft-0-38-11.md (0 hunks)
- .changelog/unreleased/dependencies/2122-bufbuild-buf-setup-action-1-36-0.md (0 hunks)
- .changelog/unreleased/dependencies/2125-github-com-cosmos-gogoproto-1-7-0.md (0 hunks)
- .changelog/unreleased/dependencies/2126-github-com-cosmwasm-wasmvm-v2-2-1-2.md (0 hunks)
- .changelog/unreleased/dependencies/2129-cosmossdk-io-log-1-4-1.md (0 hunks)
- .changelog/unreleased/dependencies/2130-cosmossdk-io-core-0-11-2.md (0 hunks)
- .changelog/unreleased/dependencies/2131-bufbuild-buf-setup-action-1-37-0.md (0 hunks)
- .changelog/unreleased/dependencies/2132-bump-go-to-1.23.md (0 hunks)
- .changelog/unreleased/dependencies/2133-bufbuild-buf-setup-action-1-38-0.md (0 hunks)
- .changelog/unreleased/dependencies/2138-bufbuild-buf-setup-action-1-39-0.md (0 hunks)
- .changelog/unreleased/dependencies/2141-peter-evans-create-pull-request-7-0-0.md (0 hunks)
- .changelog/unreleased/dependencies/2142-github-com-cometbft-cometbft-0-38-12.md (0 hunks)
- .changelog/unreleased/dependencies/2143-golang-org-x-text-0-18-0.md (0 hunks)
- .changelog/unreleased/dependencies/2150-google-golang-org-grpc-1-66-2.md (0 hunks)
- .changelog/unreleased/dependencies/2151-bufbuild-buf-setup-action-1-41-0.md (0 hunks)
- .changelog/unreleased/dependencies/2152-peter-evans-create-pull-request-7-0-2.md (0 hunks)
- .changelog/unreleased/dependencies/2153-cosmossdk-io-client-v2-2-0-0-beta-5.md (0 hunks)
- .changelog/unreleased/dependencies/2154-cosmossdk-io-x-tx-0-13-5.md (0 hunks)
- .changelog/unreleased/dependencies/2155-bufbuild-buf-setup-action-1-42-0.md (0 hunks)
- .changelog/unreleased/dependencies/2156-peter-evans-create-pull-request-7-0-5.md (0 hunks)
- .changelog/unreleased/dependencies/2157-google-golang-org-grpc-1-67-0.md (0 hunks)
- .changelog/unreleased/dependencies/2161-github-com-cosmwasm-wasmvm-v2-2-1-3.md (0 hunks)
- .changelog/unreleased/dependencies/2162-cosmossdk-io-api-0-7-6.md (0 hunks)
- .changelog/unreleased/dependencies/2164-bufbuild-buf-setup-action-1-43-0.md (0 hunks)
- .changelog/unreleased/dependencies/2165-google-golang-org-grpc-1-67-1.md (0 hunks)
- .changelog/unreleased/dependencies/2168-bufbuild-buf-setup-action-1-44-0.md (0 hunks)
- .changelog/unreleased/dependencies/2170-golang-org-x-text-0-19-0.md (0 hunks)
- .changelog/unreleased/dependencies/2173-google-golang-org-protobuf-1-35-1.md (0 hunks)
- .changelog/unreleased/dependencies/2174-bufbuild-buf-setup-action-1-45-0.md (0 hunks)
- .changelog/unreleased/dependencies/2175-bump-sdk-to-50-10.md (0 hunks)
- .changelog/unreleased/features/2137-bank-scope-value-owners.md (0 hunks)
- .changelog/unreleased/improvements/2030-explicit-navs.md (0 hunks)
- .changelog/unreleased/improvements/2062-build-debug.md (0 hunks)
- .changelog/unreleased/improvements/2112-switch-to-unclog.md (0 hunks)
- .changelog/unreleased/improvements/2128-marker-nav-docs.md (0 hunks)
- .changelog/unreleased/improvements/2134-metadata-nav-doc.md (0 hunks)
- .changelog/unreleased/improvements/2136-makefile-cleanup.md (0 hunks)
- .changelog/unreleased/improvements/2137-bank-scope-value-owners.md (0 hunks)
- .changelog/unreleased/improvements/2166-add-changelog-helper.md (0 hunks)
- .changelog/unreleased/improvements/2176-delete-umber.md (0 hunks)
- CHANGELOG.md (1 hunks)
- go.mod (1 hunks)
💤 Files with no reviewable changes (56)
- .changelog/unreleased/api-breaking/2137-bank-scope-value-owners.md
- .changelog/unreleased/api-breaking/2176-delete-params.md
- .changelog/unreleased/bug-fixes/2110-marker-feegrant-fix.md
- .changelog/unreleased/bug-fixes/2135-openapiv2.md
- .changelog/unreleased/bug-fixes/2144-remove-metadata-count-telemetry.md
- .changelog/unreleased/bug-fixes/2177-add-store-telemetry.md
- .changelog/unreleased/bug-fixes/376-fix-markdown-gen.md
- .changelog/unreleased/client-breaking/2119-remove-deprecated-bindings.md
- .changelog/unreleased/client-breaking/2153-keccak.md
- .changelog/unreleased/client-breaking/2158-fix-metadata-nav-example.md
- .changelog/unreleased/dependencies/2100-cosmossdk-io-client-v2-2-0-0-beta-4.md
- .changelog/unreleased/dependencies/2107-cosmossdk-io-core-0-11-1.md
- .changelog/unreleased/dependencies/2113-cosmossdk-io-x-tx-0-13-4.md
- .changelog/unreleased/dependencies/2114-github-com-spf13-cast-1-7-0.md
- .changelog/unreleased/dependencies/2115-golang-org-x-text-0-17-0.md
- .changelog/unreleased/dependencies/2116-cosmossdk-io-log-1-4-0.md
- .changelog/unreleased/dependencies/2120-github-com-cometbft-cometbft-0-38-11.md
- .changelog/unreleased/dependencies/2122-bufbuild-buf-setup-action-1-36-0.md
- .changelog/unreleased/dependencies/2125-github-com-cosmos-gogoproto-1-7-0.md
- .changelog/unreleased/dependencies/2126-github-com-cosmwasm-wasmvm-v2-2-1-2.md
- .changelog/unreleased/dependencies/2129-cosmossdk-io-log-1-4-1.md
- .changelog/unreleased/dependencies/2130-cosmossdk-io-core-0-11-2.md
- .changelog/unreleased/dependencies/2131-bufbuild-buf-setup-action-1-37-0.md
- .changelog/unreleased/dependencies/2132-bump-go-to-1.23.md
- .changelog/unreleased/dependencies/2133-bufbuild-buf-setup-action-1-38-0.md
- .changelog/unreleased/dependencies/2138-bufbuild-buf-setup-action-1-39-0.md
- .changelog/unreleased/dependencies/2141-peter-evans-create-pull-request-7-0-0.md
- .changelog/unreleased/dependencies/2142-github-com-cometbft-cometbft-0-38-12.md
- .changelog/unreleased/dependencies/2143-golang-org-x-text-0-18-0.md
- .changelog/unreleased/dependencies/2150-google-golang-org-grpc-1-66-2.md
- .changelog/unreleased/dependencies/2151-bufbuild-buf-setup-action-1-41-0.md
- .changelog/unreleased/dependencies/2152-peter-evans-create-pull-request-7-0-2.md
- .changelog/unreleased/dependencies/2153-cosmossdk-io-client-v2-2-0-0-beta-5.md
- .changelog/unreleased/dependencies/2154-cosmossdk-io-x-tx-0-13-5.md
- .changelog/unreleased/dependencies/2155-bufbuild-buf-setup-action-1-42-0.md
- .changelog/unreleased/dependencies/2156-peter-evans-create-pull-request-7-0-5.md
- .changelog/unreleased/dependencies/2157-google-golang-org-grpc-1-67-0.md
- .changelog/unreleased/dependencies/2161-github-com-cosmwasm-wasmvm-v2-2-1-3.md
- .changelog/unreleased/dependencies/2162-cosmossdk-io-api-0-7-6.md
- .changelog/unreleased/dependencies/2164-bufbuild-buf-setup-action-1-43-0.md
- .changelog/unreleased/dependencies/2165-google-golang-org-grpc-1-67-1.md
- .changelog/unreleased/dependencies/2168-bufbuild-buf-setup-action-1-44-0.md
- .changelog/unreleased/dependencies/2170-golang-org-x-text-0-19-0.md
- .changelog/unreleased/dependencies/2173-google-golang-org-protobuf-1-35-1.md
- .changelog/unreleased/dependencies/2174-bufbuild-buf-setup-action-1-45-0.md
- .changelog/unreleased/dependencies/2175-bump-sdk-to-50-10.md
- .changelog/unreleased/features/2137-bank-scope-value-owners.md
- .changelog/unreleased/improvements/2030-explicit-navs.md
- .changelog/unreleased/improvements/2062-build-debug.md
- .changelog/unreleased/improvements/2112-switch-to-unclog.md
- .changelog/unreleased/improvements/2128-marker-nav-docs.md
- .changelog/unreleased/improvements/2134-metadata-nav-doc.md
- .changelog/unreleased/improvements/2136-makefile-cleanup.md
- .changelog/unreleased/improvements/2137-bank-scope-value-owners.md
- .changelog/unreleased/improvements/2166-add-changelog-helper.md
- .changelog/unreleased/improvements/2176-delete-umber.md
🧰 Additional context used
🪛 Markdownlint
CHANGELOG.md
181-181: null
Bare URL used(MD034, no-bare-urls)
🔇 Additional comments (13)
go.mod (2)
25-25
: LGTM. Verify compatibility with the updated cosmos-sdk version.The update of
github.com/cosmos/cosmos-sdk
from v0.50.7 to v0.50.10 is a minor version increment, which typically includes bug fixes and small improvements. This change follows semantic versioning principles.To ensure compatibility, please run the following verification steps:
Please review the output of these commands to ensure there are no compatibility issues with the updated cosmos-sdk version.
Line range hint
228-228
: Verify fork consistency with the main cosmos-sdk repository.The
replace
directive forgithub.com/cosmos/cosmos-sdk
has been updated to match the new version:github.com/cosmos/cosmos-sdk => github.com/provenance-io/cosmos-sdk v0.50.10-pio-1This maintains consistency with the main dependency update. However, it's crucial to ensure that the fork is up-to-date with the main repository.
Please run the following commands to verify the fork's consistency:
#!/bin/bash # Description: Verify fork consistency with the main cosmos-sdk repository # Test: Compare commit history between main repo and fork echo "Comparing commit history between main repo and fork..." git clone https://github.com/cosmos/cosmos-sdk.git cosmos-sdk-main git clone https://github.com/provenance-io/cosmos-sdk.git cosmos-sdk-fork cd cosmos-sdk-main git checkout v0.50.10 MAIN_COMMIT=$(git rev-parse HEAD) cd ../cosmos-sdk-fork git checkout v0.50.10-pio-1 FORK_COMMIT=$(git rev-parse HEAD) echo "Main repo commit: $MAIN_COMMIT" echo "Fork commit: $FORK_COMMIT" git log --oneline $MAIN_COMMIT..$FORK_COMMIT # Test: Check for any additional changes in the fork echo "Checking for additional changes in the fork..." git diff $MAIN_COMMIT $FORK_COMMIT cd .. rm -rf cosmos-sdk-main cosmos-sdk-forkReview the output to ensure that any differences between the main repository and the fork are intentional and necessary for your project.
.changelog/prep-release.sh (3)
283-286
: LGTM: Improved readability of version validation logic.The reformatting of the conditional check for sequential minor version numbers enhances code readability without altering the underlying logic. This change is a good example of maintaining clean and easily understandable code.
582-586
: LGTM: Crucial improvement for RC handling.This new logic for handling release candidates (RCs) is a valuable addition to the script. By copying the summary.md file back into the unreleased directory when processing an RC, it ensures that important information is preserved for future releases. The conditional check and error handling are implemented correctly, maintaining consistency with the rest of the script.
Line range hint
1-586
: Overall: Significant improvements in RC handling and error management.The changes made to this script represent a substantial improvement in its functionality, particularly in handling release candidates (RCs) and enhancing error management. Key improvements include:
- Better formatting and readability in version validation logic.
- Crucial addition of RC-specific handling, ensuring proper preservation of summary information.
- Refined error handling throughout the script.
These modifications enhance the script's robustness and reliability in managing the release process, especially for RCs. The changes are well-integrated into the existing structure and maintain consistency with the script's overall style and bash best practices.
CHANGELOG.md (8)
55-56
: New release candidate: v1.20.0-rc1This release candidate introduces several new features, improvements, and bug fixes. It's important to thoroughly test this version before the final release.
61-71
: Multiple improvements to existing functionalitySeveral improvements have been made:
- NAV record setting logic change
- New
build-debug
make target- Switch to
unclog
for changelog entries- Documentation updates for marker and metadata/scope nav commands
- Makefile cleanup
- Bank module usage for scope value owner tracking
- New
add-change.sh
script for changelog entries- Removal of the
umber
upgradeThese changes enhance the development process and improve various aspects of the system. Ensure that these changes are well-documented and that any affected workflows are updated accordingly.
179-181
: Full commit history providedThe inclusion of the full commit history link is helpful for developers who want to review all changes in detail. This promotes transparency and allows for a more comprehensive understanding of the changes made in this release.
🧰 Tools
🪛 Markdownlint
181-181: null
Bare URL used(MD034, no-bare-urls)
90-103
: API Breaking ChangesSeveral API breaking changes have been introduced:
- Changes to the
Ownership
query in thex/metadata
module- Modifications to the
WriteScope
endpoint- Changes to
MsgWriteScope
authorization- Removal of the params module
These changes will require updates to applications interacting with the Provenance blockchain. It's crucial to provide clear documentation and migration guides for these changes. Consider creating a separate document detailing the migration steps for each breaking change.
#!/bin/bash # Check for the presence of the API breaking changes in the codebase grep -R "Ownership" x/metadata/ grep -R "WriteScope" x/metadata/ grep -R "MsgWriteScope" x/metadata/ grep -R "params module" .
105-177
: Numerous dependency updatesA large number of dependencies have been updated, including:
- Various
bufbuild/buf-setup-action
versionscloud.google.com/go/compute/metadata
- Multiple
cosmossdk.io
packagesgithub.com/CosmWasm/wasmvm/v2
github.com/cometbft/cometbft
github.com/cosmos/cosmos-sdk
- And many others
These updates likely bring performance improvements, bug fixes, and new features from the updated libraries. However, it's important to thoroughly test the system with these new versions to ensure compatibility and stability.
#!/bin/bash # Check if the go.mod file has been updated with the new versions grep -E "bufbuild/buf-setup-action|cosmossdk.io|github.com/CosmWasm/wasmvm|github.com/cometbft/cometbft|github.com/cosmos/cosmos-sdk" go.mod
73-79
: Bug fixes and improvementsSeveral important bug fixes have been implemented:
- Proto markdown generation and regeneration of proto-docs.md
- Restoration of marker funds usage via feegrant
- Fix for proto generation
- Removal of ineffective telemetry counters from the metadata module
- Restoration of telemetry data from cometbft
These fixes address various issues and improve the overall stability and functionality of the system. It's important to verify that these fixes resolve the intended issues without introducing new problems.
81-88
: Client Breaking ChangesThere are several client breaking changes:
- Removal of old provwasm bindings
- Change in
HashOp
enum value inproofs.proto
- Correction of metadata nav CLI command example
- Addition of volume parameter to NAV entry
These changes may require updates to client applications and documentation. Ensure that these changes are clearly communicated to users and that appropriate migration guides are provided.
57-59
: New feature:viridian
upgradeThe addition of the
viridian
upgrade is a significant change. It's crucial to ensure that all necessary upgrade handlers and migrations are in place for this new upgrade.
Description
This PR updates the changelog in the
main
branch to reflect the release ofv1.20.0-rc1
.It's basically a frontport of #2179 but with the release notes and applicable changelog entry files deleted.
Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.
docs/
) or specification (x/<module>/spec/
).godoc
comments..changelog/unreleased
(see Adding Changes).Files changed
in the Github PR explorer.Codecov Report
in the comment section below once CI passes.Summary by CodeRabbit
New Features
viridian
upgrade.Improvements
build-debug
make target for easier debugging.unclog
for unreleased changelog entries.add-change.sh
script for easier changelog entries.umber
upgrade and its components.Bug Fixes
Client Breaking Changes
HashOp
enum value inproofs.proto
fromKECCAK
toKECCAK256
.API Breaking Changes
Ownership
query to return only scopes where the address is an owner.WriteScope
endpoint handling ofscope.value_owner_address
.MsgWriteScope
from related endpoints.params
module and associated endpoints.Dependencies
github.com/cosmos/cosmos-sdk
fromv0.50.7
tov0.50.10
.