Adding Your License Key to CI/CD Services
This article describes how to set up and activate your Telerik JustMock license key across popular CI/CD services.
The license activation process in a CI/CD environment involves the following steps:
-
Download a license key from your Telerik account.
-
Create an environment variable named
TELERIK_LICENSEand add your Telerik JustMock license key as a value.
Creating an Environment Variable
The recommended approach for providing your license key 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.
Azure Pipelines
-
Create a new user-defined variable named
TELERIK_LICENSE. -
Paste the contents of the license key file as a value.
If your CI/CD service is not listed in this article, contact the Telerik technical support.
GitHub Actions
-
Create a new Repository Secret or an Organization Secret.
-
Set the name of the secret to
TELERIK_LICENSEand paste the contents of the license file as a value. -
Update the build step that executes the tests. For example, in a GitHub Actions workflow, you can include the following step in your YAML configuration:
- name: Run Tests with Telerik JustMock
env:
TELERIK_LICENSE: ${{ secrets.TELERIK_LICENSE }}
run: |
# Your test execution command goes here
Azure Pipelines
-
Create a new secret variable named
TELERIK_LICENSE. -
Paste the contents of the license key file as a value.
Note 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 a Variable Group is to link it from Azure Key Vault. If you cannot use a Key Vault, use a normal pipeline variable instead (see above) or use the Secure Files approach instead.
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 can set the TELERIK_LICENSE_PATH environment variable.
YAML Pipeline
With a YAML pipeline, you can use the DownloadSecureFile@1 task, then use $(name.secureFilePath) to reference it. For example:
- 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.
-
Add a "Download secure file" task and set the output variable's name to
telerikLicense.
-
Add a PowerShell task and set the
TELERIK_LICENSE_PATHenvironment variable to thesecureFilePathproperty of the output variable:
powershellWrite-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:
powershellecho "Copying $(telerikLicense.secureFilePath) to $(Build.Repository.LocalPath)/telerik-license.txt" Copy-Item -Path $(telerikLicense.secureFilePath) -Destination "$(Build.Repository.LocalPath)/telerik-license.txt" -Force