Skip to content
master
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

TPA plugin

Build Status Gem fastlane Plugin Badge

TPA gives you advanced user behaviour analytics, app distribution, crash analytics and more.

Getting Started | Overview | Issues and Feedback | License

Getting Started

This project is a fastlane plugin. To get started with fastlane-plugin-tpa, add it to your project by running:

fastlane add_plugin tpa

Environment Variables

It can be very helpful to set up your TPA credentials in .env files. The following keys are available:

  • FL_TPA_BASE_URL: The base url for your TPA instance
  • FL_TPA_API_UUID: The API UUID for your TPA project
  • FL_TPA_API_KEY: Your personal TPA API key

Overview

This plugin makes interacting with TPA easy by providing you actions to upload .ipa, .apk, .aab and .dSYM files directly to TPA.

In particular, this plugin provides the following two actions:

  • upload_to_tpa: uploads either an iOS .ipa app together with its corresponding dSYM to TPA. It is also capable of uploading an Android .apk or .aab app to TPA.
  • tpa alias for upload_to_tpa
  • upload_symbols_to_tpa: Uploads only dSYM files to TPA

upload_to_tpa

Use the upload_to_tpa action (or the alias tpa) in order to upload an app to TPA. A common building lane would look something like the following:

desc 'Builds a beta version of the app and uploads it to TPA'
lane :beta do
  build_app                  # Builds the app
  upload_to_tpa              # Uploads the app and dSYM files to TPA
end

upload_symbols_to_tpa

If you have bitcode enabled in your iOS app, then you will need to download the dSYM files from App Store Connect and upload them to TPA so that the crash reports can be symbolicated. In order to help with this process, then you can make use of the upload_symbols_to_tpa action.

This action should be part of the download_dsyms action which is part of Fastlane.

We recommend setting up a CI server which runs on a regular basis (for example once every night) to refresh the dSYM files. Such a lane could look like the following:

desc 'Downloads the dSYM files from App Store Connect and uploads them to TPA'
lane :refresh_dsym do
  download_dsyms             # Download dSYM files from App Store Connect
  upload_symbols_to_tpa      # Upload them to TPA
  clean_build_artifacts      # Delete the local dSYM files
end

Instead of downloading all the dSYM files, then an alternative lane could look like the following:

desc 'Downloads the dSYM files from App Store Connect and uploads them to TPA'
lane :refresh_dsym do
  download_dsyms(version: 'latest')    # Download dSYM files from App Store Connect
  upload_symbols_to_tpa                # Upload them to TPA
  clean_build_artifacts                # Delete the local dSYM files
end

Example

Check out the example Fastfile to see how to use this plugin. Try it by cloning the repo, running fastlane install_plugins and bundle exec fastlane test.

Run tests for this plugin

To run both the tests, and code style validation, run

rake

To automatically fix many of the styling issues, use

rubocop -a

Issues and Feedback

For any other issues and feedback about this plugin, please submit it to this repository.

Troubleshooting

If you have trouble using plugins, check out the Plugins Troubleshooting doc in the main fastlane repo.

Using fastlane Plugins

For more information about how the fastlane plugin system works, check out the Plugins documentation.

About fastlane

fastlane is the easiest way to automate building and releasing your iOS and Android apps. To learn more, check out fastlane.tools.

License

MIT

About

No description, website, or topics provided.

Resources

License

Packages

No packages published

Languages

You can’t perform that action at this time.