Version Compatibility

For this plugin’s compatibility with Open edX, see the Open edX Release Compatibility table.

Installation

For detailed installation instructions, please refer to the plugin installation guide.

Installation required in:

• Studio (CMS)

Configuration

• Enable the following FEATURES flags in the config file in Open edX. For any release after Juniper, that config file is /edx/etc/cms.yml. If you’re using private.py, you will need to enable these FEATURES in cms/envs/private.py.

  "FEATURES": {
      "ENABLE_EXPORT_GIT": true,
      "ENABLE_AUTO_GITHUB_REPO_CREATION": true  # Optional, to auto create github repo for new courses
  }
  # Set when ENABLE_AUTO_GITHUB_REPO_CREATION is true
  GITHUB_ORG_API_URL = "https://api.github.com/orgs/<GITHUB_ORG_NAME>"  # For GitHub Enterprise, change the URL accordingly
  GITHUB_ACCESS_TOKEN = "<GITHUB_PERSONAL_ACCESS_TOKEN>"  # Token must have 'repo - Full control of private repositories' permission

• Set your commit user in cms/envs/common.py, if you don’t want to use the default one

  GIT_EXPORT_DEFAULT_IDENT = {
      'name': 'STUDIO_EXPORT_TO_GIT',
      'email': 'STUDIO_EXPORT_TO_GIT@example.com'
  }

• Restart the server using make studio-restart on Devstack or tutor dev/local restart openedx on Tutor.

• For Tutor installations, these values can also be managed through a custom tutor plugin.

Library Support

This plugin supports automatic git export for both courses and content libraries.

Re-exporting Without a Publish

Courses are exported only when published and libraries only when updated, so content whose export failed stays stale in git until its next change. To queue an export on demand, fix whatever made the export fail, then use either:

• The Export selected content to git action on the Content Git Repositories page in Django admin.

• The export_to_git management command:

  # Specific courses or libraries
  ./manage.py cms export_to_git --content-keys course-v1:MITx+6.00x+2T2024 lib:MITx:mylib
  
  # Every repository with export enabled; --dry-run lists without queueing
  ./manage.py cms export_to_git --all --dry-run

Both skip, and report, content that no longer exists and content whose auto-export settings (ENABLE_EXPORT_GIT plus the course or library flag) are off, and report content whose export could not be queued. The admin action and --content-keys also skip rows with is_export_enabled off, while --all only considers rows with it on. The command also reports keys with no repository, and exits non-zero if any key errored or, with --content-keys, if any named key was skipped. Exports go through the same debounce as publish-triggered ones: a request made during a pending export’s 5-second countdown is merged into it, but one made after that export has started queues another.