docs: v11.1 migration docs#8958
Conversation
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 01a751c734
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
|
||
| ### If your chain already uses PFM from ibc-apps | ||
|
|
||
| Replace all ibc-apps PFM imports with the new ibc-go imports and review the [integration instructions](../04-middleware/02-packet-forward-middleware/02-integration.md). |
There was a problem hiding this comment.
Point migration steps to v11.1-compatible PFM integration docs
This step sends users to ../04-middleware/02-packet-forward-middleware/02-integration.md, but that page still documents the old ibc-apps module (github.com/cosmos/ibc-apps/.../packetforward at lines 27-29) and legacy keeper wiring (e.g. GetSubspace-based constructor flow at lines 63-79). For a v11.1 upgrade, following this link as written produces non-compiling integration code and can block upgrades; the migration guide should either include the new ibc-go wiring directly or link to updated v11.1 instructions.
Useful? React with 👍 / 👎.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #8958 +/- ##
=======================================
Coverage 66.93% 66.93%
=======================================
Files 329 329
Lines 17358 17358
=======================================
Hits 11618 11618
Misses 5014 5014
Partials 726 726
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Greptile SummaryThis PR adds two new migration guides for the ibc-go v11.1 release: one for chains already on v11.0 upgrading to v11.1, and one for chains upgrading directly from v10 to v11.1. Both guides focus on the Packet Forward Middleware (PFM) being moved from
Confidence Score: 4/5Documentation-only change; no runtime code is modified, so there is no risk of breakage from merging. The cross-reference in the v11-to-v11.1 guide sends v11.0 chains with existing PFM into a guide whose opening section lists constructor changes they have already applied, without any skip qualifier. The confusing GMP guard note in the v10-to-v11.1 guide applies to no reader of that guide. Both are clarity issues with no runtime consequence, but they could cause chain operators to make incorrect upgrade decisions. Both new migration files benefit from a second read, particularly the cross-reference on line 18 of 16-v11-to-v11_1.md and the trailing GMP caveat on line 122 of 17-v10-to-v11_1.md. Important Files Changed
|
Description
closes: #XXXX
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/) if anything is changed.godoccomments if relevant.Files changedin the GitHub PR explorer.