Skip to content

Commit ec503b3

Browse files
Merge pull request #1466 from Syncfusion-Content/hotfix/hotfix-v26.2.4
DOCINFRA-2341_merged_using_automation
2 parents 5754cd5 + d389efb commit ec503b3

File tree

2 files changed

+25
-15
lines changed

2 files changed

+25
-15
lines changed

wpf/Licensing/how-to-register-in-an-application.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Syncfusion.Licensing.SyncfusionLicenseProvider.RegisterLicense("YOUR LICENSE KEY
2020
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.
2121
* 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.
2222

23-
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://help.syncfusion.com/wpf/licensing/licensing-faq/ci-license-validation) section for detailed instructions on how to implement it.
23+
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://help.syncfusion.com/wpf/licensing/licensing-faq/ci-license-validation) section for detailed instructions on how to implement it.
2424

2525
### WPF
2626

wpf/Licensing/licensing-faq/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:"WPF" /version:"26.2.4" /licensekey:"Your License Key"
35+
36+
Write-Host $result
37+
{% endhighlight %}
38+
{% endtabs %}
2939

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

@@ -41,14 +51,14 @@ The following section shows how to validate the Syncfusion license key in CI ser
4151

4252
## Azure Pipelines (YAML)
4353

44-
* 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).
54+
* 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).
4555

46-
* Integrate the PowerShell task in pipeline and execute the script to validate the license key.
56+
* Integrate the PowerShell task in the pipeline and execute the script to validate the license key.
4757

4858
The following example shows the syntax for Windows build agents.
4959

5060
{% tabs %}
51-
{% highlight c# tabtitle ="YAML" %}
61+
{% highlight c# tabtitle="YAML" %}
5262
pool:
5363
vmImage: 'windows-latest'
5464

@@ -65,20 +75,20 @@ steps:
6575

6676
## Azure Pipelines (Classic)
6777

68-
* 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).
78+
* 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).
6979

70-
* Include the PowerShell task in pipeline and execute the script to validate the license key.
80+
* Include the PowerShell task in the pipeline and execute the script to validate the license key.
7181

7282
![LicenseKeyValidation script](licensing-images/license-validation-classic.png)
7383

7484
## GitHub actions
7585

7686
* 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).
7787

78-
The following example shows the syntax for validating Syncfusion license key in GitHub actions.
88+
The following example shows the syntax for validating the Syncfusion license key in GitHub actions.
7989

8090
{% tabs %}
81-
{% highlight c# tabtitle ="YAML" %}
91+
{% highlight c# tabtitle="YAML" %}
8292
steps:
8393
- name: Syncfusion License Validation
8494
shell: pwsh
@@ -89,11 +99,11 @@ The following example shows the syntax for validating Syncfusion license key in
8999

90100
## Jenkins
91101

92-
* 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).
102+
* 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).
93103

94104
* Include a stage in Jenkins to execute the LicenseKeyValidation.ps1 script in PowerShell.
95105

96-
The following example shows the syntax for validating Syncfusion license key in Jenkins pipeline.
106+
The following example shows the syntax for validating the Syncfusion license key in the Jenkins pipeline.
97107

98108
{% tabs %}
99109
{% highlight json %}
@@ -113,11 +123,11 @@ pipeline {
113123
{% endhighlight %}
114124
{% endtabs %}
115125

116-
## Validate the License Key Using ValidateLicense() Method
126+
## Validate the License Key By Using the ValidateLicense() Method
117127

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

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

122132
{% tabs %}
123133
{% highlight c# %}
@@ -133,7 +143,7 @@ bool isValid = SyncfusionLicenseProvider.ValidateLicense(Platform.WPF);
133143

134144
![LicenseKeyValidationMethod](licensing-images/license-validation-method.png)
135145

136-
* If ValidateLicense() method returns true, registered license key is valid and can proceed with deployment.
146+
* If the ValidateLicense() method returns true, registered license key is valid and can proceed with deployment.
137147

138-
* 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.
148+
* 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.
139149

0 commit comments

Comments
 (0)