1
0
mirror of synced 2025-12-23 11:54:18 -05:00
Files
docs/content/education/manage-coursework-with-github-classroom/configure-default-settings-for-assignment-repositories.md
2020-12-08 15:59:35 +01:00

4.5 KiB

title, shortTitle, intro, permissions, versions, redirect_from
title shortTitle intro permissions versions redirect_from
Configure default settings for assignment repositories Configure defaults for assignment repositories You can use the Probot Settings app to configure the default settings for repositories that {% data variables.product.prodname_classroom %} creates for an assignment. Organization owners can configure default settings for assignment repositories by installing a {% data variables.product.prodname_github_app %} for the organization.
free-pro-team
*
/education/manage-coursework-with-github-classroom/probot-settings

About configuration of defaults for assignment repositories

{% data variables.product.prodname_classroom %} creates a repository that belongs for each student or team that accepts an assignment. The repository belongs to the organization that you use for {% data variables.product.prodname_classroom %}. Assignment repositories can be empty, or you can use a template repository. For more information, see "Create an assignment from a template repository."

{% data reusables.classroom.you-may-want-to-predefine-repository-settings %}

With the Probot Settings app, you can create a file named .github/settings.yml in a repository that contains a list of settings for the repository, and then install a {% data variables.product.prodname_github_app %} for your organization that automatically applies the settings to the repository.

You can include .github/settings.yml in a template repository that you use for an assignment in {% data variables.product.prodname_classroom %}. When an individual or team accepts the assignment, {% data variables.product.prodname_classroom %} creates the assignment repository, and the Settings app automatically applies the settings from .github/settings.yml.

Probot is a a project, framework, and collection of free apps to automate {% data variables.product.product_name %}. A Probot app can listen to repository events, like the creation of new commits, comments, and issues, and automatically respond to the event.

For more information, see the Probot website and the Settings app website. For more information about {% data variables.product.prodname_github_apps %}, see "About apps."

Adding the Settings app to your organization

After you install the Probot Settings app for your organization, the app will apply the settings that you define in .github/settings.yml for any repository in your organization, including new assignment repositories that {% data variables.product.prodname_classroom %} creates.

  1. Navigate to the Settings app page.
  2. Click Install, then click the organization that you use for {% data variables.product.prodname_classroom %}. Provide the app full access to all repositories owned by the organization. Installing the Probot Settings app

Configuring default settings for an assignment repository

  1. Create a template repository that contains a .github/settings.yml file. For a complete list of settings, see the README for the probot/settings repository. For more information about using a template repository for starter code in {% data variables.product.prodname_classroom %}, see "Create an assignment from a template repository."

    {% warning %}

    Warning: Do not define collaborators in the .github/settings.yml file for your template repository. {% data variables.product.prodname_classroom %} automatically grants teachers and teaching assistants access to assignment repositories.

    {% endwarning %}

  2. Create an assignment using the template repository containing .github/settings.yml as the starter code. {% data reusables.classroom.for-more-information-about-assignment-creation %}

The Probot Settings app for your organization will now apply the settings you define in .github/settings.yml within the template repository to every assignment repository that {% data reusables.classroom.you-may-want-to-predefine-repository-settings %} creates for a student or team.

Further reading