Skip to content
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.

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

docs: update readme to use latest and switch unpkg to jsdelivr #1084

Merged
merged 5 commits into from
Mar 22, 2024

Conversation

ayuhito
Copy link
Contributor

@ayuhito ayuhito commented Jul 13, 2022

unpkg is unmaintained and full of issues. I switched the documentation over to jsDelivr since it's actively maintained and is much more reliable due to its fallback system. Other CDNs are dependent on Cloudflare only, which wasn't ideal that one time CF went down globally for a couple hours 😅

Also used the broader @6 version tag instead of a specific tag so you don't need to manually change the version until next major release, which you can't really do on unpkg since their implementation adds a redirect hurting performance.

I'll also be making a PR on the website shortly so they can be in sync with this one.
PR made: ionic-team/ionicons-site#27

@liamdebeasi
Copy link
Contributor

Thanks for the PR and apologies for the delay! I think this is a good change to make. Using jsdelivr aligns with how we do things on Ionic Framework too.

I made a couple changes:

  1. Instead of using the @6 tag I just changed it to use @latest that way we don't need to update this every time there's a new major release of Ionicons.
  2. I added the unpkg part back to the package.json. We'll want to keep this configuration until we can make a breaking change in a major release of Ionicons. If we removed that config now anyone pulling the @latest tag on unpkg could run into issues.

@liamdebeasi liamdebeasi changed the title docs: update readme to use v6 and switch unpkg to jsdelivr docs: update readme to use latest and switch unpkg to jsdelivr Mar 22, 2024
@liamdebeasi liamdebeasi enabled auto-merge (squash) March 22, 2024 14:19
@liamdebeasi liamdebeasi disabled auto-merge March 22, 2024 14:20
@liamdebeasi liamdebeasi enabled auto-merge (squash) March 22, 2024 14:23
@liamdebeasi liamdebeasi merged commit b63d12b into ionic-team:main Mar 22, 2024
6 checks passed
@ayuhito ayuhito deleted the docs/jsdelivr branch March 22, 2024 16:02
christian-bromann pushed a commit to christian-bromann/ionicons that referenced this pull request May 1, 2024
…-team#1084)

* docs: switch unpkg to jsdelivr

* docs: fix script tag

* Update readme.md

* Update package.json

---------

Co-authored-by: Liam DeBeasi <[email protected]>
Co-authored-by: mo7amd <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants