Giter Club home page Giter Club logo

googledatatransport's Introduction

Version License Platform

Actions Status

GoogleDataTransport

This library is for internal Google use only. It allows the logging of data and telemetry from Google SDKs.

Integration Testing

These instructions apply to minor and patch version updates. Major versions need a customized adaptation.

After the CI is green:

  • Update the version in the podspec
  • Add the CocoaPods tag
    • git tag CocoaPods-{version}
    • git push origin CocoaPods-{version}
  • Push the podspec to SpecsStaging
    • pod repo push staging GoogleDataTransport.podspec
  • Run Firebase CI by waiting until next nightly or adding a PR that touches Gemfile
  • On google3, copybara and run a global TAP which should kick off automatically after each PR.

Publishing

  • Add a version tag for Swift PM
    • git tag {version}
    • git push origin {version}
  • pod trunk push GoogleDataTransport.podspec
  • Clean up SpecsStaging

Set logging level

Swift

  • Import GoogleDataTransport module:
    import GoogleDataTransport
    
  • Set logging level global variable to the desired value before calling FirebaseApp.config():
    GDTCORConsoleLoggerLoggingLevel = GDTCORLoggingLevel.debug.rawValue
    

Objective-C

  • Import GoogleDataTransport:
    #import <GoogleDataTransport/GoogleDataTransport.h>
    
  • Set logging level global variable to the desired value before calling -[FIRApp config]:
    GDTCORConsoleLoggerLoggingLevel = GDTCORLoggingLevelDebug;
    

Prereqs

  • gem install --user cocoapods cocoapods-generate
  • brew install protobuf nanopb-generator
  • easy_install --user protobuf

To develop

  • Run generate_project.sh after installing the prereqs

When adding new logging endpoint

  • Use commands similar to:
    • python -c "line='https://www.firebase.com'; print line[0::2]"
    • python -c "line='https://www.firebase.com'; print line[1::2]"

When adding internal code that shouldn't be easily usable on github

  • Consider using go/copybara-library/scrubbing#cc_scrub

Development

Ensure that you have at least the following software:

For the pod that you want to develop:

pod gen GoogleDataTransport.podspec --local-sources=./ --auto-open --platforms=ios

Note: If the CocoaPods cache is out of date, you may need to run pod repo update before the pod gen command.

Note: Set the --platforms option to macos or tvos to develop/test for those platforms. Since 10.2, Xcode does not properly handle multi-platform CocoaPods workspaces.

Development for Catalyst

  • pod gen GoogleDataTransport.podspec --local-sources=./ --auto-open --platforms=ios
  • Check the Mac box in the App-iOS Build Settings
  • Sign the App in the Settings Signing & Capabilities tab
  • Click Pods in the Project Manager
  • Add Signing to the iOS host app and unit test targets
  • Select the Unit-unit scheme
  • Run it to build and test

Alternatively disable signing in each target:

  • Go to Build Settings tab
  • Click +
  • Select Add User-Defined Setting
  • Add CODE_SIGNING_REQUIRED setting with a value of NO

Code Formatting

To ensure that the code is formatted consistently, run the script ./scripts/check.sh before creating a PR.

GitHub Actions will verify that any code changes are done in a style compliant way. Install clang-format and mint:

brew install clang-format@11
brew install mint

Running Unit Tests

Select a scheme and press Command-u to build a component and run its unit tests.

Contributing

See Contributing for more information on contributing to the Firebase iOS SDK.

License

The contents of this repository is licensed under the Apache License, version 2.0.

googledatatransport's People

Contributors

bhaktipriya avatar bjhomer avatar charlotteliang avatar ddnan avatar dependabot[bot] avatar granluo avatar itslazyvar avatar jasonhu-g avatar jeremyjiang-dev avatar maksymmalyhin avatar mikehaney24 avatar mikelehen avatar morganchen12 avatar paulb777 avatar pranavrajgopal avatar ryanwilson avatar samedson avatar tejasd avatar ulukaya avatar vimanyu avatar visumickey avatar wilhuff avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.