add warning about unversioned cdn urls #1070
Merged
+2
−0
Conversation
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
There was a problem hiding this comment.
Pull Request Overview
This PR adds a warning to the README advising users to pin CDN URLs to specific versions to avoid unexpected breaking changes.
- Introduces a blockquote warning about unversioned CDN URLs
- References specifying versions (e.g.,
@6) in unpkg script tags
Comments suppressed due to low confidence (2)
README.md:134
- [nitpick] Consider specifying a full semantic version (e.g.,
@6.0.0) in the example to prevent unintended minor or patch upgrades, and update the example script tag accordingly.
> ⚠️ **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 versions are released, causing unexpected problems in the application.
README.md:134
- [nitpick] The warning currently mentions only
unpkg. Consider generalizing this to include other CDNs (e.g., jsdelivr) or clarifying that the guidance applies to all CDNs for consistency.
> ⚠️ **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 versions are released, causing unexpected problems in the application.
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.