Skip to main content

Circle CI

CircleCI is a cloud-based CI/CD service that helps developers automate their development process with CI hosted in the cloud or on a private server.

TestFairy has a CircleCI "ORB", allowing you to upload builds to TestFairy smoothly.

To use the ORB, add the following line to the orbs section of your .circleci/config.yml:

orbs:
testfairy: testfairy/uploader@2.0.1

Then, upload your .IPA or .APK, you'll have to call testfairy/uploader, providing the path to the file and your API key. As an example of creating, add the following command:

jobs:
build:
# ...
steps:
# ... steps to build IPA or APK
- testfairy/uploader:
api-key: TESTFAIRY_API_KEY
file: app.apk

TESTFAIRY_API_KEY is the environment variable name containing your API key. Environment variables are the best practice, so you don't commit secret values into your code repository.

You can see the complete list of supported commands by visiting the CircleCI TestFairy ORB Repository.