Skip to content

Latest commit

 

History

History
28 lines (22 loc) · 1.82 KB

UPDATING.md

File metadata and controls

28 lines (22 loc) · 1.82 KB

Updating Dependencies

Thank you for keeping the iO Techhub dependencies up-to-date. You are helping us keep up with the latest developments and security updates.

To keep the dependencies up-to-date we use npm-check-updates. Each version range (major.minor.patch) has its own script and configuration. Below are a few steps to take to make updating an easy task.

The steps

  1. Update Node to the latest stable version
    1. Make sure to update both the package.json's engines configuration and the .nvmrc file
  2. Open the update patch versions config
    1. Review each dependency in the reject array, if available, and see if you can remove it
    2. Run npm run update:patch in the project root
    3. See if there are any issues with the new updates
    4. Fix any issues you encounter
      1. If you somehow can't fix it, upgrade the dependency to the highest version which doesn't have the issue Sometimes you can resolve it by updating to the next version range (patch -> minor -> major), if available
        • Add it to the reject array
        • Add a comment on why you rejected it
      2. Go back to step 2.2
  3. Repeat the above step for minor version config
  4. Before migrating the remaining packages to a newer major version, migrate next and react manually first, if available. They provide convenient tools making the update easier for you
  5. Repeat the above step for major version config
  6. Review this process and update when necessary

Please note

Make sure to comment why you didn't update a specific dependency so we can try again at a later time. Preferably add a link to a github issue (or similar).