Skip to content

Commit b863bc2

Browse files
author
christopherhirudayasamy
authored
Merge pull request #4694 from syncfusion-content/CI-validation-hf/26.2
185291 - UG For Syncfusion License Key Validation Issuefix - hotfix
2 parents 0da8bbe + b7224e2 commit b863bc2

File tree

2 files changed

+25
-15
lines changed

2 files changed

+25
-15
lines changed

blazor/getting-started/license-key/CI-license-validation.md

Lines changed: 24 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,17 @@ The following section shows how to validate the Syncfusion license key in CI ser
2525

2626
* Download and extract the LicenseKeyValidator.zip utility from the following link: [LicenseKeyValidator](https://s3.amazonaws.com/files2.syncfusion.com/Installs/LicenseKeyValidation/LicenseKeyValidator.zip).
2727

28-
* Open the LicenseKeyValidation.ps1 PowerShell script in a text\code editor.
28+
* Open the LicenseKeyValidation.ps1 PowerShell script in a text\code editor as shown in the below example.
29+
30+
{% tabs %}
31+
{% highlight c# tabtitle="PowerShell" %}
32+
# Replace the parameters with the desired platform, version, and actual license key.
33+
34+
$result = & $PSScriptRoot"\LicenseKeyValidatorConsole.exe" /platform:"Blazor" /version:"26.2.4" /licensekey:"Your License Key"
35+
36+
Write-Host $result
37+
{% endhighlight %}
38+
{% endtabs %}
2939

3040
![LicenseKeyValidation script](images/license-validation.png)
3141

@@ -39,14 +49,14 @@ The following section shows how to validate the Syncfusion license key in CI ser
3949

4050
## Azure Pipelines (YAML)
4151

42-
* 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 Azure Pipeline. Use the path of the LicenseKeyValidation.ps1 script file as a value (e.g., D:\LicenseKeyValidator\LicenseKeyValidation.ps1).
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).
4353

44-
* Integrate the PowerShell task in pipeline and execute the script to validate the license key.
54+
* Integrate the PowerShell task in the pipeline and execute the script to validate the license key.
4555

4656
The following example shows the syntax for Windows build agents.
4757

4858
{% tabs %}
49-
{% highlight c# tabtitle ="YAML" %}
59+
{% highlight c# tabtitle="YAML" %}
5060
pool:
5161
vmImage: 'windows-latest'
5262

@@ -63,20 +73,20 @@ steps:
6373

6474
## Azure Pipelines (Classic)
6575

66-
* 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 Azure Pipeline. Use the path of the LicenseKeyValidation.ps1 script file as a value (e.g., D:\LicenseKeyValidator\LicenseKeyValidation.ps1).
76+
* 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).
6777

68-
* Include the PowerShell task in pipeline and execute the script to validate the license key.
78+
* Include the PowerShell task in the pipeline and execute the script to validate the license key.
6979

7080
![LicenseKeyValidation script](images/license-validation-classic.png)
7181

7282
## GitHub actions
7383

7484
* 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).
7585

76-
The following example shows the syntax for validating Syncfusion license key in GitHub actions.
86+
The following example shows the syntax for validating the Syncfusion license key in GitHub actions.
7787

7888
{% tabs %}
79-
{% highlight c# tabtitle ="YAML" %}
89+
{% highlight c# tabtitle="YAML" %}
8090
steps:
8191
- name: Syncfusion License Validation
8292
shell: pwsh
@@ -87,11 +97,11 @@ The following example shows the syntax for validating Syncfusion license key in
8797

8898
## Jenkins
8999

90-
* Create a [Environment Variable](https://www.jenkins.io/doc/pipeline/tour/environment) named 'LICENSE_VALIDATION'. Use Use the path of the LicenseKeyValidation.ps1 script file as a value (e.g., D:\LicenseKeyValidator\LicenseKeyValidation.ps1).
100+
* Create an [Environment Variable](https://www.jenkins.io/doc/pipeline/tour/environment) named 'LICENSE_VALIDATION'. Use the path of the LicenseKeyValidation.ps1 script file as a value (e.g., D:\LicenseKeyValidator\LicenseKeyValidation.ps1).
91101

92102
* Include a stage in Jenkins to execute the LicenseKeyValidation.ps1 script in PowerShell.
93103

94-
The following example shows the syntax for validating Syncfusion license key in Jenkins pipeline.
104+
The following example shows the syntax for validating the Syncfusion license key in the Jenkins pipeline.
95105

96106
{% tabs %}
97107
{% highlight json %}
@@ -111,11 +121,11 @@ pipeline {
111121
{% endhighlight %}
112122
{% endtabs %}
113123

114-
## Validate the License Key Using ValidateLicense() Method
124+
## Validate the License Key By Using the ValidateLicense() Method
115125

116126
* Register the license key properly by calling RegisterLicense("License Key") method with the license key.
117127

118-
* Once the license key is registered, it can be validated by using ValidateLicense("Platform.Blazor") method. This ensures that the license key is valid for the platform and version you are using. For reference please check the following example.
128+
* Once the license key is registered, it can be validated by using the ValidateLicense("Platform.Blazor") method. This ensures that the license key is valid for the platform and version you are using. For reference, please check the following example.
119129

120130
{% tabs %}
121131
{% highlight c# %}
@@ -131,7 +141,7 @@ bool isValid = SyncfusionLicenseProvider.ValidateLicense(Platform.Blazor);
131141

132142
![LicenseKeyValidationMethod](images/license-validation-method.png)
133143

134-
* If ValidateLicense() method returns true, registered license key is valid and can proceed with deployment.
144+
* If the ValidateLicense() method returns true, registered license key is valid and can proceed with deployment.
135145

136-
* If ValidateLicense() method returns false, there will be invalid license errors in deployment due to either an invalid license key or an incorrect assembly or package version that is referenced in the project. Please ensure that all the referenced Syncfusion assemblies or NuGet packages are all on the same version as the license key’s version before deployment.
146+
* If the ValidateLicense() method returns false, there will be invalid license errors in deployment due to either an invalid license key or an incorrect assembly or package version that is referenced in the project. Please ensure that all the referenced Syncfusion assemblies or NuGet packages are all on the same version as the license key’s version before deployment.
137147

blazor/getting-started/license-key/how-to-register-in-an-application.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Syncfusion.Licensing.SyncfusionLicenseProvider.RegisterLicense("YOUR LICENSE KEY
2222
N> * Place the license key between double quotes. Also, ensure that Syncfusion.Licensing.dll is referenced in your project where the license key is being registered.
2323
* Syncfusion license validation is done offline during application execution and does not require internet access. Apps registered with a Syncfusion license key can be deployed on any system that does not have an internet connection.
2424

25-
I> Syncfusion license keys can be validated during the Continuous Integration (CI) processes to ensure proper licensing and prevent licensing errors during deployment. Refer to the [CI License Validation] (https://blazor.syncfusion.com/documentation/getting-started/license-key/ci-license-validation) section for detailed instructions on how to implement it.
25+
I> Syncfusion license keys can be validated during the Continuous Integration (CI) processes to ensure proper licensing and prevent licensing errors during deployment. Refer to the [CI License Validation](https://blazor.syncfusion.com/documentation/getting-started/license-key/ci-license-validation) section for detailed instructions on how to implement it.
2626

2727
## Blazor Web App
2828

0 commit comments

Comments
 (0)