3.0 migration guide #661

rnystrom · 2017-04-17T18:00:08Z

Will add to this as we close out the milestone.

Issue fixed: #475

jessesquires · 2017-04-17T18:38:08Z

Guides/Migration.md

+
+### IGListCollectionView removed
+
+You can simply Find & Replace `IGListCollectionView` with `UICollectionView` in your project to fix this.


this won't work completely. IGListCollectionView will match the beginning of IGListCollectionViewLayout.

need to search IGListCollectionView * and IGListCollectionView alloc], etc.

jessesquires · 2017-04-17T18:38:37Z

Guides/Migration.md

@@ -2,6 +2,61 @@

 This guide provides details for how to migration between major versions of `IGListKit`.

+## From 2.x to 3.x
+
+For details on all changes in IGListKit 2.0.0, please see the [release notes](https://github.com/Instagram/IGListKit/releases/tag/3.0.0).


Copy and paste catches the best off guard!

facebook-github-bot · 2017-04-17T19:11:34Z

@rnystrom updated the pull request - view changes

BasThomas · 2017-04-18T12:07:23Z

Guides/Migration.md

+**Swift**
+
+```swift
+expanded = true


This can use an // OLD and // NEW for clarity as well.

rnystrom · 2017-04-19T13:32:58Z

Will need IGListSectionType stuff once #168 lands:

Swift needs override
Find/delete anything refing IGListSectionType
(optional) Delete default or empty methods

rnystrom · 2017-04-19T19:13:59Z

Examples/Examples-iOS/IGListKitExamples/SectionControllers/EmbeddedSectionController.swift

+        collectionContext?.performBatch(animated: true, updates: { (batchContext) in
+            batchContext.insert(in: self, at: [0])
+        })
+    }


whoops this is wrong, deleting

facebook-github-bot · 2017-04-19T19:23:10Z

@rnystrom updated the pull request - view changes

jessesquires · 2017-05-09T15:36:03Z

@rnystrom

We need to mention the Swift names changes (#593), then I think this is probably good to go?

facebook-github-bot · 2017-05-10T13:59:16Z

@rnystrom updated the pull request - view changes

rnystrom · 2017-05-10T14:15:23Z

Guides/Migration.md

+
+Since Swift uses modules, we don't need to use the `IG` prefix to avoid collisions. This also makes your code look _Swifty_.
+
+To migrate, use Xcode's Find navigator (command-3), search for `IGList`, and replace with `List`.


@jessesquires think this is enough? + @robertjpayne

facebook-github-bot · 2017-05-11T20:17:48Z

@rnystrom updated the pull request - view changes

jessesquires · 2017-05-11T20:18:03Z

made some minor edits. going to import and merge.

facebook-github-bot · 2017-05-11T20:18:22Z

@jessesquires has imported this pull request. If you are a Facebook employee, you can view this diff on Phabricator.

Summary: ~~Land after #661, #730 and D5031184~~ Rebuild the docs from script. Couple notes: - Went from 100% to 99%, does that matter? Script output says - > 99% documentation coverage with 2 undocumented symbols - Looks like `NS_SWIFT_NAME` throws documentation for a loop on `IGListDiffOption` and `IGListExperiment` - Swift names are different, will that be a problem? Part of #707 Closes #728 Differential Revision: D5050951 Pulled By: jessesquires fbshipit-source-id: 19249c1d34e6f253b911965114fd4ae7458d2684

Replaced force unwraps with explicit fatalErrors Deleted file.zip Updated UITestCase spacing Updated variableName => identifierName Fill in tbd in changelog Summary: Part of Instagram#707 Closes Instagram#729 Reviewed By: rnystrom Differential Revision: D5036882 Pulled By: jessesquires fbshipit-source-id: 2fe99b66608fff52bb42cac46073b32d0865d007 Bump pod and project version to 3.0.0 Summary: Part of Instagram#707 Closes Instagram#731 Reviewed By: rnystrom Differential Revision: D5036877 Pulled By: jessesquires fbshipit-source-id: f63ce3369019870df87ebde59d6f6b0e95c8ad87 Proof guides for consisntency and name changes Summary: Part of Instagram#707 Closes Instagram#730 Differential Revision: D5039060 Pulled By: rnystrom fbshipit-source-id: d54259b2dddbaba0fe2e69c6dd08a37fd17fbc4a Regen example project files Summary: Regen example projects w/ pod script file. Part of Instagram#707 Reviewed By: jessesquires Differential Revision: D5039135 fbshipit-source-id: d29bcf635aea59aa589bd90644fb1ece6279cc10 Update version number in docs Summary: Part of Instagram#707 Closes Instagram#734 Differential Revision: D5046692 Pulled By: jessesquires fbshipit-source-id: db43f99fd0bbf4186a1bd47070f28a9a446bc2a4 3.0 migration guide Summary: Will add to this as we close out the [milestone](https://github.com/Instagram/IGListKit/milestone/3). Issue fixed: Instagram#475 Closes Instagram#661 Differential Revision: D5047071 Pulled By: jessesquires fbshipit-source-id: 78989529f50c9b281960e5acf843e91198677432 Fix UICollectionView debug dump script Summary: Duh, need to import macro Issue fixed: Instagram#722 - [x] All tests pass. Demo project builds and runs. Closes Instagram#733 Differential Revision: D5040026 Pulled By: jessesquires fbshipit-source-id: e9e51137ab4f7fa949667e3f3d644cd5c03abf80 Rename sectionIndex API to just section Summary: Quick rename before releasing 3.0 to get this API in parity w/ `isFirstSection` and `isLastSection`. My b I should have caught this in review. Closes Instagram#720 Reviewed By: jessesquires, amonshiz Differential Revision: D5031184 fbshipit-source-id: 1cd7b00c8b32084fecd861e78808eea0d0056337 Update CHANGELOG.md Summary: Closes Instagram#735 Differential Revision: D5048185 Pulled By: jessesquires fbshipit-source-id: 3f1a6826a4088043d883533f4f933a0a7ea42d60 Regen docs for 3.0 Summary: ~~Land after Instagram#661, Instagram#730 and D5031184~~ Rebuild the docs from script. Couple notes: - Went from 100% to 99%, does that matter? Script output says - > 99% documentation coverage with 2 undocumented symbols - Looks like `NS_SWIFT_NAME` throws documentation for a loop on `IGListDiffOption` and `IGListExperiment` - Swift names are different, will that be a problem? Part of Instagram#707 Closes Instagram#728 Differential Revision: D5050951 Pulled By: jessesquires fbshipit-source-id: 19249c1d34e6f253b911965114fd4ae7458d2684 Fixup project, update README and guides Summary: - Fix OCMock issues with tvOS tests - Update README/guides Closes Instagram#737 Differential Revision: D5052333 Pulled By: jessesquires fbshipit-source-id: 958444d892c14dd4c75e244f20ae21bbfeec8290 final docs update for 3.0 Summary: Closes Instagram#738 Differential Revision: D5052802 Pulled By: jessesquires fbshipit-source-id: b1ace763da9edbb7bc65ecb9af34aa791e617aa7

Replaced force unwraps with explicit fatalErrors Deleted file.zip Updated UITestCase spacing Updated variableName => identifierName Fill in tbd in changelog Summary: Part of Instagram#707 Closes Instagram#729 Reviewed By: rnystrom Differential Revision: D5036882 Pulled By: jessesquires fbshipit-source-id: 2fe99b66608fff52bb42cac46073b32d0865d007 Bump pod and project version to 3.0.0 Summary: Part of Instagram#707 Closes Instagram#731 Reviewed By: rnystrom Differential Revision: D5036877 Pulled By: jessesquires fbshipit-source-id: f63ce3369019870df87ebde59d6f6b0e95c8ad87 Proof guides for consisntency and name changes Summary: Part of Instagram#707 Closes Instagram#730 Differential Revision: D5039060 Pulled By: rnystrom fbshipit-source-id: d54259b2dddbaba0fe2e69c6dd08a37fd17fbc4a Regen example project files Summary: Regen example projects w/ pod script file. Part of Instagram#707 Reviewed By: jessesquires Differential Revision: D5039135 fbshipit-source-id: d29bcf635aea59aa589bd90644fb1ece6279cc10 Update version number in docs Summary: Part of Instagram#707 Closes Instagram#734 Differential Revision: D5046692 Pulled By: jessesquires fbshipit-source-id: db43f99fd0bbf4186a1bd47070f28a9a446bc2a4 3.0 migration guide Summary: Will add to this as we close out the [milestone](https://github.com/Instagram/IGListKit/milestone/3). Issue fixed: Instagram#475 Closes Instagram#661 Differential Revision: D5047071 Pulled By: jessesquires fbshipit-source-id: 78989529f50c9b281960e5acf843e91198677432 Fix UICollectionView debug dump script Summary: Duh, need to import macro Issue fixed: Instagram#722 - [x] All tests pass. Demo project builds and runs. Closes Instagram#733 Differential Revision: D5040026 Pulled By: jessesquires fbshipit-source-id: e9e51137ab4f7fa949667e3f3d644cd5c03abf80 Rename sectionIndex API to just section Summary: Quick rename before releasing 3.0 to get this API in parity w/ `isFirstSection` and `isLastSection`. My b I should have caught this in review. Closes Instagram#720 Reviewed By: jessesquires, amonshiz Differential Revision: D5031184 fbshipit-source-id: 1cd7b00c8b32084fecd861e78808eea0d0056337 Update CHANGELOG.md Summary: Closes Instagram#735 Differential Revision: D5048185 Pulled By: jessesquires fbshipit-source-id: 3f1a6826a4088043d883533f4f933a0a7ea42d60 Regen docs for 3.0 Summary: ~~Land after Instagram#661, Instagram#730 and D5031184~~ Rebuild the docs from script. Couple notes: - Went from 100% to 99%, does that matter? Script output says - > 99% documentation coverage with 2 undocumented symbols - Looks like `NS_SWIFT_NAME` throws documentation for a loop on `IGListDiffOption` and `IGListExperiment` - Swift names are different, will that be a problem? Part of Instagram#707 Closes Instagram#728 Differential Revision: D5050951 Pulled By: jessesquires fbshipit-source-id: 19249c1d34e6f253b911965114fd4ae7458d2684 Fixup project, update README and guides Summary: - Fix OCMock issues with tvOS tests - Update README/guides Closes Instagram#737 Differential Revision: D5052333 Pulled By: jessesquires fbshipit-source-id: 958444d892c14dd4c75e244f20ae21bbfeec8290 final docs update for 3.0 Summary: Closes Instagram#738 Differential Revision: D5052802 Pulled By: jessesquires fbshipit-source-id: b1ace763da9edbb7bc65ecb9af34aa791e617aa7 Deleted SwiftLint directory

facebook-github-bot added the CLA Signed label Apr 17, 2017

jessesquires added this to the 3.0.0 milestone Apr 17, 2017

jessesquires reviewed Apr 17, 2017

View reviewed changes

BasThomas reviewed Apr 18, 2017

View reviewed changes

rnystrom commented Apr 19, 2017

View reviewed changes

rnystrom force-pushed the migration-3 branch from af5fcf9 to c103846 Compare April 19, 2017 19:23

rnystrom mentioned this pull request May 1, 2017

Cut 3.0.0 release #707

Closed

15 tasks

Ryan Nystrom added 3 commits May 10, 2017 09:52

3.0 migration guide

73117a8

copypasta, regex replace, update image

19bf579

add protocol removal info, new/old

50fba5d

rnystrom force-pushed the migration-3 branch from c103846 to 50fba5d Compare May 10, 2017 13:53

add swift name changes

2f7f8be

rnystrom commented May 10, 2017

View reviewed changes

rnystrom mentioned this pull request May 10, 2017

Regen docs for 3.0 #728

Closed

Update Migration.md

72aff0b

facebook-github-bot closed this in de0fe91 May 11, 2017

rnystrom deleted the migration-3 branch May 11, 2017 21:57

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

3.0 migration guide #661

3.0 migration guide #661

rnystrom commented Apr 17, 2017 •

edited

Loading

jessesquires Apr 17, 2017

jessesquires Apr 17, 2017

Sherlouk Apr 17, 2017

facebook-github-bot commented Apr 17, 2017

BasThomas Apr 18, 2017

rnystrom commented Apr 19, 2017

rnystrom Apr 19, 2017

facebook-github-bot commented Apr 19, 2017

jessesquires commented May 9, 2017

facebook-github-bot commented May 10, 2017

rnystrom May 10, 2017 •

edited

Loading

facebook-github-bot commented May 11, 2017

jessesquires commented May 11, 2017

facebook-github-bot commented May 11, 2017


		### IGListCollectionView removed

		You can simply Find & Replace `IGListCollectionView` with `UICollectionView` in your project to fix this.


		Since Swift uses modules, we don't need to use the `IG` prefix to avoid collisions. This also makes your code look _Swifty_.

		To migrate, use Xcode's Find navigator (command-3), search for `IGList`, and replace with `List`.

3.0 migration guide #661

3.0 migration guide #661

Conversation

rnystrom commented Apr 17, 2017 • edited Loading

jessesquires Apr 17, 2017

Choose a reason for hiding this comment

jessesquires Apr 17, 2017

Choose a reason for hiding this comment

Sherlouk Apr 17, 2017

Choose a reason for hiding this comment

facebook-github-bot commented Apr 17, 2017

BasThomas Apr 18, 2017

Choose a reason for hiding this comment

rnystrom commented Apr 19, 2017

rnystrom Apr 19, 2017

Choose a reason for hiding this comment

facebook-github-bot commented Apr 19, 2017

jessesquires commented May 9, 2017

facebook-github-bot commented May 10, 2017

rnystrom May 10, 2017 • edited Loading

Choose a reason for hiding this comment

facebook-github-bot commented May 11, 2017

jessesquires commented May 11, 2017

facebook-github-bot commented May 11, 2017

rnystrom commented Apr 17, 2017 •

edited

Loading

rnystrom May 10, 2017 •

edited

Loading