Merge pull request #4910 from syncfusion-content/HF_27

189464 - Updated Latest Content In CI Validation UG Page - hf/27.1

Author: christopherhirudayasamy

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

@@ -19,11 +19,23 @@ margin-top: 1.5em;     margin-bottom: 1.5em;
 
 # Syncfusion license key validation in CI services
 
-Syncfusion license key validation in CI services ensures that Syncfusion Essential Studio components are properly licensed during CI processes. Validating the license key at the CI level can prevent licensing errors during deployment. The following section shows how to validate the Syncfusion license key in CI services.
+Syncfusion license key validation in CI services ensures that Syncfusion Essential Studio 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.
+
+The following section shows how to validate the Syncfusion license key in CI services.
 
 * 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:"Blazor" /version:"26.2.4" /licensekey:"Your License Key"
+
+Write-Host $result
+{% endhighlight %}
+{% endtabs %}
 
 ![LicenseKeyValidation script](images/license-validation.png)
 
@@ -37,13 +49,14 @@ Syncfusion license key validation in CI services ensures that Syncfusion Essenti
 
 ## 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.
 
-```bash
+{% tabs %}
+{% highlight c# tabtitle="YAML" %}
 pool:
   vmImage: 'windows-latest'
 
@@ -55,39 +68,43 @@ steps:
     filePath: $(LICENSE_VALIDATION) #Or the actual path to the LicenseKeyValidation.ps1 script.
 
   displayName: Syncfusion License Validation 
-```
+{% endhighlight %}
+{% endtabs %}
 
 ## 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](images/license-validation-classic.png)
 
 ## GitHub actions
 
 * 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.
 
-```bash
+{% tabs %}
+{% highlight c# tabtitle="YAML" %}
   steps:
   - name: Syncfusion License Validation
     shell: pwsh
     run: |
 	  ./path/LicenseKeyValidator/LicenseKeyValidation.ps1
-```
+{% endhighlight %}
+{% endtabs %}
 
 ## 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.
 
-```bash
+{% tabs %}
+{% highlight json %}
 pipeline {
 	agent any
 	environment {
@@ -101,17 +118,30 @@ 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.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.
+* 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.
+
+{% tabs %}
+{% highlight c# %}
+using Syncfusion.Licensing;
+
+//Register Syncfusion license key 
+Syncfusion.Licensing.SyncfusionLicenseProvider.RegisterLicense("YOUR LICENSE KEY");
+
+//Validate the registered license key
+bool isValid = SyncfusionLicenseProvider.ValidateLicense(Platform.Blazor);
+{% endhighlight %}
+{% endtabs %}
 
 ![LicenseKeyValidationMethod](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. 
 

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

@@ -22,6 +22,8 @@ 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://blazor.syncfusion.com/documentation/getting-started/license-key/ci-license-validation) section for detailed instructions on how to implement it.
+
 ## Blazor Web App
 
 Open **~/Program.cs** file and register the Syncfusion Blazor license key in the Blazor web app.