docs: using FlutterFire CLI `v0.3.0-dev.19` to configure your project with Firebase #224

russellwheatley · 2023-10-25T17:40:38Z

Description

closes #188
closes #148

The following issues are due to windows setup issue which has now been documented:

closes #55
closes #49
closes #38
closes #180
closes #19

Type of Change

✨ feat -- New feature (non-breaking change which adds functionality)
🛠️ fix -- Bug fix (non-breaking change which fixes an issue)
❌ ! -- Breaking change (fix or feature that would cause existing functionality to change)
🧹 refactor -- Code refactor
✅ ci -- Build configuration change
📝 docs -- Documentation
🗑️ chore -- Chore

nilsreichardt

Great progress!

One important thing is missing: For iOS and macOS builds it's required that the FlutterFire CLI is installed. So in case someone is building their iOS/macOS app with CI/CD, installing the FlutterFire CLI needs to be part of the CI/CD pipeline. Otherwise, the build will fail. Same for people who are working in a team: every developer in this team needs to install the FlutterFire CLI.

nilsreichardt · 2023-12-14T17:32:07Z

README.md

+for iOS:
+```bash
+flutterfire configure --platforms=ios --ios-bundle-id=your.bundle.id --ios-build-config=Release --ios-out=ios/release/GoogleService-Info.plist
+```
+
+for macOS:
+```bash
+flutterfire configure --platforms=macos --macos-bundle-id=your.bundle.id --macos-build-config=Release --macos-out=macos/release/GoogleService-Info.plist
+```


I think it would be helpful to mention that you need to re-run this command with every build configuration, so you need also to run it with Profile and Debug. This was something what me confused at the beginning because I assumed that FlutterFire detects the build configs and adds it for all build configs automatically.

nilsreichardt · 2023-12-14T17:40:43Z

README.md

+
+### Flutterfire reconfigure
+
+There is another command that you might want to run each time you configure your project with another Firebase product. For example, if you configure Real time database for your Firebase project, you will be required to reinstall every service file for each platform. By running:


I think it's also important that you need to run flutterfire reconfigure it you add later firebase_performance or firebase_crashlytics to your project. This is something that is super easy to oversee because you don't get any errors/warning when you run:

# First FlutterFire configure flutterfire configure # And then add firebase_crashlytics flutter pub add firebase_crashlytics

In this case, the 'FlutterFire: "flutterfire upload-crashlytics-symbols"' build phase in XCode is missing.

Something for the future: Maybe a better user experience would be to add another build phase that checks, if the project uses firebase_crashlytics and if yes -> check if 'FlutterFire: "flutterfire upload-crashlytics-symbols"' is present in XCode, if no -> add it automatically or print a warning.

This is also something that needs to be mentioned in the Firebase Analytics docs

Thanks for the feedback, @nilsreichardt! I've made some updates based on your comments 👍

## Summary With this PR, we support `prod` and `dev` flavors for our macOS app. Make you sure, you have the [FlutterFire CLI](https://pub.dev/packages/flutterfire_cli) installed (version 0.3.0-dev.18 or higher), if you want to build for macOS. The FlutterFire CLI is used during the build process in the XCode build phases (configuring bundle service files and uploading Crashlytics symbols). ## Details Because the process of adding Firebase flavors to our macOS isn't documented well (there is a open PR with more documentation: invertase/flutterfire_cli#224), I'm describing here, what I did to support flavors. First, I needed to execute the following commands: ```sh flutterfire configure \ --project=sharezone-debug \ --platforms=macos \ --out=lib/firebase_options_dev.g.dart \ --macos-build-config=Debug-dev \ --macos-out=macos/config/dev \ --macos-bundle-id=de.codingbrain.sharezone.app.dev flutterfire configure \ --project=sharezone-debug \ --platforms=macos \ --out=lib/firebase_options_dev.g.dart \ --macos-build-config=Profile-dev \ --macos-out=macos/config/dev \ --macos-bundle-id=de.codingbrain.sharezone.app.dev flutterfire configure \ --project=sharezone-debug \ --platforms=macos \ --out=lib/firebase_options_dev.g.dart \ --macos-build-config=Release-dev \ --macos-out=macos/config/dev \ --macos-bundle-id=de.codingbrain.sharezone.app.dev flutterfire configure \ --project=sharezone-c2bd8 \ --platforms=macos \ --out=lib/firebase_options_prod.g.dart \ --macos-build-config=Debug-prod \ --macos-out=macos/config/prod \ --macos-bundle-id=de.codingbrain.sharezone.app flutterfire configure \ --project=sharezone-c2bd8 \ --platforms=macos \ --out=lib/firebase_options_prod.g.dart \ --macos-build-config=Profile-prod \ --macos-out=macos/config/prod \ --macos-bundle-id=de.codingbrain.sharezone.app flutterfire configure \ --project=sharezone-c2bd8 \ --platforms=macos \ --out=lib/firebase_options_prod.g.dart \ --macos-build-config=Release-prod \ --macos-out=macos/config/prod \ --macos-bundle-id=de.codingbrain.sharezone.app ``` The commands configure Firebase for each build config (`Debug-dev`, `Profile-dev`, `Release-dev`, `Debug-prod`, `Profile-prod`, `Release-prod`). Additionally, I needed to set `debug information format` to `DWARF with dSYM File`, see https://firebase.google.com/docs/crashlytics/get-started?platform=ios#set-up-dsym-uploading. ## Related Tickets Closes #352 Related to invertase/flutterfire_cli#14

docs: using FlutterFire CLI to configure your project with Firebase

76a51f1

russellwheatley temporarily deployed to CI Environment October 25, 2023 17:42 — with GitHub Actions Inactive

chore: update content

d3ba368

russellwheatley had a problem deploying to CI Environment October 26, 2023 15:23 — with GitHub Actions Failure

russellwheatley added 2 commits October 26, 2023 16:27

chore: update title for docs

a0d3449

chore: update recommendations

27626d7

russellwheatley had a problem deploying to CI Environment October 26, 2023 15:29 — with GitHub Actions Failure

russellwheatley temporarily deployed to CI Environment October 26, 2023 15:29 — with GitHub Actions Inactive

Merge branch 'main' into readme-documentation

6f5aa47

russellwheatley temporarily deployed to CI Environment October 31, 2023 15:58 — with GitHub Actions Inactive

docs: refine documentation

5389e06

russellwheatley had a problem deploying to CI Environment December 7, 2023 09:04 — with GitHub Actions Failure

show platforms flag

580dc4c

russellwheatley had a problem deploying to CI Environment December 7, 2023 09:13 — with GitHub Actions Failure

russellwheatley changed the title ~~docs: using FlutterFire CLI to configure your project with Firebase~~ docs: using FlutterFire CLI v0.3.0-dev.19 to configure your project with Firebase Dec 7, 2023

Update README.md

8440ab6

russellwheatley had a problem deploying to CI Environment December 7, 2023 09:21 — with GitHub Actions Failure

docs: warn apple configuration will only work on macOS

8eb4ceb

russellwheatley temporarily deployed to CI Environment December 7, 2023 15:03 — with GitHub Actions Inactive

russellwheatley had a problem deploying to CI Environment December 7, 2023 15:03 — with GitHub Actions Failure

Merge branch 'main' into readme-documentation

ca5819e

russellwheatley temporarily deployed to CI Environment December 7, 2023 16:28 — with GitHub Actions Inactive

Update README.md

3aec8dd

russellwheatley temporarily deployed to CI Environment December 8, 2023 09:38 — with GitHub Actions Inactive

docs: installation

6ffe3ae

russellwheatley temporarily deployed to CI Environment December 8, 2023 11:20 — with GitHub Actions Inactive

docs: update wording

dbc12fc

russellwheatley temporarily deployed to CI Environment December 8, 2023 11:26 — with GitHub Actions Inactive

nilsreichardt mentioned this pull request Dec 9, 2023

Add flavors to macOS SharezoneApp/sharezone-app#1078

Merged

russellwheatley mentioned this pull request Dec 11, 2023

[bug]: macOS build failure "unsealed contents present in the bundle root" after using flutterfire configre #244

Closed

1 task

nilsreichardt reviewed Dec 14, 2023

View reviewed changes

docs: update based on feedback

6dadaf8

russellwheatley temporarily deployed to CI Environment December 18, 2023 14:32 — with GitHub Actions Inactive

russellwheatley had a problem deploying to CI Environment December 18, 2023 14:32 — with GitHub Actions Failure

russellwheatley temporarily deployed to CI Environment December 18, 2023 14:32 — with GitHub Actions Inactive

russellwheatley merged commit 50e908e into main Dec 19, 2023

russellwheatley deleted the readme-documentation branch December 19, 2023 10:32

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs: using FlutterFire CLI `v0.3.0-dev.19` to configure your project with Firebase #224

docs: using FlutterFire CLI `v0.3.0-dev.19` to configure your project with Firebase #224

Uh oh!

russellwheatley commented Oct 25, 2023 •

edited

Loading

Uh oh!

nilsreichardt left a comment •

edited

Loading

Uh oh!

nilsreichardt Dec 14, 2023

Uh oh!

nilsreichardt Dec 14, 2023

Uh oh!

nilsreichardt Dec 14, 2023

Uh oh!

russellwheatley Dec 18, 2023

Uh oh!

Uh oh!


		### Flutterfire reconfigure

		There is another command that you might want to run each time you configure your project with another Firebase product. For example, if you configure Real time database for your Firebase project, you will be required to reinstall every service file for each platform. By running:

docs: using FlutterFire CLI v0.3.0-dev.19 to configure your project with Firebase #224

docs: using FlutterFire CLI v0.3.0-dev.19 to configure your project with Firebase #224

Uh oh!

Conversation

russellwheatley commented Oct 25, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Type of Change

Uh oh!

nilsreichardt left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nilsreichardt Dec 14, 2023

Choose a reason for hiding this comment

Uh oh!

nilsreichardt Dec 14, 2023

Choose a reason for hiding this comment

Uh oh!

nilsreichardt Dec 14, 2023

Choose a reason for hiding this comment

Uh oh!

russellwheatley Dec 18, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

docs: using FlutterFire CLI `v0.3.0-dev.19` to configure your project with Firebase #224

docs: using FlutterFire CLI `v0.3.0-dev.19` to configure your project with Firebase #224

russellwheatley commented Oct 25, 2023 •

edited

Loading

nilsreichardt left a comment •

edited

Loading