Licensing: add Migration guide + some fixes#8843
Merged
vladaskorohodova merged 12 commits intoJun 10, 2026
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR streamlines the DevExtreme licensing documentation by consolidating detailed setup/error guidance into links to the central “License Key for DevExpress Products” article, and adds a new migration guide for the v26.1 licensing mechanism.
Changes:
- Added a new “Migrate to the New Licensing Mechanism” guide for DevExtreme v26.1.
- Reworked licensing topics (validation, updating keys, obtain/register key, validate key) to be shorter and link to the external error/version/setup references.
- Removed several framework-specific/license-setup subtopics and relocated the redistribution/EULA note into the CI/CD topic.
Reviewed changes
Copilot reviewed 13 out of 16 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| concepts/Common/Licensing/00 Licensing.md | Removes the old in-page TOC and trims the overview content. |
| concepts/Common/Licensing/05 Evaluation (Trial).md | Minor wording changes around trial messaging and purchase/support links. |
| concepts/Common/Licensing/09 Obtain Your License Key.md | Removed (replaced by the new obtain+register topic). |
| concepts/Common/Licensing/09 Obtain and Register Your License Key.md | New short “obtain + register” page with an illustrative image. |
| concepts/Common/Licensing/10 Validate Your License Key.md | New condensed “validate” page pointing to the external setup article. |
| concepts/Common/Licensing/10 Validate Your License Key/10 Manual Configuration.md | Removed (content replaced by external references / consolidation). |
| concepts/Common/Licensing/10 Validate Your License Key/20 Storing the License Key in a Global Window Object.md | Removed. |
| concepts/Common/Licensing/10 Validate Your License Key/25 Module Federation Specifics.md | Removed. |
| concepts/Common/Licensing/10 Validate Your License Key/30 Next.js Specifics.md | Removed. |
| concepts/Common/Licensing/11 Migrate to the New Licensing Mechanism.md | New migration steps for upgrading to the v26.1 licensing mechanism. |
| concepts/Common/Licensing/13 Deployment and Continuous Integration (CI).md | Adds redistribution/EULA note and keeps CI runtime key generation guidance. |
| concepts/Common/Licensing/15 Updating License Keys.md | Replaced detailed text with a link to the external “Version Errors” section. |
| concepts/Common/Licensing/25 Validation.md | Replaced the local warning table with a link to the external error code reference. |
| concepts/Common/Licensing/27 Redistribution.md | Removed (redistribution note moved to the CI/CD article). |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 15 out of 17 changed files in this pull request and generated 1 comment.
Comments suppressed due to low confidence (1)
concepts/Common/Licensing/10 Validate Your License Key.md:3
- Step 1 currently says users can "obtain and register" the license key "from the DevExpress Download Manager". The Download Manager provides the key, but the registration step happens separately (as described in the linked topic), so this wording is misleading.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
helen-dikareva
approved these changes
Jun 9, 2026
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 15 out of 17 changed files in this pull request and generated 1 comment.
Comments suppressed due to low confidence (1)
concepts/Common/Licensing/10 Validate Your License Key.md:3
- Step 1’s description implies that license key registration happens in the Download Manager. Registration is performed on the developer machine; the Download Manager is only where you obtain the key. Reword this step to avoid that ambiguity.
dirkpieterse
reviewed
Jun 9, 2026
Co-authored-by: dirkpieterse <dirk.pieterse@devexpress.com>
| For complete setup instructions, refer to: [License Key for DevExpress Products](https://docs.devexpress.com/GeneralInformation/405494/trial-register/set-up-your-dev-express-license-key#manual-registration-additional-step-for-jsts-developers-devextreme) | ||
|
|
||
| Should you require purchase assistance or more information on our license verification process, please contact a member of the <a href="mailto:clientservices@devexpress.com">DevExpress Client Services Team</a>. No newline at end of file | ||
| For complete setup instructions, refer to: [License Key for DevExpress Products](https://docs.devexpress.com/GeneralInformation/405494/trial-register/set-up-your-dev-express-license-key#manual-registration-additional-step-for-jsts-developers-devextreme) No newline at end of file |
| @@ -1,3 +1,3 @@ | |||
| Per the terms of the End User License Agreement (EULA), you are permitted to evaluate DevExtreme components [for 30-days](https://js.devexpress.com/Download/). | |||
Comment on lines
+5
to
+7
| If license key validation fails, DevExtreme displays warning messages in the browser console at runtime. If the `devextreme-license` CLI cannot generate a runtime key, it reports errors directly in the CLI output. For a full list of error codes and their descriptions, refer to: | ||
|
|
||
| <table class="dx-table full-width"> | ||
| <tr> | ||
| <th>Case</th> | ||
| <th>Message</th> | ||
| </tr> | ||
| <tr> | ||
| <td>Valid license key not found.</td> | ||
| <td> | ||
| <code>W0019 - DevExtreme: Unable to Locate a Valid License Key</code><br><br> | ||
| If you are using a 30-day trial version of DevExtreme, you must uninstall all copies of DevExtreme once your 30-day trial period expires. For terms and conditions that govern use of DevExtreme UI components/libraries, please refer to the <a href="https://js.devexpress.com/EULAs/DevExtremeComplete/" target="_blank">DevExtreme End User License Agreement</a>. <br><br> | ||
| To use DevExtreme in a commercial project, you must purchase a license. For pricing/licensing options, please visit <a href="http://js.devexpress.com/Buy/" target="_blank">DevExtreme Purchase page</a>. <br><br> | ||
| If you have licensing-related questions or need help with a purchase, please email <a href="mailto:clientservices@devexpress.com">clientservices@devexpress.com</a>. For additional information on this error message, see: <a href="/Documentation/ApiReference/Common/Utils/Errors_and_Warnings/#W0019">W0019</a>.</td> | ||
| </tr> | ||
| <tr> | ||
| <td>The license key has expired.</td> | ||
| <td><code>W0020 - DevExtreme: License Key Has Expired</code><br><br>A mismatch exists between the license key used and the DevExtreme version referenced in this project. <br><br> To proceed, you can: | ||
| <ul> | ||
| <li>use a version of DevExtreme linked to your license key (visit the DevExpress <a href="https://www.devexpress.com/ClientCenter/DownloadManager/" target="_blank">Download Manager</a> to validate license/version information)</li> | ||
| <li><a href="https://www.devexpress.com/buy/renew/" target="_blank">renew your DevExpress Subscription</a> (once you renew your subscription, you will be entitled to product updates and support services as defined in the DevExtreme End User License Agreement)</li></ul> | ||
| If you have licensing-related questions or need help with a renewal, please email <a href="mailto:clientservices@devexpress.com">clientservices@devexpress.com</a>. For additional information on this error message, see: <a href="/Documentation/ApiReference/Common/Utils/Errors_and_Warnings/#W0020">W0020</a>.</td> | ||
| </tr> | ||
| <tr> | ||
| <td>License key verification failed.</td> | ||
| <td><code>W0021 - DevExtreme: License Key Verification Has Failed</code><br><br> | ||
| To verify your DevExtreme license, specify a correct key in the GlobalConfig. If you continue to encounter this error, please visit DevExpress <a href="https://www.devexpress.com/ClientCenter/DownloadManager/" target="_blank">Download Manager</a> to obtain a valid license key. <br><br> If you have a valid license key and this problem persists, please submit a <a href="https://supportcenter.devexpress.com/ticket/create" target="_blank">support ticket</a> with the DevExpress Support Center. We will be happy to follow-up. <br><br> | ||
| For additional information on this error message, see: <a href="/Documentation/ApiReference/Common/Utils/Errors_and_Warnings/#W0021">W0021</a>. | ||
| </td> | ||
| </tr> | ||
| </table> No newline at end of file | ||
| [License Key for DevExpress Products — Error Code Reference](https://docs.devexpress.com/GeneralInformation/405494/trial-register/set-up-your-dev-express-license-key#error-code-reference) No newline at end of file |
Comment on lines
+1
to
+3
| For information on version-specific license key requirements and how to update your key when upgrading DevExtreme, refer to: | ||
|
|
||
| A license key will work for all minor versions released within a given major release cycle - regardless of publication date. When you upgrade to a new major version, the license key must also be updated. For example: | ||
|
|
||
| - v23.1.3 and v23.1.5 are two minors within the v23.1 major release cycle. If you upgrade from v23.1.3 to v23.1.5, you will not need to update license key info. | ||
|
|
||
| - v23.1 and v23.2 are two different major versions. If you upgrade from v23.1.x to v23.2.x, you will need to update license key info. | ||
|
|
||
| DevExtreme license keys do not expire. While license keys never expire, please remember, they are linked to major versions (v23.2, v24.1, ...). If you do not have a valid license for a given major version, you will not be authorized to use DevExtreme UI components/libraries for production projects. Visit [Renewals](https://www.devexpress.com/buy/renew/) to renew your license. | ||
|
|
||
| License keys issued for newer versions of DevExtreme (such as v23.2) can be used for older versions (such as v23.1). | ||
|
|
||
| [note] We do not provide license keys for early access previews (EAP), community tech previews (CTP), and betas. These pre-release versions may contain deficiencies and as such, should not be considered for production use or integrated into any mission critical application. No newline at end of file | ||
| [License Key for DevExpress Products — Version Errors](https://docs.devexpress.com/GeneralInformation/405494/trial-register/set-up-your-dev-express-license-key#version-errors---registered-license-key-is-outdated) No newline at end of file |
|
|
||
| ##### Modular Applications | ||
|
|
||
| Add the following script to your `package.json` to automatically regenerate the runtime key file each build (update the `--out` path/extension to match your runtime key file): |
|
|
||
| ### Step 4: Configure CI/CD | ||
|
|
||
| For CI/CD environments, the `prebuild` script added in Step 2 is sufficient on the build side, but you must also set your DevExpress license key in an environment variable on the build server. For complete instructions, see [Deployment and Continuous Integration (CI)](/concepts/Common/Licensing/13%20Deployment%20and%20Continuous%20Integration%20(CI).md '/Documentation/Guide/Common/Licensing/#Deployment_and_Continuous_Integration_CI'). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.