-
Notifications
You must be signed in to change notification settings - Fork 1.5k
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
3.0 migration guide #661
3.0 migration guide #661
Conversation
Guides/Migration.md
Outdated
|
||
### IGListCollectionView removed | ||
|
||
You can simply Find & Replace `IGListCollectionView` with `UICollectionView` in your project to fix this. |
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.
this won't work completely. IGListCollectionView
will match the beginning of IGListCollectionViewLayout.
need to search IGListCollectionView *
and IGListCollectionView alloc]
, etc.
Guides/Migration.md
Outdated
@@ -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). |
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.
3.0 😄
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.
Copy and paste catches the best off guard!
@rnystrom updated the pull request - view changes |
Guides/Migration.md
Outdated
**Swift** | ||
|
||
```swift | ||
expanded = true |
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.
This can use an // OLD
and // NEW
for clarity as well.
Will need
|
collectionContext?.performBatch(animated: true, updates: { (batchContext) in | ||
batchContext.insert(in: self, at: [0]) | ||
}) | ||
} |
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.
whoops this is wrong, deleting
@rnystrom updated the pull request - view changes |
@rnystrom updated the pull request - view changes |
Guides/Migration.md
Outdated
|
||
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`. |
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.
@jessesquires think this is enough? + @robertjpayne
@rnystrom updated the pull request - view changes |
made some minor edits. going to import and merge. |
@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
Will add to this as we close out the milestone.
Issue fixed: #475