App Center fastlane plugin

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

fastlane add_plugin appcenter

fastlane v2.96.0 or higher is required for all plugin-actions to function properly.

With App Center you can continuously build, test, release, and monitor your apps. This plugin provides a set of actions to interact with App Center.

appcenter_fetch_devices allows you to obtain the list of iOS devices to distribute an app to (useful for automatic provisioning of testers' devices).

appcenter_upload allows you to upload and distribute apps to your testers on App Center as well as to upload .dSYM files to collect detailed crash reports in App Center.

appcenter_fetch_version_number allows you to obtain the latest version number (short or full) for an app. This is useful for tasks such as getting the latest version of an app so that an increment action can take place on CI, or checking that an upload has been successful.

appcenter_codepush_release_react allows you to deploy app updates via CodePush.

To get started, first, obtain an API token in App Center. The API Token is used to authenticate with the App Center API in each call.

appcenter_fetch_devices(
  api_token: "<appcenter token>",
  owner_name: "<appcenter account name of the owner of the app (username or organization URL name)>",
  app_name: "<appcenter app name>",
  destinations: "*", # Default is 'Collaborators', use '*' for all distribution groups
  devices_file: "devices.txt" # Default. If you customize, the extension must be .txt
)

appcenter_upload(
  api_token: "<appcenter token>",
  owner_name: "<appcenter account name of the owner of the app (username or organization URL name)>",
  owner_type: "user", # Default is user - set to organization for appcenter organizations
  app_name: "<appcenter app name (as seen in app URL)>",
  file: "<path to android build binary>",
  notify_testers: true # Set to false if you don't want to notify testers of your new release (default: `false`)
)

appcenter_fetch_version_number(
  api_token: "<appcenter token>",
  owner_name: "<appcenter account name of the owner of the app (username or organization URL name)>",
  app_name: "<appcenter app name (as seen in app URL)>",
  version: "a specific version to get the last release for" # optional, don't set this value to get the last upload of all versions
)

The appcenter_fetch_version_number returns a hash that contains the id, the version number, and the build number. The version corresponds to the short_version and the build number to the version known by App Center for a given release:

{"id"=>1, "version"=>"1.0.0", "build_number"=>"1.0.0.1234"} # iOS apps contain the full version plus build number due to the way that Apple use CFBundleVersion for this value
{"id"=>588, "version"=>"1.2.0", "build_number"=>"1615"}

appcenter_codepush_release_react(
  api_token: "<appcenter token>",
  owner_name: "<appcenter account name of the owner of the app (username or organization URL name)>",
  app_name: "<appcenter app name (as seen in app URL)>",
  deployment: "Staging"
)

Once installed, information and help for an action can be printed out with this command:

fastlane action appcenter_upload # or any action included with this plugin

The app_name and owner_name as set in the Fastfile come from the app's URL in App Center, in the below form:

https://appcenter.ms/users/{owner_name}/apps/{app_name}

They should not be confused with the displayed name on App Center pages, which is called app_display_name instead.

The action parameters api_token, owner_name, app_name, and others can also be omitted when their values are set as environment variables. By default, appcenter_upload will use the same api_token, owner_name, and app_name you used in appcenter_fetch_devices.

Here is the list of all existing parameters:

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

Sample uses .env for setting private variables like API token, owner name, .etc. You need to replace it in Fastfile by your own values.

There are three examples in test lane:

• upload release for android with minimum required parameters
• upload release for ios with all set parameters
• upload only dSYM file for ios

Check out this example Fastfile for a full example of fetching devices, registering them with Apple, provisioning the devices, and signing an app.

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

rake

To automatically fix many of the styling issues, use

rubocop -a

For any other issues and feedback about this plugin, please open a GitHub issue.

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

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

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

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Check out SECURITY.md for any security concern with this project.

We're on Twitter as @vsappcenter. Additionally you can reach out to us on the App Center portal. Open the "?" menu on the top right corner of screen, then use "Contact support" to file a support ticket. Our support team is there to answer your questions and help you solve your problems.