From 3b7b449ea7445140300e8701441d05637403f60b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9gis=20Behmo?= Date: Thu, 14 Dec 2023 11:30:59 +0100 Subject: [PATCH] docs: mention git repo extension in changelog This stems from this online conversations: https://discuss.openedx.org/t/rebuilding-mfes-with-a-custom-fork/11918 --- CHANGELOG.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index e079f6a2..54194d5c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -23,9 +23,10 @@ instructions, because git commits are used to generate release notes: ## v17.0.0 (2023-12-09) - 💥Upgrade to Quince (by @regisb). +- 💥[Improvement] If you implement the `MFE_APPS` filter with a custom GitHub repository, you must make sure to add the ".git" extension to the URL. For instance: `"repository": "https://github.com/username/frontend-app-learning.git"`. This is because we changed the way we git-clone MFE repositories. (by @regisb) - [Improvement] Added Makefile and test action to repository and formatted code with Black and isort. (by @CodeWithEmad) - [Feature] Add support for the Learner Dashboard MFE. (by @arbrandes) -- [Bugfix] Append trailing slash to PUBLIC_PATH, as its absence breaks some MFEs. (by @arbrandes) +- [Bugfix] Append trailing slash to `PUBLIC_PATH`, as its absence breaks some MFEs. (by @arbrandes) - [Feature] Added patch to allow changes to Dockerfile after the npm build has completed. (by @Danyal-Faheem) - [Bugfix] Auto-build "mfe" image during `dev/local launch` in nightly. (by @regisb) - [Bugfix] Specify port for dev server to listen on (by @michaelwheeler)