From 42bd882f6431eff8a200a5fe6c979083871c6c26 Mon Sep 17 00:00:00 2001 From: David Joy Date: Fri, 13 Sep 2024 16:33:46 -0400 Subject: [PATCH] docs: Adding a new recommendation to OEP-65 around shared dependencies --- .../oep-0065-arch-frontend-composability.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/oeps/architectural-decisions/oep-0065-arch-frontend-composability.rst b/oeps/architectural-decisions/oep-0065-arch-frontend-composability.rst index b761c8534..3f8b8cad6 100644 --- a/oeps/architectural-decisions/oep-0065-arch-frontend-composability.rst +++ b/oeps/architectural-decisions/oep-0065-arch-frontend-composability.rst @@ -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 `_. +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 ` while migrating modules incrementally. + Best Practices -------------- @@ -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.