Skip to content

Commit

Permalink
docs: Adding a new recommendation to OEP-65 around shared dependencies
Browse files Browse the repository at this point in the history
  • Loading branch information
davidjoy committed Sep 13, 2024
1 parent aa43569 commit 42bd882
Showing 1 changed file with 10 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -248,8 +248,12 @@ Process

We need to ensure maintainers and developers know what dependency versions to use, and when they need to upgrade to stay consistent. Open edX release documentation should include information on which frontend dependency versions are compatible with the release, likely pinned to a major version (i.e., React 17.x, Paragon 22.x, etc.)

Further, we recommend that each Open edX release have a single supported major version of all shared dependencies, and that all MFEs be upgraded to it prior to release.

We also need a process to migrate Open edX repositories through breaking changes in third-party dependencies. Ideally following the `Upgrade Project Runbook <https://openedx.atlassian.net/wiki/spaces/AC/pages/3660316693/Upgrade+Project+Runbook>`_.

The :term:`module architecture` allows for migrations through breaking changes in third-party dependencies via the :term:`Linked Module` loading method, which will allow a frontend to run as separate, linked :term:`sites <Site>` while migrating modules incrementally.

Best Practices
--------------

Expand Down Expand Up @@ -488,3 +492,9 @@ Change History
==========

* Adding a reference to ADR-0001, which describes creation of a unified platform repository.

2024-09-13
==========

* Updating language to match OEP-65's ADRs and leverage the frontend glossary.
* Adding a recommendation to standardize on a single major version of shared dependencies in a given Open edX release.

0 comments on commit 42bd882

Please sign in to comment.