tutor-plugin-build-openedx's Introduction

tutor-plugin-build-openedx

Github Action that uses Tutor to build a Docker image for openedx, and uploads to an AWS Elastic Container Registry repository.

This action was originally created to work seamlessly with AWS EKS Kubernetes and ECR resources created by the Terraform modules contained in Cookiecutter Tutor Open edX Production Devops Tools but it should also work with your own custom workflows.

About the openedx image

This is a production-ready image of the Open edX learning management system, substantially consisting of the repository https://github.com/openedx/edx-platform.

Usage:

name: Example workflow

on: workflow_dispatch

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      # required antecedent
      - uses: actions/[email protected]

      # required antecedent
      - name: Configure AWS credentials
        uses: aws-actions/[email protected]
        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/[email protected]

      # This action.
      # Note:
      # aws-ecr-repo is optional. The default value is openedx
      - name: Build the image and upload to AWS ECR
        uses: openedx-actions/[email protected]
        with:
          aws-ecr-repo: openedx

Recommend Projects