Creating and using the GitHub App connection: step-by-step guide

Question

Is there a detailed and illustrative step-by-step guide on how to set up and use the GitHub App connection?

Answer

The following is a step-by-step guide for manually setting up the GitHub App connection and using it to create projects and VCS roots. In many cases, the automatic GitHub App creation can be used successfully.

1. Create a new GitHub App connection in TeamCity and select the manual creation:
2. Log in to the GitHub account in a separate tab, open Account Settings > Developer Settings, and create a new GitHub App. Set up the GitHub App following the instructions that TeamCity has provided:
3. Generate and copy the client secret for the created GitHub App.
4. Generate and download the private key for the created GitHub App as .private-key.pem.
5. Install the created GitHub App on the account/organization:
6. Back to the connection settings on the TeamCity's side, finish setting up the connection with the downloaded key and other required information:
7. Test the connection:
8. Create a new VCS root using the created GitHub App connection:
9. As it is the first time the connection is used, it is required to sign in to the GitHub account:
10. Clicking the sign-in button will open a new browser tab or window with the GitHub App authorization page:
11. Authorize the app:
12. The connection and app are ready to use and can be used to create VCS roots. The list of repositories is fetched when clicking the GitHub icon:
13. The same GitHub App connection may be used to create new projects from the existing repository: