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
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.
21
21
* 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.
22
22
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.
Copy file name to clipboardExpand all lines: wpf/Licensing/licensing-faq/CI-license-validation.md
+24-14Lines changed: 24 additions & 14 deletions
Original file line number
Diff line number
Diff line change
@@ -25,7 +25,17 @@ The following section shows how to validate the Syncfusion license key in CI ser
25
25
26
26
* Download and extract the LicenseKeyValidator.zip utility from the following link: [LicenseKeyValidator](https://s3.amazonaws.com/files2.syncfusion.com/Installs/LicenseKeyValidation/LicenseKeyValidator.zip).
27
27
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.
@@ -41,14 +51,14 @@ The following section shows how to validate the Syncfusion license key in CI ser
41
51
42
52
## Azure Pipelines (YAML)
43
53
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).
45
55
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.
47
57
48
58
The following example shows the syntax for Windows build agents.
49
59
50
60
{% tabs %}
51
-
{% highlight c# tabtitle="YAML" %}
61
+
{% highlight c# tabtitle="YAML" %}
52
62
pool:
53
63
vmImage: 'windows-latest'
54
64
@@ -65,20 +75,20 @@ steps:
65
75
66
76
## Azure Pipelines (Classic)
67
77
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).
69
79
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.
* 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).
77
87
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.
79
89
80
90
{% tabs %}
81
-
{% highlight c# tabtitle="YAML" %}
91
+
{% highlight c# tabtitle="YAML" %}
82
92
steps:
83
93
- name: Syncfusion License Validation
84
94
shell: pwsh
@@ -89,11 +99,11 @@ The following example shows the syntax for validating Syncfusion license key in
89
99
90
100
## Jenkins
91
101
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).
93
103
94
104
* Include a stage in Jenkins to execute the LicenseKeyValidation.ps1 script in PowerShell.
95
105
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.
97
107
98
108
{% tabs %}
99
109
{% highlight json %}
@@ -113,11 +123,11 @@ pipeline {
113
123
{% endhighlight %}
114
124
{% endtabs %}
115
125
116
-
## Validate the License Key Using ValidateLicense() Method
126
+
## Validate the License Key By Using the ValidateLicense() Method
117
127
118
128
* Register the license key properly by calling RegisterLicense("License Key") method with the license key.
119
129
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.
* 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.
137
147
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.
0 commit comments