Create an AWS CodeCommit repository association in Amazon CodeGuru Reviewer - Amazon CodeGuru Reviewer

Create an AWS CodeCommit repository association in Amazon CodeGuru Reviewer

You can create an AWS CodeCommit repository association using the Amazon CodeGuru Reviewer console, the AWS CodeCommit console, the AWS CLI, or the CodeGuru Reviewer SDK. Before you create a CodeCommit repository association, you must have a CodeCommit repository in the same AWS account and Region in which you want your CodeGuru Reviewer code reviews. For more information, see Create an AWS CodeCommit repository in the AWS CodeCommit User Guide.

Create a CodeCommit repository association (CodeGuru Reviewer console)

To create a CodeCommit repository association

  1. Open the Amazon CodeGuru Reviewer console at https://console.aws.amazon.com/codeguru/reviewer/home.

  2. In the navigation pane, choose Repositories.

  3. Choose Associate repository and run analysis.

  4. Choose AWS CodeCommit.

  5. From Repository location, choose the name of your CodeCommit repository that contains the source code you want CodeGuru Reviewer to analyze.

  6. (Optional) Expand Encryption key - optional to use your own AWS Key Management Service key (KMS key) to encrypt your associated repository. For more information, see Encrypting a repository association in Amazon CodeGuru Reviewer.

    1. Select Customize encryption settings (advanced).

    2. Do one of the following:

      • If you already have a KMS key that you manage, enter its Amazon Resource Name (ARN). For information about finding the ARN of your key using the console, see Finding the key ID and ARN in the AWS Key Management Service Developer Guide.

      • If you want to create a KMS key, choose Create an AWS KMS key and follow the steps in the AWS KMS console. For more information, see Creating keys in the AWS Key Management Service Developer Guide.

  7. In Run a repository analysis, specify information for your associated repository's first full scan. This scan generates your repository's initial code review. For more information, see Get recommendations using full repository analysis.

    1. From Source branch, choose the branch to use.

    2. (Optional) In Code review name, type a name for your code review.

    3. (Optional) Expand Analysis configuration file - optional to download a sample aws-codeguru-reviewer.yml file to use as a template. Modify the file and upload it to the root directory of your repository. For more information about the analysis configuration file, see Suppress recommendations.

    
                        The Run a repository analysis section with settings and sample YAML file information.
  8. (Optional) Expand Tags to add one or more tags to your repository association. For more information, see Tagging a repository association in Amazon CodeGuru Reviewer.

    1. Choose Add new tag.

    2. In Key, enter a name for the tag. You can add an optional value for the tag in Value.

    3. (Optional) To add another tag, choose Add new tag.

  9. Choose Associate repository and run analysis. On the Repositories page, the Status is Associating. When the association is complete, the status changes to Associated and a full repository analysis begins. Refresh the page to check for the status change.

Create a CodeCommit repository association (CodeCommit console)

You can connect to CodeGuru Reviewer directly from the CodeCommit console. This allows you to create a CodeCommit repository association with CodeGuru Reviewer without leaving your CodeCommit repository context.

Create a CodeCommit repository association (AWS CLI)

For information about using the AWS CLI with CodeGuru Reviewer, see the CodeGuru Reviewer section of the AWS CLI Command Reference.

To create a CodeCommit repository association

  1. Make sure that you have configured the AWS CLI with the AWS Region in which you want to create your code reviews and in which your CodeCommit repository exists. To verify the Region, run the following command at the command line or terminal and review the information for the default name.

    aws configure

    The default Region name must match the AWS Region for the repository in CodeCommit.

  2. Run the associate-repository command specifying the name of the CodeCommit repository you want to associate.

    aws codeguru-reviewer associate-repository --repository CodeCommit={Name=my-codecommit-repo}
  3. If successful, this command outputs a RepositoryAssociation object.

    { "RepositoryAssociation": { "AssociationId": "repository-association-uuid", "Name": "my-codecommit-repo", "LastUpdatedTimeStamp": 1595634764.029, "ProviderType": "CodeCommit", "CreatedTimeStamp": 1595634764.029, "Owner": "123456789012", "State": "Associating", "StateReason": "Pending Repository Association", "AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:repository-association-uuid", } }
  4. When the associate-repository command succeeds, the status in the returned output is Associating. When the association is complete, the status changes to Associated and you can create a pull request or a full repository analysis to get recommendations. You can check your repository association's status using the describe-repository command with its Amazon Resource Name (ARN).

    aws codeguru-reviewer describe-repository-association --association-arn arn:aws:codeguru-reviewer:us-west-2:123456789012:association:repository-association-uuid
  5. If successful, this command outputs a RepositoryAssociation object which shows its status.

    { "RepositoryAssociation": { "AssociationId": "repository-association-uuid", "Name": "my-codecommit-repo", "LastUpdatedTimeStamp": 1595634764.029, "ProviderType": "CodeCommit", "CreatedTimeStamp": 1595634764.029, "Owner": "123456789012", "State": "Associated", "StateReason": ""Pull Request Notification configuration successful", "AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:repository-association-uuid" } }

Create a CodeCommit repository association (AWS SDKs)

To create a CodeCommit repository association with the AWS SDKs, use the AssociateRepository API. For more information, see AssociateRepository in the Amazon CodeGuru Reviewer API Reference.