Getting started with connections - Developer Tools console
PrerequisitesStep 1: Edit your source fileStep 2: Create your pipelineStep 3: Associate your repository with CodeGuru Reviewer

Getting started with connections

The easiest way to get started with connections is to set up a connection that associates your third-party source repository to your AWS resources. If you wanted to connect your pipeline to an AWS source, such as CodeCommit, you would connect to it as a source action. However, if you have an external repository, you have to create a connection to associate your repository with your pipeline. In this tutorial, you set up a connection with your Bitbucket repository and your pipeline.

In this section, you use connections with:

  • AWS CodePipeline: In these steps, you create a pipeline with your Bitbucket repository as the pipeline source.

  • Amazon CodeGuru Reviewer: Next, you associate your Bitbucket repository to your feedback and analysis tools in CodeGuru Reviewer.

Prerequisites

Before you begin, complete the steps in Setting up. You also need a third-party source repository that you want to connect to your AWS services and allow the connection to manage authentication for you. For example, you might want to connect a Bitbucket repository to your AWS services that integrate with source repositories.

  • Create a Bitbucket repository with your Bitbucket account.

  • Have your Bitbucket credentials ready. When you use the AWS Management Console to set up a connection, you are asked to sign in with your Bitbucket credentials.

Step 1: Edit your source file

When you create your Bitbucket repository, a default README.md file is included, which you will edit.

  1. Log in to your Bitbucket repository and choose Source.

  2. Choose the README.md file and choose Edit at the top of the page. Delete the existing text and add the following text.

    This is a Bitbucket repository!

  3. Choose Commit.

    Make sure the README.md file is at the root level of your repository.

Step 2: Create your pipeline

In this section, you create a pipeline with the following actions:

  • A source stage with a connection to your Bitbucket repository and action.

  • A build stage with an AWS CodeBuild build action.

To create a pipeline with the wizard

  1. Sign in to the CodePipeline console at https://console.aws.amazon.com/codepipeline/.

  2. On the Welcome page, Getting started page, or Pipelines page, choose Create pipeline.

  3. In Step 1: Choose pipeline settings, in Pipeline name, enter MyBitbucketPipeline.

  4. In Service role, choose New service role.

    Note

    If you choose instead to use your existing CodePipeline service role, make sure that you have added the codeconnections:UseConnection IAM permission to your service role policy. For instructions for the CodePipeline service role, see Add permissions to the the CodePipeline service role.

  5. Under Advanced settings, leave the defaults. In Artifact store, choose Default location to use the default artifact store, such as the Amazon S3 artifact bucket designated as the default, for your pipeline in the Region you selected for your pipeline.

    Note

    This is not the source bucket for your source code. This is the artifact store for your pipeline. A separate artifact store, such as an S3 bucket, is required for each pipeline.

    Choose Next.

  6. On the Step 2: Add source stage page, add a source stage:

    1. In Source provider, choose Bitbucket.

    2. Under Connection, choose Connect to Bitbucket.

    3. On the Connect to Bitbucket page, in Connection name, enter the name for the connection that you want to create. The name helps you identify this connection later.

      Under Bitbucket apps, choose Install a new app.

    4. On the app installation page, a message shows that the AWS CodeStar app is trying to connect to your Bitbucket account. Choose Grant access. After you have authorized the connection, your repositories on Bitbucket are detected, and you can choose to associate one with your AWS resource.

    5. The connection ID for your new installation is displayed. Choose Complete connection. You will be returned to the CodePipeline console.

    6. In Repository name, choose the name of your Bitbucket repository.

    7. In Branch name, choose the branch for your repository.

    8. Make sure the Start the pipeline on source code change option is selected.

    9. Under Output artifact format, choose one of the following: CodePipeline default.

      • Choose CodePipeline default to use the default zip format for artifacts in the pipeline.

      • Choose Full clone to include Git metadata about the repository for artifacts in the pipeline. This is only supported for CodeBuild actions.

    Choose Next.

  7. In Add build stage, add a build stage:

    1. In Build provider, choose AWS CodeBuild. Allow Region to default to the pipeline Region.

    2. Choose Create project.

    3. In Project name, enter a name for this build project.

    4. In Environment image, choose Managed image. For Operating system, choose Ubuntu.

    5. For Runtime, choose Standard. For Image, choose aws/codebuild/standard:5.0.

    6. For Service role, choose New service role.

    7. Under Buildspec, for Build specifications, choose Insert build commands. Choose Switch to editor, and paste the following under Build commands:

      version: 0.2

phases:
  install:
    #If you use the Ubuntu standard image 2.0 or later, you must specify runtime-versions.
    #If you specify runtime-versions and use an image other than Ubuntu standard image 2.0, the build fails.
    runtime-versions:
      nodejs: 12
      # name: version
    #commands:
      # - command
      # - command
  pre_build:
    commands:
      - ls -lt
      - cat README.md
  # build:
    #commands:
      # - command
      # - command
  #post_build:
    #commands:
      # - command
      # - command
#artifacts:
  #files:
    # - location
    # - location
  #name: $(date +%Y-%m-%d)
  #discard-paths: yes
  #base-directory: location
#cache:
  #paths:
    # - paths

    8. Choose Continue to CodePipeline. This returns to the CodePipeline console and creates a CodeBuild project that uses your build commands for configuration. The build project uses a service role to manage AWS service permissions. This step might take a couple of minutes.

    9. Choose Next.

  8. On the Step 4: Add deploy stage page, choose Skip deploy stage, and then accept the warning message by choosing Skip again. Choose Next.

  9. On Step 5: Review, choose Create pipeline.

  10. When your pipeline is successfully created, a pipeline execution starts.

    Console screenshot showing successfully completed pipeline with Bitbucket source.

  11. On your successful build stage, choose Details.

    Under Execution details, view the CodeBuild build output. The commands output the README.md file contents as follows:

    This is a Bitbucket repository!
    Console screenshot showing successfully completed build output example.

Step 3: Associate your repository with CodeGuru Reviewer

After you create a connection, you can use that connection for all of your AWS resources in the same account. For example, you can use the same Bitbucket connection for a CodePipeline source action in a pipeline and your repository commit analysis in CodeGuru Reviewer.

  1. Sign in to the CodeGuru Reviewer console.

  2. Under CodeGuru Reviewer, choose Associate repository.

    The one-page wizard opens.

  3. Under Select source provider, choose Bitbucket.

  4. Under Connect to Bitbucket (with AWS CodeConnections), choose the connection you created for your pipeline.

  5. Under Repository location, choose the name of your Bitbucket repository, and choose Associate.

    You can continue to set up code reviews. For more information, see Connecting to Bitbucket to associate a repository with CodeGuru Reviewer in the Amazon CodeGuru Reviewer User Guide.