AppBox Plugin for Fastlane

1. Getting Started

1.1. Add appbox plugin to your project

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

fastlane add_plugin appbox

1.2. Install AppBox (if you haven't already)

Install AppBox using one of the following methods:

• Direct Install:

  curl -s https://getappbox.com/install.sh | bash

• Homebrew:

  brew install --cask appbox

Now, open AppBox and login with your Dropbox account.

1.3. Configure your Fastfile

Define appbox action in your project Fastfile with emails and message. Here the available params for appbox plugins -

Parameter	Type	Description
emails	String (Optional)	Comma-separated list of email address that should receive application installation link.
message	String (Optional)	A personal message shown under "Message from the developer" in the email, such as 'Here is the latest build.'.
keep_same_link	Bool (Optional)	This feature will keep same short URL for all future build/IPA uploaded with same bundle identifier. Read more here.
slack_webhook_url	String (Optional)	Slack Incoming Webhook URL to post a notification to a Slack channel.
ms_teams_webhook_url	String (Optional)	Microsoft Teams Incoming Webhook URL to post a notification to a Teams channel.
webhook_message	String (Optional)	Deprecated and ignored since AppBox 4, which generates the notification text from the build itself.
dropbox_folder_name	String (Optional)	You can change the link by providing a Custom Dropbox Folder Name. Read more here.
more_details	Bool (Optional)	Show the expanded build details on the install page: minimum iOS version, supported devices, build type, IPA size and provisioning profile.
ipa_link	Bool (Optional)	Show the direct IPA download link on the install page.
previous_versions	Bool (Optional)	Keep earlier builds listed on the install page.
chunk_size	Integer (Optional)	Dropbox upload chunk size in MB, from 1 to 150.

The four install-page settings (more_details, ipa_link, previous_versions and chunk_size) need AppBox 4.1.0 or later. Each one you leave unset falls back to the AppBox app's setting on the build machine, then to the built-in default: details on, IPA link off, previous versions on, 100 MB chunks. Set them in CI so every run uses the same install page, whatever the machine's AppBox is configured for. Each also reads an environment variable: FL_APPBOX_MORE_DETAILS, FL_APPBOX_IPA_LINK, FL_APPBOX_PREVIOUS_VERSIONS and FL_APPBOX_CHUNK_SIZE.

2. Supported AppBox link access via Fastlane SharedValues

• APPBOX_SHARE_URL - AppBox short shareable URL to install uploaded application.
• APPBOX_IPA_URL- Upload IPA file URL to download IPA file.
• APPBOX_MANIFEST_URL - Manifest file URL for upload application.

3. Demo Fastfile with a lane gymbox with Different Options

3.1. Upload IPA file and Send an email to single email.

default_platform(:ios)

platform :ios do
  lane :gymbox do
    gym
    appbox(
        emails: 'you@example.com',
    )
  end
end

3.2. Upload IPA file and Send email to multiple commas separated emails.

default_platform(:ios)

platform :ios do
  lane :gymbox do
    gym
    appbox(
        emails: 'you@example.com,someoneelse@example.com',
    )
  end
end

3.3. Upload IPA file and Send email with a custom message.

default_platform(:ios)

platform :ios do
  lane :gymbox do
    gym
    appbox(
        emails: 'you@example.com',
        message: 'Please test the new checkout flow.',
    )
  end
end

3.4. Upload IPA file and keep the same link for all future upload IPAs.

default_platform(:ios)

platform :ios do
  lane :gymbox do
    gym
    appbox(
        emails: 'you@example.com',
        message: 'Here is the latest build.',
        keep_same_link: true,
    )
  end
end

3.5. Upload IPA file and keep the same link for all future upload IPAs in Custom Dropbox folder.

default_platform(:ios)

platform :ios do
  lane :gymbox do
    gym
    appbox(
        emails: 'you@example.com',
        message: 'Here is the latest build.',
        keep_same_link: true,
        dropbox_folder_name: 'Fastlane-Demo-Keep-Same-Link',
    )
  end
end

3.6. Upload IPA file with fixed install page settings, for CI.

default_platform(:ios)

platform :ios do
  lane :gymbox do
    gym
    appbox(
        emails: 'you@example.com',
        keep_same_link: true,
        more_details: true,
        ipa_link: false,
        previous_versions: true,
        chunk_size: 50,
    )
  end
end

4. About AppBox

AppBox is a tool for iOS developers to build and deploy Development, Ad-Hoc and In-house (Enterprise) applications directly to the devices from your Dropbox account. Also, available on Github.

5. 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.

6. Issues and Feedback

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

7. Troubleshooting

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

8. Support

If this plugin has been useful to you, consider supporting the continued development of AppBox.

 

Thank you for supporting open source! 🙏