On September 1, 2022, GitHub Learning Lab will shut down.
Read more on the GitHub blog and check out GitHub Skills for courses backed by GitHub Actions.

Building: The template block

GitHub Learning Lab is no longer accepting new public courses from outside of GitHub.

The template block in config.yml is used to identify your template repository.

GitHub Learning Lab's mascot A course on GitHub Learning Lab can guide you through this step.

A template block is composed of the following fields:

Field Required Description
name The name of the repository when it is copied for the learner.
repo The name of the repository to be copied, must have the same owner as the course. If omitted, the learner's repository will be empty.
description A one-line description which will be set for the GitHub repository.

Usage examples

An empty template repository, the name games is given to the learner's repository.

  name: games
  repo: false

A template repository called conflict-template is used. It is copied into the learner's conflict-practice repository.

  name: conflict-practice
  repo: conflict-template