tutor-plugin-build-mfe

DEPRECATED: tutor version v14.x and newer maintains a Docker build of the mfe plugin. Hereon, you should use Tutor's mfe build.

Github Action to use Tutor to build a Docker image of Open edX Micro Front-end (MFE) framework, and upload to an AWS Elastic Container Registry repository.

About this plugin

The "Micro Frontend base plugin for Tutor" plugin is authored by overerhangio: https://github.com/overhangio/tutor-mfe.

This plugin makes it possible to easily add micro frontend (MFE) applications on top of an Open edX platform that runs with Tutor. To learn more about MFEs, please check the official Open edX documentation.

In addition, this plugin comes with a few MFEs which are enabled by default:

• Account
• Gradebook
• Learning
• Profile

Usage

name: Example workflow

on: workflow_dispatch

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      # required antecedent
      - uses: actions/checkout@v3.2.0

      # required antecedent
      - name: Configure AWS credentials
        uses: aws-actions/configure-aws-credentials@v1.7.0
        with:
          aws-access-key-id: ${{ secrets.THE_NAME_OF_YOUR_AWS_ACCESS_KEY_ID }}
          aws-secret-access-key: ${{ secrets.THE_NAME_OF_YOUR_AWS_SECRET_ACCESS_KEY }}
          aws-region: us-east-2

      # install and configure tutor and kubectl
      - name: Configure Github workflow environment
        uses: openedx-actions/tutor-k8s-init@v1.0.4

      # This action.
      # Note that aws-ecr-repo is optional. The default value is openedx_mfe
      - name: Build the image and upload to AWS ECR
        uses: openedx-actions/tutor-plugin-build-mfe@0.1.6
        with:
          aws-ecr-repository: openedx_mfe
          subdomain: 'www'
          domain-name: 'example.com'
          site-name: 'School of Rock'