1. testfairy/uploader@2.0.1

testfairy/uploader@2.0.1

Partner
Sections
Upload a new build to TestFairy.
Created: June 2, 2020Version Published: June 8, 2020Releases: 3
Org Usage:
< 25

Orb Quick Start Guide

Use CircleCI version 2.1 at the top of your .circleci/config.yml file.

1 version: 2.1

Add the orbs stanza below your version, invoking the orb:

1 2 orbs: uploader: testfairy/uploader@2.0.1

Use uploader elements in your existing workflows and jobs.

Opt-in to use of uncertified orbs on your organization’s Security settings page.

Commands

uploader

Show command Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
file
APK or IPA file data.
Yes
-
string
api-key
The envrionment variable name containing your API application key. See https://app.testfairy.com/settings for details.
Yes
-
env_var_name
symbols-file
Symbols mapping file. For iOS this should be a path to the zipped symbols file. For Android, this is the path to the mappings.txt file
No
''
string
testers-groups
Either a comma-separated list of tester groups to be invited on the new build, or "all" to invite all testers.
No
''
string
notify
Send email to all users in tester_groups. The default is "on".
No
'on'
enum
auto-update
Allows an easy upgrade of all users to the current version. The default is "off", to enable set as "on".
No
'off'
enum
tags
Set of comma-separated tags to be displayed and search upon.
No
''
string
server-endpoint
API URL for TestFairy. The default is https://upload.testfairy.com
No
https://upload.testfairy.com
string
changelog
Changelog for this upload.
No
''
string

Orb Source

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 # This code is licensed from CircleCI to the user under the MIT license. # See here for details: https://circleci.com/developer/orbs/licensing version: 2.1 description: Upload a new build to TestFairy. display: home_url: https://www.testfairy.com/ source_url: https://github.com/testfairy/circleci-testfairy-orb commands: uploader: parameters: file: description: APK or IPA file data. type: string api-key: description: The envrionment variable name containing your API application key. See https://app.testfairy.com/settings for details. type: env_var_name symbols-file: description: Symbols mapping file. For iOS this should be a path to the zipped symbols file. For Android, this is the path to the mappings.txt file type: string default: "" testers-groups: description: Either a comma-separated list of tester groups to be invited on the new build, or "all" to invite all testers. type: string default: "" notify: description: Send email to all users in tester_groups. The default is "on". type: enum enum: ["on", "off"] default: "on" auto-update: description: Allows an easy upgrade of all users to the current version. The default is "off", to enable set as "on". type: enum enum: ["on", "off"] default: "off" tags: description: Set of comma-separated tags to be displayed and search upon. type: string default: "" server-endpoint: description: API URL for TestFairy. The default is https://upload.testfairy.com type: string default: https://upload.testfairy.com changelog: description: Changelog for this upload. type: string default: "" steps: - run: name: Uploading app to TestFairy command: | CHANGELOG="<< parameters.changelog >>" if [ -z "${CHANGELOG}" ]; then CHANGELOG=$(git log --format=oneline -n 1 $CIRCLE_SHA1) fi SYMBOLS="<< parameters.symbols-file >>" if [ ! -z "${SYMBOLS}" ]; then SYMBOLS="@${SYMBOLS}" fi JSON=$( curl -s << parameters.server-endpoint >>/api/upload/ \ -F api_key="$<< parameters.api-key >>" \ -F file="@<< parameters.file >>" \ -F symbols_file="${SYMBOLS}" \ -F auto-update="<< parameters.auto-update >>" \ -F notify="<< parameters.notify >>" \ -F testers-groups="<< parameters.testers-groups >>" \ -F tags="<< parameters.tags >>" \ -F changelog="${CHANGELOG}" \ -A "TestFairy CircleCI Uploader" ) URL=$( echo ${JSON} | sed 's/\\\//\//g' | sed -n 's/.*"build_url"\s*:\s*"\([^"]*\)".*/\1/p' ) if [ -z "$URL" ]; then echo "Upload failed ${JSON}" exit 1 fi echo "Build was successfully uploaded to TestFairy and is available at:" echo ${URL}
Developer Updates
Get tips to optimize your builds
Or join our research panel and give feedback
By submitting this form, you are agreeing to ourTerms of UseandPrivacy Policy.