# GitHub and GitHub Enterprise Server access in CodeBuild
For GitHub, you can use a personal access token, an OAuth app, a Secrets Manager secret, or a GitHub App connection to access the source provider. For GitHub Enterprise Server, you can use a personal access token, a Secrets Manager secret, or a GitHub App connection to access the source provider.
**Topics**
+ [
# GitHub App connections for GitHub and GitHub Enterprise Server
](connections-github-app.md)
+ [
# GitHub and GitHub Enterprise Server access token
](access-tokens-github.md)
+ [
# GitHub OAuth app
](oauth-app-github.md)
# GitHub App connections for GitHub and GitHub Enterprise Server
You can use GitHub App to connect with CodeBuild. GitHub App connections are supported through [AWS CodeConnections](https://docs.aws.amazon.com/dtconsole/latest/userguide/welcome-connections.html).
The source provider access enables you to trigger a build by subscribing to [GitHub webhook events](github-webhook.md) using [ CreateWebhook](https://docs.aws.amazon.com/codebuild/latest/APIReference/API_CreateWebhook.html), or to use [Tutorial: Configure a CodeBuild-hosted GitHub Actions runner](action-runner.md) in CodeBuild.
**Note**
CodeConnections is available in fewer regions than CodeBuild. You can use cross-region connections in CodeBuild. Connections created in opt-in regions, cannot be used in other regions. For more information, see [AWS CodeConnections endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/codestar_connections.html).
**Topics**
+ [
## Step 1: Create a connection to GitHub App (console)
](#connections-github-console)
+ [
## Step 2: Grant CodeBuild project IAM role access to use the connection
](#connections-github-role-access)
+ [
## Step 3: Configure CodeBuild to use the new connection
](#connections-github-account-credential)
+ [Troubleshooting the GitHub App](#connections-github-troubleshooting)
## Step 1: Create a connection to GitHub App (console)
Use these steps to use the CodeBuild console to add a connection for your project in GitHub.
**To create a connection to GitHub**
+ Follow the instructions in the *Developer Tools User Guide* for [Create a connection to GitHub](https://docs.aws.amazon.com/dtconsole/latest/userguide/connections-create-github.html).
**Note**
Instead of creating or using an existing connection in your account, you can use a connection shared from another AWS account. For more information, see [Share connections with AWS accounts](https://docs.aws.amazon.com/dtconsole/latest/userguide/connections-share.html).
## Step 2: Grant CodeBuild project IAM role access to use the connection
You can grant CodeBuild project IAM role access to use the GitHub tokens vended by your connection.
**To grant CodeBuild project IAM role access**
1. Create an IAM role for your CodeBuild project by following the instructions to [Allow CodeBuild to interact with other AWS services](setting-up-service-role.md) for your CodeBuild project.
1. While following the instructions, add the following IAM policy to your CodeBuild project role to grant access to the connection.
------
#### [ JSON ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"codeconnections:GetConnectionToken",
"codeconnections:GetConnection"
],
"Resource": [
"arn:aws:iam::*:role/Service*"
]
}
]
}
```
------
## Step 3: Configure CodeBuild to use the new connection
You can configure a connection as an account level credential and use it in a project.
------
#### [ AWS Management Console ]
**To configure a connection as an account level credential in the AWS Management Console**
1. For **Source provider**, choose **GitHub**.
1. For **Credential**, do one of the following:
+ Choose **Default source credential** to use your account's default source credential to apply to all projects.
1. If you aren't connected to GitHub, choose **Manage default source credential**.
1. For **Credential type**, choose **GitHub App**.
1. In **Connection**, choose to use an existing connection or create a new connection.
+ Choose **Custom source credential** to use a custom source credential to override your account's default settings.
1. For **Credential type**, choose **GitHub App**.
1. In **Connection**, choose to use an existing connection or create a new connection.
------
#### [ AWS CLI ]
**To configure a connection as an account level credential in the AWS CLI**
+ Open a terminal (Linux, macOS, or Unix) or command prompt (Windows). Use the AWS CLI to run the **import-source-credentials** command, specifying the `--auth-type`, `--server-type`, and `--token` for your connection.
Use the following command:
```
aws codebuild import-source-credentials --auth-type CODECONNECTIONS --server-type GITHUB --token
```
------
You can also set up multiple tokens for your CodeBuild projects. For more information, see [Configure multiple tokens as source level credentials](multiple-access-tokens.md#asm-source-credential).
## Troubleshooting problems with the GitHub App
The following information can help you troubleshoot common issues with the GitHub App.
**Topics**
+ [
### Install the AWS Connector for GitHub app in an undesired region
](#connections-github-troubleshooting.undesired-region)
+ [
### The GitHub App connection doesn't have access to repositories
](#connections-github-troubleshooting.repo-access)
+ [
### The AWS service's IAM role is missing necessary IAM permissions.
](#connections-github-troubleshooting.iam-permissions)
### Install the AWS Connector for GitHub app in an undesired region
**Issue:** You installed the AWS Connector for GitHub from the GitHub Marketplace, but the connection was created in an undesired region. If you attempt to reconfigure the app on the GitHub website, it won't work because the app is already installed on your GitHub account.
**Possible cause:** The app is already installed in your GitHub account, so you can only reconfigure the app permissions.
**Recommended solution:** You can create a new connection with the installation ID in the desired region.
1. Open the CodeConnections console at [https://console.aws.amazon.com/codesuite/settings/connections](https://console.aws.amazon.com/codesuite/settings/connections) and navigate to the desired region using the region selector in the AWS console navigation bar.
1. Follow the instructions in the *Developer Tools User Guide* for [Create a connection to GitHub](https://docs.aws.amazon.com/dtconsole/latest/userguide/connections-create-github.html).
**Note**
Since you've already installed the AWS Connector for GitHub app, you can choose it instead of installing a new app.
### The GitHub App connection doesn't have access to repositories
**Issue:** An AWS service using the connection, such as CodeBuild or CodePipeline, reports that it doesn't have access to the repository or the repository doesn't exist. Some possible error messages include:
+ `Authentication required for primary source.`
+ `Unable to create webhook at this time. Please try again later.`
+ `Failed to create webhook. GitHub API limit reached. Please try again later.`
***Possible cause:** You might have been using the GitHub app and haven't granted the webhook permission scope.*
**Recommended solution:** To grant the required permission scope, follow the instructions in [ Navigating to the GitHub App you want to review or modify](https://docs.github.com/en/apps/using-github-apps/reviewing-and-modifying-installed-github-apps#navigating-to-the-github-app-you-want-to-review-or-modify) to configure the installed app. Under the permissions section, you'll see the app doesn't have webhooks permission, and there is an option for you to review the newly requested permissions. Review and accept the new permissions. For more infomation, see [ Approving updated permissions for a GitHub App](https://docs.github.com/en/apps/using-github-apps/approving-updated-permissions-for-a-github-app).
***Possible cause:** The connection was working as expected, but suddenly doesn’t have access to the repositories.*
**Possible solution:** Start by reviewing your [ authorizations](https://docs.github.com/en/apps/using-github-apps/reviewing-and-revoking-authorization-of-github-apps) and your [ installations](https://docs.github.com/en/apps/using-github-apps/reviewing-and-modifying-installed-github-apps), then verify the GitHub App is authorized and installed. If the GitHub App installation is suspended, then you need to unsuspended it. If the GitHub App is not authorized for a [UAT (User Access Token)](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user) connection, or not installed for an [ IAT (Installation Access Token)](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-as-a-github-app-installation) connection, the existing connection is not usable any more, and you will need to create a new connection. Note that reinstalling the GitHub App will not revive the previous connection that was associated to the old installation.
**Possible solution:** If the connection is a UAT connection, make sure the connection is not concurrently being used, such as a being used in multiple CodeBuild concurrent runs of build. This is because GitHub immediately invalidates a previously issued UAT if an expiring token is refreshed by the connection. If you need to use UAT connection for multiple concurrent CodeBuild builds, you can create multiple connections and use each connection independently.
**Possible solution:** If the UAT connection hasn't been used in the past 6 months, the connection will be invalidated by GitHub. To fix this, create a new connection.
***Possible cause:** You might have been using a UAT connection without installing the app.*
**Recommended solution:** Though creating a UAT connection doesn't require associating the connection with a GitHub App installation, an installation is required for the repository to be accessible. Follow the instructions to [ review installations](https://docs.github.com/en/apps/using-github-apps/reviewing-and-modifying-installed-github-apps) to make sure the GitHub App is installed. If it is not installed, navigate to the [GitHub App's page](https://github.com/marketplace/aws-connector-for-github) to install the app. For more information about UAT's access, see [About user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app#about-user-access-tokens).
### The AWS service's IAM role is missing necessary IAM permissions.
**Issue:** You see any of the following error messages:
+ `Access denied to connection `
+ `Failed to get access token from `
**Recommended solution:** Typically you use a connection with an AWS service, such as CodePipeline or CodeBuild. When you give the AWS service an IAM role, the AWS service can use the role's permission to act on your behalf. Make sure the IAM role has necessary permission. For more information about the necessary IAM permission, see [Grant CodeBuild project IAM role access to use the connection](#connections-github-role-access) and [Identity and access management for AWS CodeStar Notifications and CodeConnections](https://docs.aws.amazon.com/dtconsole/latest/userguide/security-iam.html) in the *Developer Tools console User Guide*.
# GitHub and GitHub Enterprise Server access token
## Access token prerequisites
Before you begin, you must add the proper permission scopes to your GitHub access token.
For GitHub, your personal access token must have the following scopes.
+ **repo**: Grants full control of private repositories.
+ **repo:status**: Grants read/write access to public and private repository commit statuses.
+ **admin:repo\$1hook**: Grants full control of repository hooks. This scope is not required if your token has the `repo` scope.
+ **admin:org\$1hook**: Grants full control of organization hooks. This scope is only required if you are using the organization webhook feature.
For more information, see [Understanding scopes for OAuth apps](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/) on the GitHub website.
If you are using fine-grained personal access tokens, depending on your use case, your personal access token might need the following permissions:
+ **Contents: Read-only**: Grants access to private repositories. This permission is required if you are using private repositories as source.
+ **Commit statuses: Read and write**: Grants permission to create commit statuses. This permission is required if your project has webhook set up, or you have report build status feature enabled.
+ **Webhooks: Read and write**: Grants permission to manage webhooks. This permission is required if your project has webhook set up.
+ **Pull requests: Read-only**: Grants permission to access pull requests. This permission is required if your webhook has a `FILE_PATH` filter on pull request events.
+ **Administration: Read and write**: This permission is required if you are using the self-hosted GitHub Actions runner feature with CodeBuild. For more details, see [Create a registration token for a repository](https://docs.github.com/en/rest/actions/self-hosted-runners?apiVersion=2022-11-28#create-a-registration-token-for-a-repository) and [Tutorial: Configure a CodeBuild-hosted GitHub Actions runner](action-runner.md).
**Note**
If you want to access organization repositories, make sure you specify the organization as the resource owner of the access token.
For more information, see [ Permissions required for fine-grained personal access tokens](https://docs.github.com/en/rest/authentication/permissions-required-for-fine-grained-personal-access-tokens?apiVersion=2022-11-28) on the GitHub website.
## Connect GitHub with an access token (console)
To use the console to connect your project to GitHub using an access token, do the following when you create a project. For information, see [Create a build project (console)](create-project.md#create-project-console).
1. For **Source provider**, choose **GitHub**.
1. For **Credential**, do one of the following:
+ Choose to use account credentials to apply your account's default source credential to all projects.
1. If you aren't connected to GitHub, choose **Manage account credential**.
1. For **Credential type**, choose **Personal access token**.
+ If you chose to use account level credentials for **Service**, choose which service you'd like to use to store your token and do the following:
1. If you choose to use **Secrets Manager**, you can choose to use an existing secret connection or create a new secret, and then choose **Save**. For more information how to create a new secret, see [Create and store a token in a Secrets Manager secret](asm-create-secret.md).
1. If you choose to use **CodeBuild**, enter your GitHub personal access token, and then choose **Save**.
+ Select **Use override credentials for this project only** to use a custom source credential to override your account's credential settings.
1. From the populated credential list, choose one of the options under **Personal access token**.
1. You can also create new personal access token by selecting **create a new personal access token connection** in the description.
## Connect GitHub with an access token (CLI)
Follow these steps to use the AWS CLI to connect your project to GitHub using an access token. For information about using the AWS CLI with AWS CodeBuild, see the [Command line reference](cmd-ref.md).
1. Run the **import-source-credentials** command:
```
aws codebuild import-source-credentials --generate-cli-skeleton
```
JSON-formatted data appears in the output. Copy the data to a file (for example, `import-source-credentials.json`) in a location on the local computer or instance where the AWS CLI is installed. Modify the copied data as follows, and save your results.
```
{
"serverType": "server-type",
"authType": "auth-type",
"shouldOverwrite": "should-overwrite",
"token": "token",
"username": "username"
}
```
Replace the following:
+ *server-type*: Required value. The source provider used for this credential. Valid values are GITHUB, BITBUCKET, GITHUB\$1ENTERPRISE, GITLAB, and GITLAB\$1SELF\$1MANAGED.
+ *auth-type*: Required value. The type of authentication used to connect to a repository. Valid values are OAUTH, BASIC\$1AUTH, PERSONAL\$1ACCESS\$1TOKEN, CODECONNECTIONS, and SECRETS\$1MANAGER. For GitHub, only PERSONAL\$1ACCESS\$1TOKEN is allowed. BASIC\$1AUTH is only allowed with Bitbucket app password.
+ *should-overwrite*: Optional value. Set to `false` to prevent overwriting the repository source credentials. Set to `true` to overwrite the repository source credentials. The default value is `true`.
+ *token*: Required value. For GitHub or GitHub Enterprise Server, this is the personal access token. For Bitbucket, this is the personal access token or app password. For the auth-type CODECONNECTIONS, this is the connection ARN. For the auth-type SECRETS\$1MANAGER, this is the secret ARN.
+ *username*: Optional value. This parameter is ignored for GitHub and GitHub Enterprise Server source providers.
1. To connect your account with an access token, switch to the directory that contains the `import-source-credentials.json` file you saved in step 1 and run the **import-source-credentials** command again.
```
aws codebuild import-source-credentials --cli-input-json file://import-source-credentials.json
```
JSON-formatted data appears in the output with an Amazon Resource Name (ARN).
```
{
"arn": "arn:aws:codebuild:region:account-id:token/server-type"
}
```
**Note**
If you run the **import-source-credentials** command with the same server type and auth type a second time, the stored access token is updated.
After your account is connected with an access token, you can use `create-project` to create your CodeBuild project. For more information, see [Create a build project (AWS CLI)](create-project.md#create-project-cli).
1. To view the connected access tokens, run the **list-source-credentials** command.
```
aws codebuild list-source-credentials
```
A JSON-formatted `sourceCredentialsInfos` object appears in the output:
```
{
"sourceCredentialsInfos": [
{
"authType": "auth-type",
"serverType": "server-type",
"arn": "arn"
}
]
}
```
The `sourceCredentialsObject` contains a list of connected source credentials information:
+ The `authType` is the type of authentication used by credentials. This can be `OAUTH`, `BASIC_AUTH`, `PERSONAL_ACCESS_TOKEN`, `CODECONNECTIONS`, or `SECRETS_MANAGER`.
+ The `serverType` is the type of source provider. This can be `GITHUB`, `GITHUB_ENTERPRISE`, `BITBUCKET`, `GITLAB`, or `GITLAB_SELF_MANAGED`.
+ The `arn` is the ARN of the token.
1. To disconnect from a source provider and remove its access tokens, run the **delete-source-credentials** command with its ARN.
```
aws codebuild delete-source-credentials --arn arn-of-your-credentials
```
JSON-formatted data is returned with an ARN of the deleted credentials.
```
{
"arn": "arn:aws:codebuild:region:account-id:token/server-type"
}
```
# GitHub OAuth app
## Connect GitHub using OAuth (console)
To use the console to connect your project to GitHub using an OAuth app, do the following when you create a project. For information, see [Create a build project (console)](create-project.md#create-project-console).
1. For **Source provider**, choose **GitHub**.
1. For **Credential**, do one of the following:
+ Choose to use account credentials to apply your account's default source credential to all projects.
1. If you aren't connected to GitHub, choose **Manage account credential**.
1. For **Credential type**, choose **OAuth app**.
+ If you chose to use account level credentials for **Service**, choose which service you'd like to use to store your token and do the following:
1. If you choose to use **Secrets Manager**, you can choose to use an existing secret connection or create a new secret, and then choose **Save**. For more information how to create a new secret, see [Create and store a token in a Secrets Manager secret](asm-create-secret.md).
1. If you choose to use **CodeBuild** and then choose **Save**.
+ Select **Use override credentials for this project only** to use a custom source credential to override your account's credential settings.
1. From the populated credential list, choose one of the options under **OAuth app**.
1. You can also create new OAuth app token by selecting **create a new Oauth app token connection** in the description.
To review your authorized OAuth apps, navigate to [Applications](https://github.com/settings/applications) on GitHub, and verify that an application named `AWS CodeBuild (region)` owned by [aws-codesuite](https://github.com/aws-codesuite) is listed.