[go: nahoru, domu]

Skip to content
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

macOS development system requirement versions inconsistent #10041

Closed
1 task
parlough opened this issue Jan 14, 2024 · 14 comments
Closed
1 task

macOS development system requirement versions inconsistent #10041

parlough opened this issue Jan 14, 2024 · 14 comments
Assignees
Labels
a.get-started Relates to the Getting Started section of docs.flutter.dev cl.wont-fix Issue closed as it either can't be or won't be fixed devos.macOS Relates to developing apps on macOS platform e1-hours Effort: < 8 hrs fix.bug Needs fix of incorrect copy, code, or visual from.team Reported by Dash docs team member p1-high Major but not urgent concern: Resolve in months. Update each month.

Comments

@parlough
Copy link
Member

Page URL

https://docs.flutter.dev/get-started/install/macos/mobile-ios/

Page source

https://github.com/flutter/website/tree/main/src/get-started/install/macos/mobile-ios.md

Describe the problem

The page says Xcode 15 is required for debugging code during Flutter development and that Cocoapods needs to be 1.12 or later.

However, currently on stable the flutter tool says Xcode 14 and Cocoapods 1.10 are the minimum.

Expected fix

I'm not sure where the minimums on the page came from, but I'm assuming they should match the flutter tool?

Additional context

No response

I would like to fix this problem.

  • I will try and fix this problem on docs.flutter.dev.
@parlough parlough added fix.bug Needs fix of incorrect copy, code, or visual a.get-started Relates to the Getting Started section of docs.flutter.dev p1-high Major but not urgent concern: Resolve in months. Update each month. e1-hours Effort: < 8 hrs devos.macOS Relates to developing apps on macOS platform labels Jan 14, 2024
@parlough parlough added the from.team Reported by Dash docs team member label Jan 14, 2024
@atsansone
Copy link
Contributor

@parlough : I'll double check with engineering. I believe I was going with latest. It's worth checking, though.

@parlough
Copy link
Member Author

Thanks for looking in to it @atsansone!

@atsansone
Copy link
Contributor

@parlough : I know why these show as Xcode 15 and CocoaPods 1.12. I was working from a "latest stable version" perspective, as you can see from this archived version of the same page. CocoaPods didn't have a version listed, but I presumed that running sudo gem install cocoapods would install the latest version.

If this explanation works for you, close this issue. If not, I can discuss with @jmagman about using the minimum versions instead.

@atsansone atsansone added act.wait-for-customer Needs response from customer cl.wont-fix Issue closed as it either can't be or won't be fixed labels Jan 16, 2024
@atsansone
Copy link
Contributor

After discussing with @jmagman , I will close this issue. The minimum versions are what you found. We should recommend installing the latest stable.

@atsansone atsansone closed this as not planned Won't fix, can't repro, duplicate, stale Jan 16, 2024
@jmagman
Copy link
Member
jmagman commented Jan 16, 2024

@atsansone can we change it to just "latest"? The versions here don't match the tool, as @parlough found, so I think we should update it to match the tool (more difficult to keep in sync, particularly with I/O site lockdowns), or be ambiguous and not specify a version and let the tool enforce as needed. Otherwise we need to update this every time CocoaPods or Xcode releases a new version.

@jmagman jmagman reopened this Jan 16, 2024
@parlough
Copy link
Member Author
parlough commented Jan 16, 2024

atsansone can we change it to just "latest"?

Yes please! I think especially since it's under "System requirements", not matching the actual requirement is a potential source of confusion. Also updating with each change would be painful too.

I think saying "latest" and relying on flutter doctor (which fis more likely to have the up-to-date numbers for their SDK version) for any further diagnostics will be the most accurate while requiring the least maintenance.

@github-actions github-actions bot removed the act.wait-for-customer Needs response from customer label Jan 16, 2024
@atsansone
Copy link
Contributor

@jmagman : We could make this change. Are there any circumstances where not having the version spelled out would occur? The point you raise here would only become more pronounced as versions update, that is, the difference between what the docs recommend and what the tool states. (I thought the issue there, btw, was that this page was intended for new installers who wouldn't have an issue with minimums.)

Please advise.

@jmagman
Copy link
Member
jmagman commented Jan 24, 2024

I'd be fine with saying Xcode and CocoaPods without specifying a version or saying "latest". If developers don't have it installed, they will install the latest versions by default. And if they already have them installed then the tool will complain the first time they try to use it and will prompt them to update.

I also don't know why we mention git here

Xcode 15 to debug and compile native Swift or ObjectiveC code. The Xcode installation includes Git 2.4 or later to manage source code.

@atsansone
Copy link
Contributor

@jmagman : We mention git because the VS code extension requires it. I've gotten errors from not having git installed as well. macOS doesn't include git by default, but Xcode does.

@jmagman
Copy link
Member
jmagman commented Jan 25, 2024

We can drop the git version then. I don't want to need to notice and update our docs when Xcode revs the git version.

@atsansone
Copy link
Contributor

@jmagman That should work for macOS.

@anderdobo
Copy link
Contributor

The getting started docs are optimized for new installations, where we should guide to install the latest packages. This is separate from minimum supported versions that the tool may enforce. We're specific with versions elsewhere in the getting started docs and I think we should stay consistent here, as long as we keep these recommended newest version numbers for new installations up to date. @atsansone and I discussed and aligned on this when we did the latest refresh of the docs.

@jmagman
Copy link
Member
jmagman commented Jan 26, 2024

as long as we keep these recommended newest version numbers for new installations up to date

I don't keep track of when CocoaPods updates, or when a minor Xcode version comes out, or the version of git that it ships with. If someone from tech writing wants to commit to keeping this version number up-to-date that's fine with me, though it seems inevitable someone will miss a version. I don't see what that buys us instead of saying "latest", if you must say something other than "Install Xcode".

@atsansone
Copy link
Contributor

This works for me. Closing this issue.

@atsansone atsansone closed this as not planned Won't fix, can't repro, duplicate, stale Jan 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a.get-started Relates to the Getting Started section of docs.flutter.dev cl.wont-fix Issue closed as it either can't be or won't be fixed devos.macOS Relates to developing apps on macOS platform e1-hours Effort: < 8 hrs fix.bug Needs fix of incorrect copy, code, or visual from.team Reported by Dash docs team member p1-high Major but not urgent concern: Resolve in months. Update each month.
Projects
None yet
Development

No branches or pull requests

4 participants