Skip to content

add warning about unversioned cdn urls #1070

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
raju-opti merged 3 commits into from
Jun 12, 2025
Merged

add warning about unversioned cdn urls #1070

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
27df671
add warning about unversioned cdn urls
raju-opti Jun 12, 2025
d6cfa56
major
raju-opti Jun 12, 2025
287f027
update
raju-opti Jun 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,8 @@ The package has different entry points for different environments. The browser e
<script src="https://unpkg.com/@optimizely/optimizely-sdk@6/dist/optimizely.browser.umd.js"></script>
```

> ⚠️ **Warning**: Always specify a version when using CDN URLs like `unpkg` URLs above (for example: `@6` in the examples above). Using unversioned CDN URLs can automatically pull in breaking changes when new major versions are released, causing unexpected problems in the application.
Comment thread
raju-opti marked this conversation as resolved.
Outdated

When evaluated, that bundle assigns the SDK's exports to `window.optimizelySdk`. If you wish to use the asset locally (for example, if unpkg is down), you can find it in your local copy of the package at dist/optimizely.browser.umd.min.js. We do not recommend using this method in production settings as it introduces a third-party performance dependency.

As `window.optimizelySdk` should be a global variable at this point, you can continue to use it like so:
Expand Down
Loading