Syncing course data with GitHub
A live PrairieLearn server can be set up to allow syncing with a course data repository on GitHub (or another remote git repository).
If enabled, Instructor
users will see a Sync page on PrairieLearn. This page has a green "Sync" button which will pull updates from the configured repository.
Instructions for server administrators
Syncing will be automatically enabled if two conditions are met:
-
The directory pointed to by
courseDir
should be a cloned git repository, with theorigin
fetch remote set to the desired remote repository. This will be automatically enabled if the course directory was created by a command likegit clone git@github.com:PrairieLearn/pl-tam212.git
. -
The variable
gitCourseBranch
in the courseconfig.json
should be set to the remote branch to pull from (e.g.,master
).