Skip to main content

Setting Up Appcircle Enterprise App Store Plugin

The Appcircle Enterprise App Store plugin allows users to publish their apps and start distribution to test groups or individuals.

Discover Action​

You can discover more about this action and install it from:

fastlane-plugin-appcircle_enterprise_store | RubyGems.org | your community gem host
No description available
rubygems.org
Preview of fastlane-plugin-appcircle_enterprise_store | RubyGems.org | your community gem host

System Requirements​

Compatible Agents:

  • macOS 14 (arm64)
  • RHEL 9 (x86_64)
  • Ubuntu 22.04 (x86_64)

Supported Version:

  • Fastlane 2.222.0
  • Ruby 3.2.2
caution

Currently, plugins are only compatible to use with Appcircle Cloud. Self-hosted support will be available in future releases.

Getting Started​

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

fastlane add_plugin appcircle_enterprise_app_store

After adding the plugin to your project, configure your Fastfile as follows:

  lane :distribute_app_store do
    appcircle_enterprise_app_store(
      personalAccessKey: "$(AC_PERSONAL_ACCESS_KEY)",
      appPath: "$(APP_PATH)",
      summary: "$(SUMMARY)",
      releaseNotes: "$(RELEASE_NOTE)",
      publishType: "$(PUBLISH_TYPE)" # Assign the appropriate number based on the status: None (0), Beta (1), Live (2)
    )
  end

Authentication Parameters​

The plugin supports two authentication methods. You can use either personalAccessKey (recommended) or personalAPIToken (legacy), but not both at the same time.

  • personalAccessKey (recommended): The Appcircle Personal Access Key used to authenticate and authorize access to Appcircle services. This is the recommended authentication method. The plugin will automatically generate a Personal Access Token (PAT) from your Personal Access Key using the Auth API.

  • personalAPIToken (legacy, optional): The legacy Personal API Token used for authentication. This parameter is maintained for backward compatibility. It is recommended to migrate to personalAccessKey for better security and future compatibility. If you use this parameter, the plugin will use it directly without generating a PAT. For more details, check out the release notes.

  • appPath: Indicates the file path to the application package that will be uploaded to Appcircle Testing Distribution Profile.

  • releaseNotes: Contains the details of changes, updates, and improvements made in the current version of the app being published.

  • summary: Used to provide a brief overview of the version of the app that is about to be published.

  • publishType: Specifies the publishing status as either none, beta, or live, and must be assigned the values "0", "1", or "2" accordingly.

Leveraging Environment Variables​

Utilize environment variables seamlessly by substituting the parameters with $(VARIABLE_NAME) in your task inputs. The extension automatically retrieves values from the specified environment variables within your pipeline.

Build Steps Order

Ensure that this action is added after build steps have been completed.

caution

If two workflows start simultaneously, the last workflow to reach the publish step will be the up-to-date version on the Enterprise App Store. If these workflows building the same package version, the first publish will be successful, while later deployments with the same version will fail.

References​