Skip to main content

Manage GitHub Account

Connect GitHub account​

Teachstack stores every course in your own repo. You retain full control of the course material that you author.

  1. Navigate to the Settings page using the sidebar on the left-hand side.
  2. Go to the Account tab and locate the GitHub Connection section.
  3. Click the Connect to GitHub button to begin the connection wizard. You will be redirected to the GitHub website.
  4. Install and authorise the Teachstack App with the requested permissions for all repositories.
  5. Upon returning to you should see your GitHub account listed under GitHub Connection.
warning

Permissions must be granted at the account level to create courses. Once you have created your course and you don't envisage creating more, you may assign read and write permissions to individual repositories housing specific courses.

Update GitHub Account

Teachstack lets you manage the binding with your GitHub account and edit the scope of the permissions you grant to Teachstack.

  1. Navigate to the Settings page using the sidebar on the left-hand side.
  2. Go to the Account tab and locate the GitHub Connection section.
  3. Click the Update button found to the right-hand side of your GitHub account name. This will redirect you to the GitHub website.
  4. Make your desired edits to your GitHub account permissions and click the Save button.
  5. You will be returned to the Teachstack settings page and your changes will take effect immediately.
warning

If you do not grant read and write access to a repository containing a course, Teachstack will have no way to parse its content and allow it to populate the Teachstack platform. This may also cause additional settings and other features to break. We recommend you keep the required read and write permissions enabled at a global GitHub account level.

Remove GitHub Account

Follow the steps below to remove your GitHub account binding from your Teachstack account. Note that while it will be possible to reconnect the account, it will permanently delete settings and configurations you have saved for any courses contained within the GitHub account.

  1. Navigate to the Settings page using the sidebar on the left-hand side.
  2. Go to the Account tab and locate the GitHub Connection section.
  3. Click the Remove button found to the right-hand side of your GitHub account name. This will open a confirmation modal.
  4. Carefully read the warning text within the modal, which will outline the consequences of removing a GitHub account binding.
  5. If you are ready to proceed, type your GitHub account name using the text entry field and click the Remove button.
warning

Your GitHub repositories containing the course material will not be deleted. If you want to permanently delete your course material, you will need to do this manually in GitHub.

It will be possible to reconnect your GitHub account to this Teachstack account, but it will not restore links, settings, or unique IDs.