You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

38 lines
1.3 KiB

  1. # Firebase Crashlytics SDK
  2. ## Development
  3. Follow the subsequent instructions to develop, debug, unit test, and
  4. integration test FirebaseCrashlytics:
  5. ### Prereqs
  6. - At least CocoaPods 1.6.0
  7. - Install [cocoapods-generate](https://github.com/square/cocoapods-generate)
  8. - For nanopb and GDT:
  9. - `brew install protobuf nanopb-generator`
  10. - `easy_install protobuf python`
  11. ### To Develop
  12. - Run `Crashlytics/generate_project.sh`
  13. - `open gen/FirebaseCrashlytics/FirebaseCrashlytics.xcworkspace`
  14. You're now in an Xcode workspace generate for building, debugging and
  15. testing the FirebaseCrashlytics CocoaPod.
  16. ### Running Unit Tests
  17. Open the generated workspace, choose the FirebaseCrashlytics-Unit-unit scheme and press Command-u.
  18. ### Changing crash report uploads (using GDT)
  19. #### Update report proto
  20. If the crash report proto needs to be updated, follow these instructions:
  21. - Update `ProtoSupport/Protos/crashlytics.proto` with the new changes
  22. - Depending on the type of fields added/removed, also update `ProtoSupport/Protos/crashlytics.options`.
  23. `CALLBACK` type fields in crashlytics.nanopb.c needs to be changed to `POINTER`
  24. (through the options file). Known field types that require an entry in crashlytics.options are
  25. `strings`, `repeated` and `bytes`.
  26. - Run `generate_project.sh` to update the nanopb .c/.h files.