Upgrading libraries - ProjectSidewalk/SidewalkWebpage GitHub Wiki

We periodically check for updates to the various libraries that we use to power Project Sidewalk. Below we list the libraries that we're using, along with how to check for and download updates to those libraries. This is a work in progress, as we try to make the process of keeping libraries up-to-date more streamlined and consistent.

When updating, please update the version numbers that we're using below. This makes it easier to know whether a library has a new update available when scanning through the list next time.

Scala

After making any changes, you'll want to rerun npm start to trigger the new versions to download.

JavaScript

In almost all cases, we're downloading libraries and providing them directly ourselves, rather than using a CDN. We do this because providing them ourselves will generally be faster than using a CDN; it also give us a bit more control and clarity on what we're using.

Below, I've added links to changelogs where we should be able to see whether a new version is available, along with a link to a download page (or an example link to download directly from a URL, where we'd need to tweak the URL with the correct version number). Aim to download minified files (.min.js) to improve download times.

To upgrade the library, you should download the new version, and add the file to public/javascripts/lib/, rename it to include the version number for clarity, update the file name throughout the code to use the new version number, and finally delete the version.