Skip to content

Conversation

@jmagman
Copy link
Member

@jmagman jmagman commented Mar 4, 2020

Fixes #3741.

@jmagman jmagman requested a review from sfshaza2 March 4, 2020 01:13
@googlebot googlebot added the cla: yes Contributor has signed the Contributor License Agreement label Mar 4, 2020
@jmagman jmagman self-assigned this Mar 4, 2020
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?
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unrelated awkward phrasing I noticed.

Copy link
Contributor

@sfshaza2 sfshaza2 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

---

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@sfshaza2
Copy link
Contributor

sfshaza2 commented Mar 4, 2020

@jmagman, I've staged the PR here.

  1. 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
  1. I noticed that the AndroidX page also says "the tool" in their note. Cringe. What tool?
  2. 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
Copy link
Member Author

jmagman commented Mar 4, 2020

How do I prevent $(inherited) -framework Flutter from line-breaking? The -framework flag particularly has to stay together, and it's staged as:
Screen Shot 2020-03-04 at 11 34 31 AM

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
Copy link
Member

xster commented Mar 4, 2020

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

@jmagman
Copy link
Member Author

jmagman commented Mar 4, 2020

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

Already done! 😄


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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

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">
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.


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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@legalcodes legalcodes requested a review from blasten March 4, 2020 21:52
@legalcodes
Copy link
Contributor

@legalcodes
Copy link
Contributor

Made a tiny nit, LGTM.

legalcodes and others added 2 commits March 4, 2020 14:25
@legalcodes legalcodes merged commit c47ca53 into flutter:master Mar 4, 2020
@jmagman jmagman deleted the ios-migration branch March 5, 2020 00:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cla: yes Contributor has signed the Contributor License Agreement

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document migration steps for migrating Xcode project to not explicitly link or embed on App.framework and Flutter.framework

5 participants