From 81488e4bcc8d33b9584d2c2ee2038166c13b6745 Mon Sep 17 00:00:00 2001 From: Mohammed-Abubakkar-Siddiq Date: Wed, 31 Jul 2024 19:36:14 +0530 Subject: [PATCH 1/3] 185291 - UG For Syncfusion License Key Validation Issuefix - hotfix --- wpf/Licensing/how-to-register-in-an-application.md | 2 +- wpf/Licensing/licensing-faq/CI-license-validation.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/wpf/Licensing/how-to-register-in-an-application.md b/wpf/Licensing/how-to-register-in-an-application.md index 87b4963f0..73a47210d 100644 --- a/wpf/Licensing/how-to-register-in-an-application.md +++ b/wpf/Licensing/how-to-register-in-an-application.md @@ -20,7 +20,7 @@ Syncfusion.Licensing.SyncfusionLicenseProvider.RegisterLicense("YOUR LICENSE KEY 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. * 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. -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. +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. ### WPF diff --git a/wpf/Licensing/licensing-faq/CI-license-validation.md b/wpf/Licensing/licensing-faq/CI-license-validation.md index 09dda2881..1c4e8396b 100644 --- a/wpf/Licensing/licensing-faq/CI-license-validation.md +++ b/wpf/Licensing/licensing-faq/CI-license-validation.md @@ -48,7 +48,7 @@ The following section shows how to validate the Syncfusion license key in CI ser The following example shows the syntax for Windows build agents. {% tabs %} -{% highlight c# tabtitle ="YAML" %} +{% highlight c# tabtitle="YAML" %} pool: vmImage: 'windows-latest' @@ -78,7 +78,7 @@ steps: The following example shows the syntax for validating Syncfusion license key in GitHub actions. {% tabs %} -{% highlight c# tabtitle ="YAML" %} +{% highlight c# tabtitle="YAML" %} steps: - name: Syncfusion License Validation shell: pwsh From d6aa9728131d4e2ba988a4a7590cb031c2ee2531 Mon Sep 17 00:00:00 2001 From: Mohammed-Abubakkar-Siddiq Date: Thu, 1 Aug 2024 15:47:52 +0530 Subject: [PATCH 2/3] Updated --- .../licensing-faq/CI-license-validation.md | 34 ++++++++++++------- 1 file changed, 22 insertions(+), 12 deletions(-) diff --git a/wpf/Licensing/licensing-faq/CI-license-validation.md b/wpf/Licensing/licensing-faq/CI-license-validation.md index 1c4e8396b..a025f79d9 100644 --- a/wpf/Licensing/licensing-faq/CI-license-validation.md +++ b/wpf/Licensing/licensing-faq/CI-license-validation.md @@ -25,7 +25,17 @@ The following section shows how to validate the Syncfusion license key in CI ser * Download and extract the LicenseKeyValidator.zip utility from the following link: [LicenseKeyValidator](https://s3.amazonaws.com/files2.syncfusion.com/Installs/LicenseKeyValidation/LicenseKeyValidator.zip). -* Open the LicenseKeyValidation.ps1 PowerShell script in a text\code editor. +* Open the LicenseKeyValidation.ps1 PowerShell script in a text\code editor as shown in the below example. + +{% tabs %} +{% highlight c# tabtitle="PowerShell" %} +# Replace the parameters with the desired platform, version, and actual license key. + +$result = & $PSScriptRoot"\LicenseKeyValidatorConsole.exe" /platform:"WPF" /version:"26.2.4" /licensekey:"Your License Key" + +Write-Host $result +{% endhighlight %} +{% endtabs %} ![LicenseKeyValidation script](licensing-images/license-validation.png) @@ -41,9 +51,9 @@ The following section shows how to validate the Syncfusion license key in CI ser ## Azure Pipelines (YAML) -* 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). +* 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). -* Integrate the PowerShell task in pipeline and execute the script to validate the license key. +* Integrate the PowerShell task in the pipeline and execute the script to validate the license key. The following example shows the syntax for Windows build agents. @@ -65,9 +75,9 @@ steps: ## Azure Pipelines (Classic) -* 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). +* 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). -* Include the PowerShell task in pipeline and execute the script to validate the license key. +* Include the PowerShell task in the pipeline and execute the script to validate the license key. ![LicenseKeyValidation script](licensing-images/license-validation-classic.png) @@ -75,7 +85,7 @@ steps: * 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). -The following example shows the syntax for validating Syncfusion license key in GitHub actions. +The following example shows the syntax for validating the Syncfusion license key in GitHub actions. {% tabs %} {% highlight c# tabtitle="YAML" %} @@ -89,11 +99,11 @@ The following example shows the syntax for validating Syncfusion license key in ## Jenkins -* 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). +* 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). * Include a stage in Jenkins to execute the LicenseKeyValidation.ps1 script in PowerShell. -The following example shows the syntax for validating Syncfusion license key in Jenkins pipeline. +The following example shows the syntax for validating the Syncfusion license key in the Jenkins pipeline. {% tabs %} {% highlight json %} @@ -113,11 +123,11 @@ pipeline { {% endhighlight %} {% endtabs %} -## Validate the License Key Using ValidateLicense() Method +## Validate the License Key By Using the ValidateLicense() Method * Register the license key properly by calling RegisterLicense("License Key") method with the license key. -* 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. +* 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. {% tabs %} {% highlight c# %} @@ -133,7 +143,7 @@ bool isValid = SyncfusionLicenseProvider.ValidateLicense(Platform.WPF); ![LicenseKeyValidationMethod](licensing-images/license-validation-method.png) -* If ValidateLicense() method returns true, registered license key is valid and can proceed with deployment. +* If the ValidateLicense() method returns true, registered license key is valid and can proceed with deployment. -* 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. +* 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. From b585ea9e957a23125793fc4dd6d4464c074ab920 Mon Sep 17 00:00:00 2001 From: Mohammed-Abubakkar-Siddiq Date: Thu, 1 Aug 2024 16:13:36 +0530 Subject: [PATCH 3/3] updated --- wpf/Licensing/licensing-faq/CI-license-validation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/wpf/Licensing/licensing-faq/CI-license-validation.md b/wpf/Licensing/licensing-faq/CI-license-validation.md index a025f79d9..c581b7894 100644 --- a/wpf/Licensing/licensing-faq/CI-license-validation.md +++ b/wpf/Licensing/licensing-faq/CI-license-validation.md @@ -127,7 +127,7 @@ pipeline { * Register the license key properly by calling RegisterLicense("License Key") method with the license key. -* 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. +* 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. {% tabs %} {% highlight c# %}