-
Notifications
You must be signed in to change notification settings - Fork 1.6k
SPM beta docs #6312
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
Merged
Merged
SPM beta docs #6312
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
64d059f
SPM beta docs
paulb777 fc5b052
link to current issues
paulb777 630803f
whitespace
paulb777 9f0894b
review
paulb777 7619a6f
Add the repo for cut and paste ease
paulb777 70b310a
review
paulb777 99bc4d4
Add Analytics platform restriction
paulb777 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
# Swift Package Manager for Firebase **Beta** | ||
|
||
## Introduction | ||
|
||
Starting with the 6.31.0 release, Firebase supports installation via [Swift | ||
Package Manager](https://swift.org/package-manager/) in Beta status. | ||
|
||
|
||
## Limitations | ||
|
||
- Requires at least Xcode 12 beta 4. | ||
- SwiftUI Previews require Xcode 12 beta 5. | ||
- Analytics requires clients to add `-ObjC` linker option. | ||
- Analytics is only supported for iOS and cannot be used in apps that support other platforms. | ||
- Messaging, Performance, Firebase ML, and App Distribution are not initially available. | ||
- watchOS support is not initially available. | ||
|
||
## Installation | ||
|
||
If you've previously used CocoaPods, remove them from the project with `pod deintegrate`. | ||
|
||
Install Firebase via Swift Package Manager: | ||
|
||
<img src="docs/resources/SPMAddPackage.png"> | ||
|
||
Select the Firebase GitHub repository - `https://github.com/firebase/firebase-ios-sdk.git`: | ||
|
||
<img src="docs/resources/SPMChoose.png"> | ||
|
||
Select the beta branch. | ||
|
||
Note: Starting with the 6.31.0 release, the versions are specified | ||
in a format like 6.31-spm-beta. We won't support standard repository | ||
versioning until later in the beta or with general availability of the SPM | ||
distribution. | ||
|
||
<img src="docs/resources/SPMSelect.png"> | ||
|
||
Choose the Firebase product and any additional products that you want installed | ||
in your app. | ||
|
||
<img src="docs/resources/SPMProducts.png"> | ||
|
||
If you've installed FirebaseAnalytics, Add the `-ObjC` option to `Other Linker Flags` | ||
in the `Build Settings` tab. | ||
|
||
<img src="docs/resources/SPMObjC.png"> | ||
|
||
## Questions and Issues | ||
|
||
Please provide any feedback via a [GitHub | ||
Issue](https://github.com/firebase/firebase-ios-sdk/issues/new?template=bug_report.md). | ||
|
||
See current open Swift Package Manager issues | ||
[here](https://github.com/firebase/firebase-ios-sdk/labels/Swift%20Package%20Manager). |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
Should we be using
6.31.0-spm-beta
(including the patch version)?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.
I'm proposing that we update the 6.31-spm-beta branch with any patches.