Sync and Import Teaching Material Repositories

On the Teaching Material Repositories screen, you can connect teaching material repositories on GitHub to Exercode, review differences, and then import them. After you confirm an import, processing runs in the background, so it will continue even if you close the screen.

Audience

• Members of teaching material repositories
• Teaching material creators

What You Can Do

• Add teaching material repositories via the GitHub App
• Register teaching material repositories you have added to an organization you manage
• Sync the latest state from GitHub
• Review differences before importing
• Check the import progress
• Open imported courses

How to Open

1. Open Teaching Material Repositories from the header.
2. Check the card for the target repository.

Workflow

1. To add a new teaching material repository, use Add from My GitHub.
2. To reflect additions or permission changes on GitHub, run Sync with My GitHub.
3. To register a teaching material repository you have added to an organization, press Register to Organization on the target repository and select the destination organization.
4. Press Import on the target repository.
5. In the confirmation dialog, review the differences in courses, problems, classes, teaching materials, assignments, and files.
6. If there are no issues, confirm the import.
7. After the import is confirmed, the confirmation dialog closes. While processing, the Import button on the target repository shows a loading indicator.
8. If you keep the screen where you started the import open, a completion notification appears in the bottom-right corner when finished. The imported courses in the card are also updated.

Course IDs belonging to a different teaching material repository cannot be overwritten by a normal import. To move a course between repositories owned by the same owner or organization, delete the course from the latest state of the source repository, then run Move Course, which is displayed in the import confirmation dialog of the destination repository. After the move, review the differences again before importing.

Importing also fails if a problem ID belongs to a different teaching material repository. If the problem ID duplication is unintended, change the problem ID on GitHub. If problems are to move as a result of moving a course, do not move the problems alone; use the Move Course feature described above instead.

While an Import Is Running

Imports run in the background. Even if you close your browser or navigate to another page while processing, the server-side processing continues.

For a repository being processed, the Import button is disabled. Hovering over the button shows which repository's import is currently running.

If you run imports on multiple teaching material repositories, the import processes run sequentially. Therefore, you may have to wait until another repository's import completes before yours starts and finishes.

Registering to an Organization

Register to Organization appears for teaching material repositories that you added via the GitHub App but have not yet registered. You can select only organizations in which you are an administrator as the registration destination.

Once registered to an organization, that organization's administrators can also view and import the teaching material repository. Additionally, courses imported from a registered repository can be added to organizations and groups.

What to Check When Reviewing Differences

• If deletions are included, the existing teaching material structure may change.
• Files includes differences in images, PDFs, and other files under assets.
• If there are no changes, re-importing as-is will not update the content.

After Import

• Imported courses are displayed in the card.
• You can open the course screen directly from the displayed course name.
• If you keep the screen where you started the import open, a notification appears in the bottom-right corner upon completion.

Common Failure Cases

• The target repository is no longer visible to the GitHub App
• Duplication with course IDs or problem IDs already used in other teaching material repositories
• Inconsistencies in the reference relationships of teaching material definitions or in the YAML format

If an error occurs, a dialog showing the failure details appears on the screen where you started the import. If you closed the screen or want to check later, you can view the failure on the target repository's card.

For errors that can be fixed by adjusting GitHub settings or the teaching material content, details are displayed along with actions to open in GitHub, open in VSCode, and copy an AI-fix prompt. For errors whose cause cannot be identified, Retry is displayed. If retrying does not resolve the issue, please contact an administrator.

Related Pages

• Import Teaching Materials
• Add Courses to Organizations and Groups