Document manual Xcode project migration to support Xcode 11.4 by jmagman · Pull Request #3763 · flutter/website

jmagman · 2020-03-04T01:13:32Z

jmagman · 2020-03-04T01:13:57Z

src/docs/development/androidx-migration.md

 your `CHANGELOG.md` to indicate that this new version is compatible with AndroidX.

-### What about if I can't use Android Studio?
+### What if I can't use Android Studio?


Unrelated awkward phrasing I noticed.

src/_data/sidenav.yml

sfshaza2

A few edits. Next, I'll stage this to see how it looks. The numbered list may not render properly.

sfshaza2 · 2020-03-04T05:55:02Z

src/docs/development/ios-project-migration.md

+---
+
+{{site.alert.note}}
+  You might be directed to this page if the tool detects that your project


Which tool? Could we say:

You might be directed to this page if the framework detects that your project doesn't support Xcode 11.4.

Or even just tweak the sentence to be a bit more clear about the tool involved.

As you noticed, I copied this from the AndroidX page. It's not from the framework, it's coming from running flutter build ios on the command line or an error in an IDE. What about

You might be directed to this page if Flutter detects

src/docs/development/ios-project-migration.md

sfshaza2 · 2020-03-04T06:26:13Z

@jmagman, I've staged the PR here.

You did exactly what I wanted for the sidenav. The only issue I see is that the titles are no longer parallel:
- AndroidX migration
- Android plugin upgrade
- Supporting Xcode 11.4

Can we modify the list? Perhaps:

* AndroidX migration
* Android plugin upgrade
* Xcode 11.4 support

I noticed that the AndroidX page also says "the tool" in their note. Cringe. What tool?
As I suspected, the numbered markdown list breaks the numbering. This is because, in markdown, numbered lists are fragile. If you start inserting code, images, etc, it wants to start the numbering over. When this happens to me, I switch into HTML. Here's how to do format it:

<ol markdown="1">
<li markdown="1">From the Flutter app directory, open `ios/Runner.xcworkspace` in Xcode.
</li>
<li markdown="1">In the **Navigator** pane, 
     locate the Flutter group and remove `App.framework` and `Flutter.framework`.
....
</li>
</ol>

It's a pain, but it's a limitation of markdown. The markdown="1" string is necessary, btw. Also, the closing </li> and </ol> tags need to be on their own lines.

I'll stage the site again when you've submitted your updates.

Another FYI, I am out the rest of this week.

jmagman · 2020-03-04T19:34:59Z

How do I prevent $(inherited) -framework Flutter from line-breaking? The -framework flag particularly has to stay together, and it's staged as:

I could use http://www.fileformat.info/info/unicode/char/2011/index.htm but I'm not sure if you have a preferred way to do this with CSS.

xster · 2020-03-04T21:34:40Z

you might have already done it, reminder to run optipng on the assets before merging

jmagman · 2020-03-04T21:35:33Z

you might have already done it, reminder to run optipng on the assets before merging

Already done! 😄

xster · 2020-03-04T21:36:08Z

src/docs/development/ios-project-migration.md

+
+{{site.alert.note}}
+  You might be directed to this page if Flutter detects that your project
+  doesn't support Xcode 11.4.


detects that you have Xcode 11.4 installed AND your project doesn't support Xcode 11.4?

Yes, the tool gives the error message when the migration fails AND Xcode 11.4 or greater is installed. We probably don't need to point that out, either they saw the error or they didn't.

xster · 2020-03-04T21:38:41Z

src/docs/development/ios-project-migration.md

+Flutter v1.15.3 and later will automatically migrate your Xcode project.
+
+If you need to manually upgrade your project, use the following steps:
+<ol markdown="1">


FWIW, this is barely documented but you can unbreak the weird markdown ordered list thing with big blocks if you 4 space indent everything i.e.

1. some thing `some long code section which would have made a mess` 1. this should be item 2 and should work now

Interesting! I don't know if @sfshaza2 tried that, but the ol markdown was how she got https://github.com/flutter/website/blob/master/src/docs/development/add-to-app/ios/project-setup.md to work. She asked me to do it here so I'll stick with that for now, but I can follow up and experiment when she's back in the office next week.

xster · 2020-03-04T21:39:20Z

src/docs/development/ios-project-migration.md

+
+If you need to manually upgrade your project, use the following steps:
+<ol markdown="1">
+<li markdown="1">From the Flutter app directory, open `ios/Runner.xcworkspace` in Xcode.


Does xcworkspace exist if the project doesn't use plugins? I don't remember.

Yes, it's always added as part of the create template.

legalcodes · 2020-03-04T22:07:34Z

Staged: https://jt-flutter-website-1.firebaseapp.com/docs/development/ios-project-migration

src/docs/development/ios-project-migration.md

legalcodes · 2020-03-04T22:18:02Z

Made a tiny nit, LGTM.

Co-Authored-By: Jon Tippens <[email protected]>

reviewer is OOO

jmagman added 3 commits March 3, 2020 16:45

Add Xcode 11.4 migration instructions

0ebaad4

resize

631dd0c

Arrows and compression

bb7999b

jmagman requested a review from sfshaza2 March 4, 2020 01:13

googlebot added the cla: yes Contributor has signed the Contributor License Agreement label Mar 4, 2020

jmagman self-assigned this Mar 4, 2020

jmagman commented Mar 4, 2020

View reviewed changes

src/_data/sidenav.yml Show resolved Hide resolved

Missing space

de881a4

sfshaza2 previously requested changes Mar 4, 2020

View reviewed changes

Review edits

48854f4

jmagman mentioned this pull request Mar 4, 2020

Skip iOS project migration when script is already embedding frameworks flutter/flutter#51963

Merged

10 tasks

xster reviewed Mar 4, 2020

View reviewed changes

xster approved these changes Mar 4, 2020

View reviewed changes

legalcodes requested a review from blasten March 4, 2020 21:52

legalcodes reviewed Mar 4, 2020

View reviewed changes

src/docs/development/ios-project-migration.md Outdated Show resolved Hide resolved

legalcodes reviewed Mar 4, 2020

View reviewed changes

src/docs/development/ios-project-migration.md Outdated Show resolved Hide resolved

legalcodes approved these changes Mar 4, 2020

View reviewed changes

legalcodes and others added 2 commits March 4, 2020 14:25

Update src/docs/development/ios-project-migration.md

4073bd9

Update src/docs/development/ios-project-migration.md

092077c

Co-Authored-By: Jon Tippens <[email protected]>

jmagman mentioned this pull request Mar 4, 2020

Update iOS project migration help URL flutter/flutter#51973

Merged

10 tasks

legalcodes merged commit c47ca53 into flutter:master Mar 4, 2020

jmagman deleted the ios-migration branch March 5, 2020 00:13

Conversation

jmagman commented Mar 4, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

sfshaza2 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sfshaza2 commented Mar 4, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jmagman commented Mar 4, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

xster commented Mar 4, 2020

Uh oh!

jmagman commented Mar 4, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

legalcodes commented Mar 4, 2020

Uh oh!

Uh oh!

Uh oh!

legalcodes commented Mar 4, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

sfshaza2 commented Mar 4, 2020 •

edited

Loading

jmagman commented Mar 4, 2020 •

edited

Loading