Amazon Q Developer for GitHub (Preview) - Amazon Q Developer
Installing Amazon Q Developer app and authorizing accessAmazon Q Developer agentsRegistering app installationUsing browser extensions in GitHub

Amazon Q Developer for GitHub (Preview)

Note

Amazon Q Developer for GitHub is in preview release and is subject to change.

Amazon Q Developer for GitHub or GitHub Enterprise Cloud allows you to leverage Amazon Q Developer capabilities for your software development workflows. With specialized development agents, you can implement new ideas, review code for quality issues, address vulnerabilities with unit tests, and modernize legacy Java applications. Once the agent completes a task, you can provide feedback, and the agent iterates on the previous solution. For more information, see Amazon Q Developer agents.

You can access the Amazon Q Developer integration through GitHub and authorize it to provide access to your organization's repositories. To get started with Amazon Q Developer for GitHub, see Quickstart: Installing, using features in GitHub, and increasing usage limits.

Important

To install the Amazon Q Developer app and authorize access to GitHub repositories, you must meet the requirements for the GitHub organization. For more information, see Requirements to install a GitHub App and Roles in organization in the GitHub documentation.

Note

The Amazon Q Developer integration with GitHub processes data in the United States. For more information, see Cross-region processing in Amazon Q Developer.

Note

Amazon Q Developer for GitHub (Preview) does not currently use your content for service improvement. If we enable this in the future, we will provide you with adequate notice and a way for you to opt out of such use.

Topics

Installing Amazon Q Developer app and authorizing access

As a GitHub organization administrator, you can install and configure the Amazon Q Developer app from GitHub for free without the need to set up an AWS account to get started. During the installation process, you choose to provide access to all or selected repositories in your GitHub organization. After installing and authorizating, you have access to free usage for the Amazon Q Developer features in GitHub. You can increase free usage by registering the app installation in the Amazon Q Developer console. For more information, see Quickstart: Installing, using features in GitHub, and increasing usage limits.

Important

To install the Amazon Q Developer app and authorize access to GitHub repositories, you must meet the requirements for the GitHub organization. For more information, see Requirements to install a GitHub App and Roles in organization in the GitHub documentation.

Note

If your GitHub enterprise organization has enabled IP allowlisting, you must accept the allowed IP addresses on the GitHub app. You can also choose to automatically add the IP addresses to your allow list. For more information, see Allowing access by GitHub Apps and Enabling allowed IP addresses in the GitHub documentation.

The following IP addresses are used to access your GitHub resources:

34.228.181.128
44.219.176.187
54.226.244.221

Amazon Q Developer agents

Amazon Q Developer agents provide support across the software development lifecycle from coding, testing, and deploying to troubleshooting and modernizing applications.

  • Amazon Q development agent – After creating an issue and adding the feature development label, Amazon Q Developer automatically implements your new features and bug fixes. Amazon Q Developer creates a pull request with the changes and a summary of the changes. For more information, see Developing features and iterating with Amazon Q Developer in GitHub.

  • Amazon Q code review agent – When a new pull request is created or a closed pull request is reopened, Amazon Q Developer automatically performs a code review and provides feedback on code quality, potential issues, and security concerns. Amazon Q Developer also generates fixes for the identified issues, which you can review and choose to commit to the pull request. Automatic code reviews are not triggered by subsequent commits made within an existing pull request. You can initiate additional code reviews within pull requests with the /q review slash command. For more information, see Reviewing code with Amazon Q Developer in GitHub.

  • Amazon Q transform agent – After creating an issue and adding the code transformation label, Amazon Q Developer transforms your code from Java version 8 or 11 to version 17. Amazon Q Developer creates a pull request with the changes and summary of the changes. For more information, see Transforming code with Amazon Q Developer in GitHub.

Important

The Amazon Q Developer app attempts to automatically create the Amazon Q development agent and the Amazon Q transform agent labels in GitHub repositories you authorize access to. If the labels are not automatically created, or if they're unintentionally deleted, you can manually create them in GitHub. The labels must be named as Amazon Q development agent and Amazon Q transform agent in order for them to be recognized and processed as Amazon Q Developer labels. For more information, see Creating a label in the GitHub documentation.

Registering app installation

The Amazon Q Developer integration for GitHub is available for free without the need to set up an AWS account to get started. You're provided with limited invocations per month for feature development and code transformation, as well as limited number of lines for code reviews per month. You can increase free usage by registering your Amazon Q Developer app installation with your AWS account. For more information, see Increasing usage limits and configuring details in Amazon Q Developer console.

Important

To register the app installation in the Amazon Q Developer console, you must meet the requirements for the GitHub organization. For more information, see Requirements to install a GitHub App and OAuth apps and organizations in the GitHub documentation.

Using browser extensions in GitHub

You can use the Amazon Q Developer extension in a supported browser to quickly add a label for feature development or code transformation in GitHub issues without having to search through label menus.

The Amazon Q Developer extension is available for the following browsers: