You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: blazor/common/deployment.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -96,7 +96,7 @@ To enable AOT compilation in the application, add `RunAOTCompilation` options wi
96
96
*[Host and deploy Blazor](https://learn.microsoft.com/en-us/aspnet/core/blazor/host-and-deploy)
97
97
*[Host and deploy Blazor Server](https://learn.microsoft.com/en-us/aspnet/core/blazor/host-and-deploy/server/)
98
98
*[Host and deploy ASP.NET Core Blazor WebAssembly](https://learn.microsoft.com/en-us/aspnet/core/blazor/host-and-deploy/webassembly)
99
-
*[Publish a web app to Azure App Service using Visual Studio](https://learn.microsoft.com/en-us/visualstudio/deployment/quickstart-deploy-aspnet-web-app?view=vs-2022&tabs=azure)
99
+
*[Publish a Web App to Azure App Service using Visual Studio](https://learn.microsoft.com/en-us/visualstudio/deployment/quickstart-deploy-aspnet-web-app?view=vs-2022&tabs=azure)
100
100
*[Deploy ASP.NET Core apps to Azure App Service](https://learn.microsoft.com/en-us/aspnet/core/host-and-deploy/azure-apps)
101
101
*[Deploy Blazor WASM App to Cloudflare](https://www.syncfusion.com/blogs/post/easily-deploy-a-blazor-webassembly-app-to-cloudflare)
102
102
*[Publish a Blazor WebAssembly App and .NET API with Azure Static Web Apps](https://learn.microsoft.com/en-us/training/modules/publish-app-service-static-web-app-api-dotnet/)
Copy file name to clipboardExpand all lines: blazor/getting-started/license-key/CI-license-validation.md
+20-26Lines changed: 20 additions & 26 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,9 @@
1
1
---
2
2
layout: post
3
-
title: Overview of Syncfusion license validation in CI services - Syncfusion
4
-
description: Learn here about how to register Syncfusion license key for Syncfusion application for license validation.
3
+
title: Validate Syncfusion license keys in CI services - Syncfusion
4
+
description: Learn how to validate Syncfusion Blazor license keys in CI or CD pipelines using the LicenseKeyValidator utility, secure variables, and automated tests.
# Syncfusion<supstyle="font-size:70%">®</sup> license key validation in CI services
19
+
# Validate Syncfusion® license keys in CI services
21
20
22
21
Syncfusion<supstyle="font-size:70%">®</sup> license key validation in CI services ensures that Syncfusion<supstyle="font-size:70%">®</sup> Essential Studio<supstyle="font-size:70%">®</sup> components are properly licensed during CI processes. Validating the license key at the CI level can prevent licensing errors during deployment. Set up the continuous integration process to fail in case the license key validation fails. Validate the passed parameters and the registered license key again to resolve the issue.
23
22
24
-
The following section shows how to validate the Syncfusion<supstyle="font-size:70%">®</sup> license key in CI services.
25
-
26
-
* Download and extract the LicenseKeyValidator.zip utility from the following link: [LicenseKeyValidator](https://s3.amazonaws.com/files2.syncfusion.com/Installs/LicenseKeyValidation/LicenseKeyValidator.zip).
23
+
Follow these steps to validate the Syncfusion<supstyle="font-size:70%">®</sup> license key in CI services.
27
24
28
-
* Open the LicenseKeyValidation.ps1 PowerShell script in a text\code editor as shown in the below example.
25
+
* Download and extract the LicenseKeyValidator.zip utility: [LicenseKeyValidator](https://s3.amazonaws.com/files2.syncfusion.com/Installs/LicenseKeyValidation/LicenseKeyValidator.zip)
26
+
* Open the LicenseKeyValidation.ps1 PowerShell script in a text\code editor and update the parameters as shown below.
* Update the parameters in the LicenseKeyValidation.ps1 script file as described below.
43
-
44
-
**Platform:** Modify the value for /platform: to the actual platform "Blazor".
45
-
46
-
**Version:** Change the value for /version: to the required version (e.g., "26.2.4").
47
-
48
-
**License Key:** Replace the value for /licensekey: with your actual license key (e.g., "Your License Key").
40
+
* Update the parameters in the script:
41
+
***Platform:** Set /platform:"Blazor" (use the relevant Syncfusion platform as needed).
42
+
***Version:** Set /version:"26.2.4" (match the Syncfusion package version used in the build).
43
+
***License key:** Set /licensekey:"Your License Key" (inject via secure variable or secret).
49
44
50
45
## Azure Pipelines (YAML)
51
46
52
-
* Create a new [User-defined Variable](https://learn.microsoft.com/en-us/azure/devops/pipelines/process/variables?view=azure-devops&tabs=yaml%2Cbatch#user-defined-variables) named `LICENSE_VALIDATION` in the Azure Pipeline. Use the path of the LicenseKeyValidation.ps1 script file as a value (e.g., D:\LicenseKeyValidator\LicenseKeyValidation.ps1).
47
+
* Create a [user-defined variable](https://learn.microsoft.com/en-us/azure/devops/pipelines/process/variables?view=azure-devops&tabs=yaml%2Cbatch#user-defined-variables) named `LICENSE_VALIDATION` in the Azure pipeline. Set it to the path of the LicenseKeyValidation.ps1 script (for example, D:\LicenseKeyValidator\LicenseKeyValidation.ps1).
53
48
54
49
* Integrate the PowerShell task in the pipeline and execute the script to validate the license key.
55
50
@@ -61,7 +56,6 @@ pool:
61
56
vmImage: 'windows-latest'
62
57
63
58
steps:
64
-
65
59
- task: PowerShell@2
66
60
inputs:
67
61
targetType: filePath
@@ -77,13 +71,13 @@ steps:
77
71
78
72
* Include the PowerShell task in the pipeline and execute the script to validate the license key.
81
75
82
76
## GitHub actions
83
77
84
78
* To execute the script in PowerShell as part of a GitHub Actions workflow, include a step in the configuration file and update the path of the LicenseKeyValidation.ps1 script file (e.g., D:\LicenseKeyValidator\LicenseKeyValidation.ps1).
85
79
86
-
The following example shows the syntax for validating the Syncfusion<supstyle="font-size:70%">®</sup> license key in GitHub actions.
80
+
The following example validates the Syncfusion<supstyle="font-size:70%">®</sup> license key in GitHub Actions.
description: Learn how to diagnose and resolve common Syncfusion Blazor licensing errors, including unregistered, invalid, expired, platform mismatch, version mismatch keys.
Licensing error popup is displayed with various messages under different circumstances. Here are some ways to resolve different issues.
12
+
Licensing pop-ups can appear with different messages depending on the scenario. Use the guidance below to identify the message and apply the appropriate fix.
13
13
14
14
## Licensing errors
15
15
16
-
### License key not registered\Trial Expired
16
+
### License key not registered or trial expired
17
17
18
-
The following error message will be shown if a Syncfusion<supstyle="font-size:70%">®</sup> license key has not been registered in your application or if the trial key has expired after 30 days.
18
+
This message appears when a license key is not registered in the application or a trial key has passed the 30‑day evaluation period.
19
19
20
-
**Error message:** This application was built using a trial version of Syncfusion<supstyle="font-size:70%">®</sup> Essential Studio<supstyle="font-size:70%">®</sup>. You should include the valid license key to remove the license validation message permanently.
20
+
**Error message:** This application was built using a trial version of Syncfusion<supstyle="font-size:70%">®</sup> Essential Studio<supstyle="font-size:70%">®</sup>. Include a valid license to permanently remove this license validation message.
21
21
22
22
23
23
24
24
**Solution:**
25
25
26
-
* If you use Blazor components through trial installer or obtained our components via [NuGet.org](https://www.nuget.org/packages?q=syncfusion), you can choose from the options listed below
26
+
* If using Blazor components through trial installer or obtained our components via [NuGet.org](https://www.nuget.org/packages?q=syncfusion), use one of the following options.
27
27
28
28
1. If you **have a valid Syncfusion<supstyle="font-size:70%">®</sup> license**, you can **generate a license key for a specific version and product** from [this page](https://www.syncfusion.com/account/downloads).
29
29
@@ -35,21 +35,21 @@ The following error message will be shown if a Syncfusion<sup style="font-size:7
35
35
36
36
4. If you **do not already have a Syncfusion<supstyle="font-size:70%">®</sup> account**, you can create one [here](https://www.syncfusion.com/account/register) and [purchase a license](https://www.syncfusion.com/sales/products) or start your 30-day free trial. Then you can **generate the trial license key for a specific version and platform** from [this page](https://www.syncfusion.com/account/manage-trials/start-trials).
37
37
38
-
5.Also, you can generate the license key from claim license key page by clicking the **"Claim your FREE account"** click from the licensing warning message. Refer to this [help topic](https://blazor.syncfusion.com/documentation/getting-started/license-key/how-to-generate#Claim-License-Key) for more details.
38
+
5.You can also generate a license key from the Claim license key page by selecting “Claim your FREE account” in the warning dialog. Refer to this [help topic](https://blazor.syncfusion.com/documentation/getting-started/license-key/how-to-generate#Claim-License-Key) for more details.
39
39
40
-
*In your application, register the generated license key. Refer to this [help topic](https://blazor.syncfusion.com/documentation/getting-started/license-key/how-to-register-in-an-application) for information on registering the license key.
40
+
*Register the generated license key in the application. Refer to this [help topic](https://blazor.syncfusion.com/documentation/getting-started/license-key/how-to-register-in-an-application) for information on registering the license key.
41
41
42
42
### Invalid key
43
43
44
44
If the application is registered with an invalid key, another version of license key, or another platform's license key, the following error message will pop up when launching the application.
45
45
46
-
**Error Message:** The included Syncfusion<supstyle="font-size:70%">®</sup> license key is invalid.
46
+
**Error message:** The included Syncfusion<supstyle="font-size:70%">®</sup> license key is invalid.
47
47
48
48
49
49
50
50
**Solution:**
51
51
52
-
* If you use Blazor components through trial installer or obtained our components via [NuGet.org](https://www.nuget.org/packages?q=syncfusion), you can choose from the options listed below
52
+
* If you use Blazor components through trial installer or obtained our components via [NuGet.org](https://www.nuget.org/packages?q=syncfusion), use one of the following options:
53
53
54
54
1. If you have a valid Syncfusion<supstyle="font-size:70%">®</sup> license, you can **generate a license key for a specific version and product** from [this page](https://www.syncfusion.com/account/downloads).
55
55
@@ -123,7 +123,7 @@ The following error message will be shown if the trial key has expired after 30
123
123
124
124
125
125
126
-
**Solution:** <br /> Purchase from [here](https://www.syncfusion.com/sales/products) to get a valid Syncfusion<supstyle="font-size:70%">®</sup> license.
126
+
**Solution:** <br /> Purchase a license [here](https://www.syncfusion.com/sales/products)
127
127
128
128
### Platform Mismatch
129
129
@@ -171,12 +171,12 @@ If the application is registered with another version’s license key, the follo
171
171
172
172
### Facing licensing error message even after registering proper license keys
173
173
174
-
1. Ensure that respective version [Syncfusion.Licensing](https://www.nuget.org/packages/Syncfusion.Licensing/)nuget package or assembly is referred properly in the application.
174
+
1. Ensure the [Syncfusion.Licensing](https://www.nuget.org/packages/Syncfusion.Licensing/)NuGet package or assembly matches the version used by other Syncfusion<supstyle="font-size:70%">®</sup> packages in the application.
175
175
176
-
2.Ensure that all the Syncfusion<supstyle="font-size:70%">®</sup> assemblies referenced are of the same version and that the corresponding version and product's license key are registered in the application.
176
+
2.Verify all referenced Syncfusion<supstyle="font-size:70%">®</sup> assemblies are the same version and that a matching platform/version license key is registered in the application.
177
177
178
-
3.The license key should be registered before initializing any Syncfusion<supstyle="font-size:70%">®</sup> controls in the application. Refer [this](https://blazor.syncfusion.com/documentation/getting-started/license-key/how-to-register-in-an-application) page for more information on registering license keys.
178
+
3.Register the license key before initializing any Syncfusion<supstyle="font-size:70%">®</sup> component. Refer [this](https://blazor.syncfusion.com/documentation/getting-started/license-key/how-to-register-in-an-application) page for more information on registering license keys.
179
179
180
-
4.Same version Syncfusion<supstyle="font-size:70%">®</sup> assemblies should be present in the application output folders or published folders.
180
+
4.Ensure the same version of Syncfusion<supstyle="font-size:70%">®</sup> assemblies are present in the application output and published folders.
181
181
182
-
5.If you've upgraded the Syncfusion<supstyle="font-size:70%">®</sup> version and license keys in the application, try cleaning and rebuilding the application to see if that resolves the license error message.
182
+
5.After upgrading Syncfusion<supstyle="font-size:70%">®</sup> packages and updating the license key, clean bin/obj and rebuild the application to clear cached trial assemblies.
0 commit comments