Fastlane Plugin — TestApp.io

Fastlane plugin to upload both Android and iOS apps to TestApp.io to notify everyone for testing and feedback.

Getting Started

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

fastlane add_plugin testappio

Configuration

Key	Description	Env Var(s)	Default
api_token	You can get it from https://portal.testapp.io/profile/tokens	TESTAPPIO_API_TOKEN
app_id	You can get it from your app page at https://portal.testapp.io/apps	TESTAPPIO_APP_ID
release	It can be either both or Android or iOS	TESTAPPIO_RELEASE
apk	Path to the Android APK file	TESTAPPIO_ANDROID_PATH
ipa	Path to the iOS IPA file	TESTAPPIO_IOS_PATH
release_notes	Manually add the release notes to be displayed for the testers	TESTAPPIO_RELEASE_NOTES
git_release_notes	Collect release notes from the latest git commit message to be displayed for the testers: true or false	TESTAPPIO_GIT_RELEASE_NOTES	true
git_commit_id	Include the last commit ID in the release notes (works with both release notes options): true or false	TESTAPPIO_GIT_COMMIT_ID	false
notify	Send notifications to your team members about this release: true or false	TESTAPPIO_NOTIFY	false

Check TA-CLI for more info

TestApp.io Action

Actions provided by the CLI: ta-cli

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.

The following code snippet shows the parameters that the upload_to_testappio action supports.

upload_to_testappio(
  api_token: "API_TOKEN",
  app_id: "APP_ID",
  release_notes: "My release notes here...",
  git_release_notes: true,
  git_commit_id: false,
  notify: true
)

💡 You can replace all the parameters with environment variables: configuration

⚠️ API_TOKEN and APP_ID should be kept secret. We strongly recommend using environment variables instead.

💪 [release/apk_file/ipa_file] for Android/iOS projects can be omitted — the plugin detects the context and fills them automatically.

To upload after the Fastlane gym action:

iOS

lane :beta do

  increment_build_number
  match(type: "adhoc")
  gym(export_method: "ad-hoc")

  upload_to_testappio(
    release_notes: "My release notes here...",
    git_release_notes: true,
    git_commit_id: false,
    notify: true
  )

  clean_build_artifacts #optional

end

And finally 🎉

fastlane ios beta

Android

Optional:

fastlane add_plugin increment_version_code

lane :beta do

  increment_version_code #[Optional] fastlane add_plugin increment_version_code

  gradle(task: "clean assembleRelease") #or clean assembleDebug

  upload_to_testappio(
    release_notes: "My release notes here...",
    git_release_notes: true,
    git_commit_id: false,
    notify: true
  )

end

And finally 🎉

fastlane android beta

Troubleshooting

If you have trouble using plugins, check out the Plugins Troubleshooting guide.

Using Fastlane Plugins

Check out the Plugins documentation for more information about how the plugin system works.

About Fastlane

Fastlane is the easiest way to automate beta deployments and releases for iOS and Android apps. To learn more, check out fastlane.tools.

Setup iOS Project for Fastlane

Tip: Once your CI/CD pipeline uploads a build, team members using the TestApp.io mobile app receive a push notification and can install the build with a single tap. You can also create share links to distribute builds to external testers and clients.

Need help? Contact us — we're happy to assist!