Create a GitHub integration

A GitHub integration saves a GitHub personal access token in your project, so TIR can reach your private repositories.

Before you begin

• A TIR project and a role in IAM that allows Create on External Integration.
• A GitHub personal access token with the repository permissions your work needs. Create one under GitHub Settings, Developer Settings, Personal access tokens. For token types and scopes, see Managing your personal access tokens.

Create it

1. In the side menu, under PLATFORM SERVICES, select External Integrations.

2. Select Create Integration.

3. Select Github.

4. Fill in the form. You must fill in both fields.

   Field	What to enter
   Integration Name	A name for this integration, up to 30 characters. Use lowercase letters, digits, and hyphens. Start with a letter and end with a letter or digit. TIR suggests a name.
   Github Access Token	Your GitHub personal access token, free of spaces.

5. Select Create.

TIR asks GitHub which user the token belongs to, and saves the integration once GitHub accepts the token. The token’s own permissions decide which repositories it can reach, and the model endpoint form checks the repository when you use the integration. The token stays hidden once the integration is saved. You can use each name only once in a project, even after you delete that integration.

Use it

When you create a model endpoint with the Custom Container, Custom Recipe, or TIR Optimised framework, choose Link with Github as the Download Type, enter the repository, and pick this integration. See Where integrations are used.

If a message appears when you select Create, Troubleshooting External Integrations explains it.