The Telerik Platform product is retired.Learn more

Using Jenkins Build Automation

AppBuilder provides the Telerik AppBuilder Plugin—a Jenkins plugin which lets you use the AppBuilder cloud build services to create automated builds for your mobile apps. The Telerik AppBuilder Plugin produces code signed application packages (IPA, APK or XAP) and does not produce QR codes. You cannot create builds for the developer apps.

To use the Telerik Platform continuous integration offering, you need to install the Telerik AppBuilder Plugin and configure a Jenkins job.

Install the Jenkins Plugin

If you cannot find the Telerik AppBuilder Plugin in the list of available Jenkins plugins, this means that the plugin is still under review and will become available in the next few days.

  1. Verify that you have installed the latest Jenkins Long-Term Support (LTS) Release.
  2. Install the Telerik AppBuilder Plugin for Jenkins.
    1. From your Jenkins management screen, click Manage Plugins.
    2. Click Available.
    3. Search for Telerik AppBuilder Plugin and select the check box for the plugin.
    4. Choose Download now and install after restart.
    5. Wait for the download to complete.
  3. Restart Jenkins.

Create a Jenkins Job

If you are using the extension for Visual Studio or the command-line interface to develop your app on your local file system, you need to create at least one app in the Telerik Platform from which to obtain an App ID and a build token. You need the App ID and the build token to authenticate with the Telerik Platform and the AppBuilder cloud build services. For more information, see Create New App.

  1. In Jenkins, create a new freestyle project and configure any pre- and post-build settings that you want to modify. For example, configure source control or handle TypeScript compilation to JavaScript.
  2. In the Build section, from the Add build step drop-down menu, select Telerik AppBuilder Build Step.
  3. In the Telerik Platform App ID text box, provide the App ID for the Telerik Platform app with which your build token is associated.
    The app must be a Telerik Platform 2.0 app.
    1. In your browser, log in to the Telerik Platform.
    2. Open your app.
    3. Click Settings.
    4. Copy the value for App ID.
    5. Paste the value you copied in the previous step in the Telerik Platform App ID text box in Jenkins.
  4. In the Build Token text box, provide your build token.
    1. In your browser, log in to the Telerik Platform.
    2. Open your app.
    3. Click Settings.
    4. Copy the value for the build access token.
    5. Paste the value you copied in the previous step in the Build Token text box in Jenkins.
  5. Select the build configuration to be applied for the build.
    For more information, see Build Configurations for Hybrid Apps and Build Configurations for NativeScript Apps.
  6. Select the platforms for which you want to produce builds.
    Note that you can build only hybrid apps for Windows Phone.
  7. Provide the code signing information for the platforms which require code signing. For more information, see Code Signing for Build Automation.
  8. Save the job.
  9. Verify that the .abproject for your app is located in the root of your Jenkins workspace.

Retrieve Artifacts

The Telerik AppBuilder Plugin outputs your built packages in the Build Outputs directory in the root of your Jenkins workspace. In this location, you can also find the final manifest files for your application packages. You can inspect the manifest files to determine the complete set of required Android permissions or Windows Phone capabilities, for example.

Inspect Errors

When a build fails, you can inspect its logs in its Console Output. The Telerik AppBuilder Plugin provides detailed Telerik Platform authentication and AppBuilder build output for all configured platforms.

Best Practices

  • (Required) If you want to automate builds for TypeScript-based projects, make sure to handle compiling your TypeScript sources to JavaScript before the build. For example, you can compile to JavaScript before placing your source code in Jenkins or you can install a Jenkins plugin to handle the TypeScript compilation before build.
  • (Recommended) Pull your sources from version control instead of manually placing them in Jenkins.
  • (Recommended) Configure archiving for the artifacts on your post-build actions.
  • (Optional) Use .abignore to further control the contents of the built package. For example, you can exclude the TypeScript definitions from your app. For more information, see Exclude Files From the Application Package.

See Also

Contact us: +1-888-365-2779
Copyright © 2016-2018, Progress Software Corporation and/or its subsidiaries or affiliates. All rights reserved.