Skip to main content

Setting Up Appcircle Testing Distribution Plugin

The Appcircle Testing Distribution plugin allows users to upload their apps and start distribution to test groups or individuals.

System Requirements​

Compatible Agents:

  • macOS 14.2, 14.5

Supported Version:

  • Jenkins 2.440.3
caution

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

Install Appcircle Testing Distribution Plugin​

Go to your Jenkins dashboard and navigate to Manage Jenkins > Manage Plugins. Then, search for "Appcircle Testing Distribution" in the available plugins section.

Add Plugin in Build Steps​

Go to your configuration page of the project add a build step.

Configure Plugin​

After adding the plugin to your build steps, ensure that you provide all required inputs. Additionally, remember to place the plugin after your build steps as you will need to specify the build path later on.

Adding the Plugin to Your Pipeline​

   stage('Publish') {
      environment {
         AC_PAT = credentials('AC_PAT')
      }
       steps {
          appcircleTestingDistribution personalAPIToken: AC_PAT,
                  profileName: 'PROFILE_NAME',
                  createProfileIfNotExists: false,
                  appPath: 'APP_PATH',
                  message: 'MESSAGE'
       }
   }
  • personalAPIToken: The Appcircle Personal API token is used to authenticate and secure access to Appcircle services. Add this token to your credentials to enable its use in your pipeline and ensure authorized actions within the platform.
  • profileName: Specifies the profile that will be used for uploading the app.
  • createProfileIfNotExists: Ensures that a user profile is automatically created if it does not already exist; if the profile name already exists, the app will be uploaded to that existing profile instead.
  • appPath: Indicates the file path to the application package that will be uploaded to Appcircle Testing Distribution Profile.
  • message: Your message to testers, ensuring they receive important updates and information regarding the application.
Build Steps Order

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

caution

If multiple workflows start simultaneously, the order in which versions are shared in the Testing Distribution is determined by the execution order of the publish step. The version that completes its build and triggers the publish plugin first will be shared first, followed by the others in sequence.

References​