docs: migration docs v4 to v5 #1826

crodriguezvega · 2022-07-28T14:50:36Z

Description

closes: #1781
closed: #2083

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.

Targeted PR against correct branch (see CONTRIBUTING.md)
Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
Code follows the module structure standards.
Wrote unit and integration tests
Updated relevant documentation (docs/) or specification (x/<module>/spec/)
Added relevant godoc comments.
Added a relevant changelog entry to the Unreleased section in CHANGELOG.md
Re-reviewed Files changed in the Github PR explorer
Review Codecov Report in the comment section below once CI passes

…v4-to-v5

docs/migrations/v4-to-v5.md

crodriguezvega · 2022-07-28T14:52:55Z

Still a bit WiP, but open to receive feedback if I am forgetting something or if I am adding things in the wrong section.

crodriguezvega · 2022-07-28T14:54:30Z

docs/migrations/v4-to-v5.md

+
+The `RegisterRESTRoutes` function in `modules/apps/27-interchain-accounts` has been removed.
+
+The response of a message execution on the host chain is constructed now like this:


I probably need to expand the explanation of this part a bit more.

i think it could be good to give an example of how it was previously in addition to what it should look like now

How is it now?

…v4-to-v5

…https://github.com/cosmos/ibc-go into carlos/#1781-create-docs-for-migration-from-v4-to-v5

…v4-to-v5

damiannolan

Awesome job! Just left one comment regarding the new interface type for MsgServiceRouter

docs/migrations/v4-to-v5.md

colin-axner

Excellent! This is by far the best migrations written thus far!

colin-axner · 2022-08-24T10:42:10Z

docs/migrations/v4-to-v5.md

+This document is intended to highlight significant changes which may require more information than presented in the CHANGELOG.
+Any changes that must be done by a user of ibc-go should be documented here.


I think we can probably remove this section going forward. I'd assume it is just noise nowadays

docs/migrations/v4-to-v5.md

chatton

Really thorough great work @crodriguezvega 🥇

docs/migrations/v4-to-v5.md

…v4-to-v5

colin-axner · 2022-09-06T14:01:09Z

@crodriguezvega is this waiting on a review from someone?

crodriguezvega · 2022-09-07T12:06:35Z

@crodriguezvega is this waiting on a review from someone?

No, I just need to update accordingly to @damiannolan's and yours comment.

…v4-to-v5

…2309) * updating migration docs with additional ics27 host parameter * fix indentation

…v4-to-v5

colin-axner · 2022-09-21T15:44:24Z

Can we merge this?

crodriguezvega · 2022-09-26T07:23:51Z

Can we merge this?

Yeap. I will merge it now.

…v4-to-v5

* wip: migration docs v4 to v5 * adding some code diffs * adding more code snippets and diffs * add link to docs * fix alignment * fix alignment * fix alignment * fix typo * code improvement * add links to sections in the document * add migration docs for #2058 * added link to PR that renamed the ante decorator * changes for #2083 * docs: updating migration docs with additional ics27 host parameter (#2309) * updating migration docs with additional ics27 host parameter * fix indentation Co-authored-by: colin axnér <25233464+colin-axner@users.noreply.github.com> Co-authored-by: Damian Nolan <damiannolan@gmail.com> (cherry picked from commit a278287)

* wip: migration docs v4 to v5 * adding some code diffs * adding more code snippets and diffs * add link to docs * fix alignment * fix alignment * fix alignment * fix typo * code improvement * add links to sections in the document * add migration docs for #2058 * added link to PR that renamed the ante decorator * changes for #2083 * docs: updating migration docs with additional ics27 host parameter (#2309) * updating migration docs with additional ics27 host parameter * fix indentation Co-authored-by: colin axnér <25233464+colin-axner@users.noreply.github.com> Co-authored-by: Damian Nolan <damiannolan@gmail.com> (cherry picked from commit a278287) Co-authored-by: Carlos Rodriguez <carlos@interchain.io>

wip: migration docs v4 to v5

9705619

crodriguezvega linked an issue Jul 28, 2022 that may be closed by this pull request

Create docs for migration from v4 to v5 #1781

Closed

Merge branch 'main' into carlos/#1781-create-docs-for-migration-from-…

3b1aa34

…v4-to-v5

crodriguezvega commented Jul 28, 2022

View reviewed changes

docs/migrations/v4-to-v5.md Outdated Show resolved Hide resolved

crodriguezvega commented Jul 28, 2022

View reviewed changes

ryanchristo mentioned this pull request Aug 1, 2022

Update ibc-go from v2 to v5 regen-network/regen-ledger#1327

Closed

7 tasks

crodriguezvega added 9 commits August 22, 2022 09:46

Merge branch 'main' into carlos/#1781-create-docs-for-migration-from-…

b979950

…v4-to-v5

adding some code diffs

db26016

adding more code snippets and diffs

bbc889c

add link to docs

a195092

fix alignment

7e0a5e8

fix alignment

196f0c4

fix alignment

211e8f6

fix typo

4603247

Merge branch 'main' into carlos/#1781-create-docs-for-migration-from-…

99f7c50

…v4-to-v5

crodriguezvega marked this pull request as ready for review August 22, 2022 19:32

crodriguezvega requested review from colin-axner, AdityaSripal, seantking, damiannolan and chatton as code owners August 22, 2022 19:32

crodriguezvega added the backport-to-v5.0.x label Aug 22, 2022

crodriguezvega added 3 commits August 22, 2022 21:48

code improvement

0278c6c

Merge branch 'carlos/#1781-create-docs-for-migration-from-v4-to-v5' of …

bd5c1ad

…https://github.com/cosmos/ibc-go into carlos/#1781-create-docs-for-migration-from-v4-to-v5

Merge branch 'main' into carlos/#1781-create-docs-for-migration-from-…

4b43311

…v4-to-v5

damiannolan approved these changes Aug 23, 2022

View reviewed changes

docs/migrations/v4-to-v5.md Outdated Show resolved Hide resolved

colin-axner approved these changes Aug 24, 2022

View reviewed changes

chatton approved these changes Aug 24, 2022

View reviewed changes

docs/migrations/v4-to-v5.md Outdated Show resolved Hide resolved

add links to sections in the document

5e5f976

Merge branch 'main' into carlos/#1781-create-docs-for-migration-from-…

dbb548a

…v4-to-v5

add migration docs for #2058

179f39e

crodriguezvega added 2 commits September 8, 2022 14:53

added link to PR that renamed the ante decorator

48a8112

Merge branch 'main' into carlos/#1781-create-docs-for-migration-from-…

f4feb44

…v4-to-v5

colin-axner approved these changes Sep 8, 2022

View reviewed changes

colin-axner added backport-to-v5.1.x and removed backport-to-v5.1.x labels Sep 8, 2022

crodriguezvega added 2 commits September 8, 2022 22:03

Merge branch 'main' into carlos/#1781-create-docs-for-migration-from-…

3fff2f5

…v4-to-v5

changes for #2083

7783fac

crodriguezvega mentioned this pull request Sep 20, 2022

fix: ica handshake reopening channel - use GetAppVersion in favour of channel.Version #2302

Merged

9 tasks

damiannolan and others added 3 commits September 20, 2022 15:34

docs: updating migration docs with additional ics27 host parameter (#…

541a46d

…2309) * updating migration docs with additional ics27 host parameter * fix indentation

Merge branch 'main' into carlos/#1781-create-docs-for-migration-from-…

eab709b

…v4-to-v5

Merge branch 'main' into carlos/#1781-create-docs-for-migration-from-…

832d01c

…v4-to-v5

crodriguezvega added 3 commits September 26, 2022 09:23

Merge branch 'main' into carlos/#1781-create-docs-for-migration-from-…

3dc8a70

…v4-to-v5

Merge branch 'main' into carlos/#1781-create-docs-for-migration-from-…

d024d4f

…v4-to-v5

Merge branch 'main' into carlos/#1781-create-docs-for-migration-from-…

013b44c

…v4-to-v5

crodriguezvega merged commit a278287 into main Sep 26, 2022

crodriguezvega deleted the carlos/#1781-create-docs-for-migration-from-v4-to-v5 branch September 26, 2022 09:19

This was referenced Sep 26, 2022

docs: migration docs v4 to v5 (backport #1826) #2385

Merged

docs: migration docs v4 to v5 (backport #1826) #2386

Merged

chatton mentioned this pull request Nov 7, 2022

Add git cliff toml to support generation of changelog #2697

Merged

9 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: migration docs v4 to v5 #1826

docs: migration docs v4 to v5 #1826

crodriguezvega commented Jul 28, 2022 •

edited

Loading

crodriguezvega commented Jul 28, 2022

crodriguezvega Jul 28, 2022

charleenfei Jul 28, 2022

crodriguezvega Aug 22, 2022

damiannolan left a comment

colin-axner left a comment

colin-axner Aug 24, 2022

chatton left a comment

colin-axner commented Sep 6, 2022

crodriguezvega commented Sep 7, 2022 •

edited

Loading

colin-axner commented Sep 21, 2022

crodriguezvega commented Sep 26, 2022


		The `RegisterRESTRoutes` function in `modules/apps/27-interchain-accounts` has been removed.

		The response of a message execution on the host chain is constructed now like this:

		This document is intended to highlight significant changes which may require more information than presented in the CHANGELOG.
		Any changes that must be done by a user of ibc-go should be documented here.

docs: migration docs v4 to v5 #1826

docs: migration docs v4 to v5 #1826

Conversation

crodriguezvega commented Jul 28, 2022 • edited Loading

Description

crodriguezvega commented Jul 28, 2022

crodriguezvega Jul 28, 2022

Choose a reason for hiding this comment

charleenfei Jul 28, 2022

Choose a reason for hiding this comment

crodriguezvega Aug 22, 2022

Choose a reason for hiding this comment

damiannolan left a comment

Choose a reason for hiding this comment

colin-axner left a comment

Choose a reason for hiding this comment

colin-axner Aug 24, 2022

Choose a reason for hiding this comment

chatton left a comment

Choose a reason for hiding this comment

colin-axner commented Sep 6, 2022

crodriguezvega commented Sep 7, 2022 • edited Loading

colin-axner commented Sep 21, 2022

crodriguezvega commented Sep 26, 2022

crodriguezvega commented Jul 28, 2022 •

edited

Loading

crodriguezvega commented Sep 7, 2022 •

edited

Loading