Upgrade to openedx Palm @ tutor 16.x

.github/workflows/tutor.yml

@@ -24,7 +24,7 @@ env:
 jobs:
   build-openedx:
     env:
-      OPENEDX_IMAGE: docker.io/abstract2tech/community-theme-openedx:15.3.0
+      OPENEDX_IMAGE: docker.io/abstract2tech/community-theme-openedx:16.1.0
     runs-on: ubuntu-latest
     if : ${{ !inputs.skip_build_openedx_job }}
     steps:
@@ -59,12 +59,14 @@ jobs:
       - name: Build tutor openedx image
         run: |
           docker login -u abstract2tech -p ${{ secrets.DOCKER_REGISTRY_PASSWORD }}
-          docker buildx build -t "${OPENEDX_IMAGE}" --pull --cache-from "${OPENEDX_CACHE_IMAGE}" ./env/build/openedx --cache-to "${OPENEDX_CACHE_IMAGE}" --push
+          tutor images pull openedx
+          tutor images build openedx
+          tutor images push openedx
 
   build-mfe:
     runs-on: ubuntu-latest
     env:
-      MFE_IMAGE: docker.io/abstract2tech/community-theme-mfe:15.0.5
+      MFE_IMAGE: docker.io/abstract2tech/community-theme-mfe:16.1.0
     steps:
       - uses: actions/checkout@v3
 
@@ -97,6 +99,7 @@ jobs:
       - name: Build tutor MFE image
         run: |
           docker login -u abstract2tech -p ${{ secrets.DOCKER_REGISTRY_PASSWORD }}
+          tutor images pull mfe
           tutor images build mfe
           tutor images push mfe
 

.gitmodules

@@ -1,48 +1,58 @@
 [submodule "mfe/frontend-app-profile"]
 	path = mfe/frontend-app-profile
 	url = [email protected]:Abstract-Tech/community-theme-profile.git
-	branch = community-theme.master
+	branch = community-theme.palm
 [submodule "mfe/frontend-app-learning"]
 	path = mfe/frontend-app-learning
 	url = [email protected]:Abstract-Tech/community-theme-learning.git
 	branch = community-theme.master
 [submodule "mfe/frontend-app-course_about"]
 	path = mfe/frontend-app-course_about
 	url = [email protected]:Abstract-Tech/community-theme-course-about.git
-	branch = community-theme
+	branch = community-theme.palm
 [submodule "mfe/frontend-app-gradebook"]
 	path = mfe/frontend-app-gradebook
 	url = [email protected]:Abstract-Tech/community-theme-gradebook.git
-	branch = community-theme
+	branch = community-theme.palm
 [submodule "mfe/frontend-app-account"]
 	path = mfe/frontend-app-account
 	url = [email protected]:Abstract-Tech/community-theme-account.git
-	branch = community-theme.master
+	branch = community-theme.palm
 [submodule "mfe/frontend-app-home"]
 	path = mfe/frontend-app-home
 	url = [email protected]:Abstract-Tech/community-theme-home.git
 	branch = community-theme
 [submodule "mfe/frontend-component-footer"]
 	path = mfe/frontend-component-footer
 	url = [email protected]:Abstract-Tech/community-theme-footer.git
-	branch = community-theme
+	branch = community-theme.palm
 [submodule "mfe/frontend-component-header"]
 	path = mfe/frontend-component-header
 	url = [email protected]:Abstract-Tech/community-theme-header.git
-	branch = community-theme
+	branch = community-theme.palm
 [submodule "mfe/brand-openedx"]
 	path = mfe/brand-openedx
 	url = [email protected]:Abstract-Tech/community-theme-brand.git
 	branch = community-theme
 [submodule "mfe/frontend-app-discussions"]
 	path = mfe/frontend-app-discussions
 	url = [email protected]:Abstract-Tech/community-theme-discussions.git
-	branch = community-theme
+	branch = community-theme.palm
 [submodule "mfe/frontend-app-authn"]
 	path = mfe/frontend-app-authn
 	url = [email protected]:Abstract-Tech/community-theme-authn.git
-	branch = community-theme.olive
+	branch = community-theme.palm
 [submodule "mfe/frontend-app-course-authoring"]
 	path = mfe/frontend-app-course-authoring
 	url = [email protected]:Abstract-Tech/community-theme-course-authoring.git
-	branch = community-theme
+	branch = community-theme.palm
+[submodule "mfe/frontend-app-communications"]
+	path = mfe/frontend-app-communications
+	url = [email protected]:Abstract-Tech/community-theme-communications.git
+	branch = community-theme.palm
+[submodule "mfe/frontend-app-ora-grading"]
+	path = mfe/frontend-app-ora-grading
+	url = [email protected]:Abstract-Tech/community-theme-ora-grading.git
+	branch = community-theme.palm
+
+

README.md

@@ -74,6 +74,8 @@ It's important that MFE directories names start with the `frontend-app` magic wo
 The MFE application will be accessible at `http://apps.local.overhang.io:{{ PORT }}/{{ NAME }}/`. The `PORT` and `NAME` parameters for the specific MFE can be found in `config.yml`.
 (e.g. http://apps.local.overhang.io:1995/profile/)
 
+<details>
+  <summary>Old way of running MFE in development mode</summary>
 
 ## Building customized MFEs dev images
 
@@ -93,6 +95,29 @@ Then you should be able to run:
 
 And browse the MFE at http://apps.local.overhang.io:3001/home/
 
+</details>
+
+## Running an MFE in development mode
+
+To run an MFE in development mode, you would need to clone it and to mount it's directory
+
+ Assuming you need to modify `frontend-app-account`.
+
+1. Clone it _if it's not already_ 
+2. `npm install` _make sure you are on the correct node version `node --version` it shall match `cat .nvmrc`_
+3. `tutor mounts add "./mfe/frontend-app-account"`. 
+
+### How do I override specific npm pks?
+
+The following is an example of overriding a header
+
+1. Clone it _if it's not already_
+2. `npm install` _make sure you are on the correct node version `node --version` it shall match `cat .nvmrc`_
+3. Mount the pkg to the container `tutor  mounts add "account:./mfe/frontend-component-header:/openedx/frontend-component-header"` scheme: `service:host_path:containter_path`
+3. mounts the `module.config.js` file, assuming it's `mfe/`, `tutor mounts add account:./mfe/module.config.js:/openedx/app/module.config.js`
+5. then run `npm install` _Note: in step 2 we run it inside header, now inside account mfe_
+6. Simliar to adding the header we can also add other pkgs, like footer, brand, paragon...etc.
+
 ## Building and runnning MFEs in production mode
 
 If you want to test the MFEs in a production like environment (e.g. the platform root page will be replaced by the Home MFE application) you can do so by running:

ansible/group_vars/tutor/config.yml

@@ -1,5 +1,5 @@
 ---
-tutor_version: "15.3.8"
+tutor_version: "16.0.1"
 
 tutor_prod_config:
   ENABLE_HTTPS: true

config.yml

@@ -5,7 +5,7 @@ CAIRN_SUPERSET_SECRET_KEY: WcbX8dsobUWH5zOgHDz4
 CMS_HOST: studio.local.overhang.io
 CMS_OAUTH2_SECRET: 2icx54cdu9SJ77KMlZgHTWcm
 CONTACT_EMAIL: [email protected]
-DOCKER_IMAGE_OPENEDX: docker.io/abstract2tech/community-theme-openedx:15.3.0
+DOCKER_IMAGE_OPENEDX: docker.io/abstract2tech/community-theme-openedx:16.1.0
 ENABLE_HTTPS: false
 ENABLE_WEB_PROXY: true
 ID: jxBish2U54zbLTe82GMVvnyO
@@ -68,12 +68,12 @@ MFE_ACCOUNT_MFE_APP:
   name: account
   port: 1997
   repository: https://github.com/Abstract-Tech/community-theme-account
-  version: community-theme.master
+  version: community-theme.palm
 MFE_AUTHN_MFE_APP:
   name: authn
   port: 1999
   repository: https://github.com/Abstract-Tech/community-theme-authn
-  version: community-theme.olive
+  version: community-theme.palm
 MFE_COURSE_ABOUT_MFE_APP:
   name: course_about
   port: 3000
@@ -83,18 +83,18 @@ MFE_COURSE_AUTHORING_MFE_APP:
   name: course_authoring
   port: 2001
   repository: https://github.com/Abstract-Tech/community-theme-course-authoring
-  version: community-theme
+  version: community-theme.palm
 MFE_DISCUSSIONS_MFE_APP:
   name: discussions
   port: 2002
   repository: https://github.com/Abstract-Tech/community-theme-discussions
-  version: community-theme
-MFE_DOCKER_IMAGE: docker.io/abstract2tech/community-theme-mfe:15.0.5
+  version: community-theme.palm
+MFE_DOCKER_IMAGE: docker.io/abstract2tech/community-theme-mfe:16.0.0
 MFE_GRADEBOOK_MFE_APP:
   name: gradebook
   port: 1994
   repository: https://github.com/Abstract-Tech/community-theme-gradebook.git
-  version: community-theme
+  version: community-theme.palm
 MFE_HOME_MFE_APP:
   name: home
   port: 3001
@@ -104,12 +104,12 @@ MFE_LEARNING_MFE_APP:
   name: learning
   port: 2000
   repository: https://github.com/Abstract-Tech/community-theme-learning
-  version: community-theme.master
+  version: community-theme.palm
 MFE_PROFILE_MFE_APP:
   name: profile
   port: 1995
   repository: https://github.com/Abstract-Tech/community-theme-profile
-  version: community-theme.master
+  version: community-theme.palm
 MYSQL_ROOT_PASSWORD: 43Lfuln2
 OPENEDX_EXTRA_PIP_REQUIREMENTS:
 - git+https://github.com/abstract-tech/abstract-scorm-xblock.git@django4#subdirectory=abstract_scorm_xblock&egg=abstract-scorm-xblock
@@ -122,8 +122,8 @@ OPENEDX_SECRET_KEY: eHqeglW5j7T68yYtr3yL6XPz
 PLATFORM_NAME: Community Theme
 PLUGINS:
 - aicoach
-- brand-openedx
 - course-about-mfe
+- community-mfe
 - home-mfe
 - mfe
 - session-timeout

plugins/community-mfe.py

@@ -0,0 +1,108 @@
+from tutormfe.hooks import MFE_APPS
+from tutor import hooks
+
+
+@MFE_APPS.add()
+def mfe_forks(mfes):
+    mfes["authn"] = {
+        "repository": "https://github.com/Abstract-Tech/community-theme-authn",
+        "version": "community-theme.palm",
+        "refs": "https://api.github.com/repos/abstract-tech/community-theme-authn/git/refs/heads",
+        "port": 1999,
+        "name": "authn",
+    }
+    mfes["account"] = {
+        "repository": "https://github.com/Abstract-Tech/community-theme-account",
+        "version": "community-theme.palm",
+        "refs": "https://api.github.com/repos/abstract-tech/community-theme-account/git/refs/heads",
+        "port": 1997,
+        "name": "account",
+    }
+    mfes["communications"] = {
+        "repository": "https://github.com/Abstract-Tech/community-theme-communications",
+        "version": "community-theme.palm",
+        "refs": "https://api.github.com/repos/abstract-tech/community-theme-communications/git/refs/heads",
+        "port": 1984,
+        "name": "communications",
+    }
+    mfes["course-authoring"] = {
+        "repository": "https://github.com/Abstract-Tech/community-theme-course-authoring",
+        "version": "community-theme.palm",
+        "refs": "https://api.github.com/repos/abstract-tech/community-theme-course-authoring/git/refs/heads",
+        "port": 2001,
+        "name": "course_authoring",
+    }
+    mfes["discussions"] = {
+        "repository": "https://github.com/Abstract-Tech/community-theme-discussions",
+        "version": "community-theme.palm",
+        "refs": "https://api.github.com/repos/abstract-tech/community-theme-discussions/git/refs/heads",
+        "port": 2002,
+        "name": "discussions",
+    }
+    mfes["gradebook"] = {
+        "repository": "https://github.com/Abstract-Tech/community-theme-gradebook",
+        "version": "community-theme.palm",
+        "refs": "https://api.github.com/repos/abstract-tech/community-theme-gradebook/git/refs/heads",
+        "port": 1994,
+        "name": "gradebook",
+    }
+    mfes["learning"] = {
+        "repository": "https://github.com/Abstract-Tech/community-theme-learning",
+        "version": "community-theme.palm",
+        "refs": "https://api.github.com/repos/abstract-tech/community-theme-learning/git/refs/heads",
+        "port": 2000,
+        "name": "learning",
+    }
+    mfes["ora-grading"] = {
+        "repository": "https://github.com/Abstract-Tech/community-theme-ora-grading",
+        "version": "community-theme.palm",
+        "refs": "https://api.github.com/repos/abstract-tech/community-theme-ora-grading/git/refs/heads",
+        "port": 1993,
+        "name": "ora-grading",
+    }
+    mfes["profile"] = {
+        "repository": "https://github.com/Abstract-Tech/community-theme-profile",
+        "version": "community-theme.palm",
+        "refs": "https://api.github.com/repos/abstract-tech/community-theme-profile/git/refs/heads",
+        "port": 1995,
+        "name": "profile",
+    }
+    mfes["home"] = {
+        "repository": "https://github.com/Abstract-Tech/community-theme-home",
+        "version": "community-theme.palm",
+        "refs": "https://api.github.com/repos/abstract-tech/community-theme-home/git/refs/heads",
+        "port": 3001,
+        "name": "home",
+    }
+    mfes["course_about"] = {
+        "repository": "https://github.com/Abstract-Tech/community-theme-course-about",
+        "version": "community-theme.palm",
+        "refs": "https://api.github.com/repos/abstract-tech/community-theme-course-about/git/refs/heads",
+        "port": 3000,
+        "name": "course_about",
+    }
+    # Note: The changes of the following might not take effect due to tutor order of loading plugins
+    # This to change it you might need to edit the upstream pplugin at:
+    # https://github.com/Abstract-Tech/openedx-tutor-plugins/blob/5556c1d5c55e1a0e95f36a9f0b89dbf21382f581/plugins/tutor-contrib-learner-dashboard-mfe/tutor_learner_dashboard_mfe/plugin.py#L20-L25
+    mfes["learner-dashboard"] = {
+        "repository": "https://github.com/Abstract-Tech/community-theme-learner-dashboard",
+        "version": "community-theme.palm",
+        "refs": "https://api.github.com/repos/abstract-tech/community-theme-learner-dashboard/git/refs/heads",
+        "port":1996,
+    }
+
+    return mfes
+
+
+hooks.Filters.ENV_PATCHES.add_items(
+    [
+        (
+            "mfe-dockerfile-post-npm-install",
+            """
+RUN npm install '@edx/frontend-component-header@git+https://[email protected]/abstract-tech/community-theme-header.git#community-theme.palm' --registry=$NPM_REGISTRY
+RUN npm install '@edx/frontend-component-footer@git+https://[email protected]/abstract-tech/community-theme-footer.git#community-theme.palm' --registry=$NPM_REGISTRY
+RUN npm install '@edx/brand@git+https://[email protected]/abstract-tech/community-theme-brand.git#community-theme' --registry=$NPM_REGISTRY
+            """,
+        ),
+    ]
+)

requirements.in

@@ -1,5 +1,5 @@
-tutor<16.0.0
-tutor-mfe<16.0.0
-tutor-forum<16.0.0
-tutor-cairn<16.0.0
-tutor-minio<16.0.0
+tutor<17.0.0
+tutor-mfe<17.0.0
+tutor-forum<17.0.0
+tutor-cairn<17.0.0
+tutor-minio<17.0.0