Adding the License Key to CI/CD Services

This article describes how to set up and activate your Telerik Reporting license across a few popular CI/CD services by using deployment keys.

Deployment keys are a dedicated type of license key for build pipelines. They are tied to a specific application and the set of products that the application uses.

Deployment keys cannot be used for application development.

When working with CI/CD platforms, always add the Telerik.Licensing NuGet package as a project dependency. This package activates Telerik Reporting at build time by using the provided license key.

To activate your license in a CI/CD environment:

1. Navigate to the Deployment Keys page.
2. Click Add Application. In the form that opens:
   • Add the application name.
   • Select the type of application—public or private.
   • Select the set of products used in the application.
3. Copy the key value and store it securely.
4. Create an environment variable named TELERIK_LICENSE and set it to the obtained key value.

Alternatively, the key can be stored in a telerik-license.txt file, for example when using the Azure Secure files approach.

Creating an Environment Variable

The recommended approach for providing your license key to the Telerik.Licensing NuGet package is to use environment variables.

Each CI/CD platform has a different process for setting environment variables, and this article lists only some of the most popular examples.

If your CI/CD service is not listed in this article, don’t hesitate to contact Telerik technical support.

GitHub Actions

1. Create a new Repository Secret or an Organization Secret.

2. Set the name of the secret to TELERIK_LICENSE and paste the contents of the license file as a value.

3. After running npm install or yarn, add a build step to activate the license:

   YAML

   env:
       TELERIK_LICENSE: $

Azure Pipelines (YAML)

1. Create a new secret variable named TELERIK_LICENSE.
2. Paste the contents of the license key file as a value.

Always consider the Variable size limit—if you are using a Variable Group, the license key will typically exceed the character limit for the variable values. The only way to have a long value in the Variable Group is to link it from Azure Key Vault. If you cannot use a Key Vault, then use a normal pipeline variable instead (see above) or the Secure files approach.

Using Secure Files on Azure DevOps

Secure files are an alternative approach for sharing the license key file in Azure Pipelines that does not have the size limitations of environment variables.

You have two options for the file-based approach. Set the TELERIK_LICENSE_PATH variable or add a file named telerik-license.txt to the project directory or parent directory.

Make sure you’re referencing Telerik.Licensing v1.4.10 or later.

YAML Pipeline

With a YAML pipeline, you can use the DownloadSecureFile@1 task, then use $(name.secureFilePath) to reference it. For example:

YAML

- task: DownloadSecureFile@1
    name: DownloadTelerikLicenseFile # defining the 'name' is important
    displayName: 'Download Telerik License Key File'
    inputs:
        secureFile: 'telerik-license.txt'

- task: MSBuild@1
    displayName: 'Build Project'
    inputs:
        solution: 'myapp.csproj'
        platform: Any CPU
        configuration: Release
        msbuildArguments: '/p:RestorePackages=false'
env:
    # use the name.secureFilePath value to set TELERIK_LICENSE_PATH
    TELERIK_LICENSE_PATH: $(DownloadTelerikLicenseFile.secureFilePath)

Classic Pipeline

With a classic pipeline, use the “Download secure file” task and a PowerShell script to set TELERIK_LICENSE_PATH to the secure file path.

1. Add a "Download secure file" task and set the output variable's name to telerikLicense.

   

2. Add a PowerShell task and set the TELERIK_LICENSE_PATH variable to the secureFilePath property of the output variable:

The script to set the environment variable is quoted below:

powershell

Write-Host "Setting TELERIK_LICENSE_PATH to $(telerikLicense.secureFilePath)"
Write-Host "##vso[task.setvariable variable=TELERIK_LICENSE_PATH;]$(telerikLicense.secureFilePath)"

Alternatively, copy the file into the repository directory:

powershell

echo "Copying $(telerikLicense.secureFilePath) to $(Build.Repository.LocalPath)/telerik-license.txt"
Copy-Item -Path $(telerikLicense.secureFilePath) -Destination "$(Build.Repository.LocalPath)/telerik-license.txt" -Force

Using TelerikLicensing.Register method

As of version 1.6.7, Telerik.Licensing offers the parameterless TelerikLicensing.Register() method and the TelerikLicensing.Register(…script key…) methods allowing the developers to validate the Telerik license when running in AWS Lambda functions, plugins, or class libraries that use Telerik Reporting consumed by any third-party software.

Invoke the Register method in the body of the function where Telerik Reporting code will be executed. This way, the Telerik license will be validated, and the watermark should not be printed (for licensed users) in the generated document:

C#

using Amazon.Lambda.Core;
using System;
using System.Reflection;
using Telerik.Licensing;

namespace LicensingInLambda;

public class Function
{
    public string FunctionHandler(string input, ILambdaContext context)
    {
        // Lambda function entry point

        // This requires Telerik.Licensing to be added to the function project
        TelerikLicensing.Register();

        // TODO: Reporting - generate PDF here

        var entryAssembly = Assembly.GetEntryAssembly();
        var name = entryAssembly?.GetName();

        return $"Entry assembly: {entryAssembly?.GetName()} ... {Class1.DoYourMagic()}";
    }
}

See Also

• License Activation Errors and Warnings
• Setting Up Your License Key
• Frequently Asked Questions about Your Telerik Reporting License Key