Skip to content

Commit 8351b9b

Browse files
authored
docs(common): Improve CICD licensing information (#2794)
1 parent 72a08ec commit 8351b9b

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

deployment/ci-cd-license-key.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,16 +16,14 @@ This article describes how to set up and activate your [Telerik UI for Blazor li
1616

1717
## Basics
1818

19-
When working with CI/CD platforms, always add the [`Telerik.Licensing` NuGet package](slug:getting-started/what-you-need#nuget-packages) as a project dependency. This package activates the Telerik Blazor components at build time by using the provided license key.
19+
The Telerik license activation process in a CI/CD environment involves the following steps:
2020

21-
The license activation process in a CI/CD environment involves the following steps:
22-
23-
1. Add the `Telerik.Licensing` NuGet package as a dependency to all projects that reference Telerik UI for Blazor or Telerik Document Processing:
21+
1. Add the `Telerik.Licensing` NuGet package as a dependency to all projects that reference Telerik UI for Blazor or Telerik Document Processing. This package activates the Telerik products at build time by using the provided license key.
2422
````XML.skip-repl
2523
<PackageReference Include="Telerik.Licensing" Version="1.*" />
2624
````
27-
1. Go to the <a href="https://www.telerik.com/account/your-licenses/license-keys" target="_blank">License Keys page</a> in your Telerik account and get your license key.
28-
1. Set your license key value as an environment variable with a name `TELERIK_LICENSE`.
25+
1. Go to the [License Keys page](https://www.telerik.com/account/your-licenses/license-keys) in your Telerik account and download your license key.
26+
1. Set your license key value as an [environment variable](#creating-environment-variables) with a name `TELERIK_LICENSE`. In specific cases you may need to [use a license file](#using-license-file) instead.
2927
3028
## Creating Environment Variables
3129
@@ -36,6 +34,8 @@ The recommended way to provide your license key to the `Telerik.Licensing` NuGet
3634
1. Create a new [user-defined variable](https://learn.microsoft.com/en-us/azure/devops/pipelines/process/variables) named `TELERIK_LICENSE`, according to your [YAML](https://learn.microsoft.com/en-us/azure/devops/pipelines/process/variables?view=azure-devops&tabs=yaml%2Cbatch#set-variables-in-pipeline) or [Classic](https://learn.microsoft.com/en-us/azure/devops/pipelines/process/variables?view=azure-devops&tabs=classic%2Cbatch#set-variables-in-pipeline) pipeline setup.
3735
1. Paste the contents of the license key file as a value of the variable.
3836
37+
> Another option is to use a Telerik license file as a [secure file in the pipeline](https://learn.microsoft.com/en-us/azure/devops/pipelines/library/secure-files). Implement a [script that copies the license file](https://learn.microsoft.com/en-us/azure/devops/pipelines/library/secure-files?view=azure-devops#consume-a-secure-file-in-a-pipeline) to the application's root folder, so that it's available to all projects that need it.
38+
3939
### GitHub Actions
4040
4141
1. Create a new [Repository Secret](https://docs.github.com/en/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-a-repository) or an [Organization Secret](https://docs.github.com/en/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-an-organization).
@@ -65,6 +65,10 @@ The recommended way to provide your license key to the `Telerik.Licensing` NuGet
6565
1. [Create a Docker build secret](https://docs.docker.com/build/building/secrets/#using-build-secrets) that holds the Telerik license key file.
6666
1. [Mount the secret](https://docs.docker.com/build/building/secrets/#secret-mounts) and set a `TELERIK_LICENSE` [environment variable in the container](https://docs.docker.com/build/building/secrets/#target).
6767
68+
## Using License File
69+
70+
Use a license file on Windows and Windows Server machines, which are managed directly through the operating system's user interface. Do not use an environment variable in these cases.
71+
6872
## Next Steps
6973
7074
* [Restore Telerik NuGet Packages in CI/CD Workflows](slug:deployment-nuget)

0 commit comments

Comments
 (0)