Creating a project in Amazon CodeCatalyst

With CodeCatalyst projects, you can conduct development tasks with shared continuous integration/continuous delivery (CI/CD) workflows and repositories, manage resources, track issues, and add users.

Before you create a project, you must have the Space administrator or Power user role.

Creating a project with a blueprint

You can provision all of your project resources and sample code with a project blueprint. For information about blueprints, see the blueprint reference at Project blueprint reference.

To create a project with a blueprint

1. In the CodeCatalyst console, navigate to the space where you want to create a project.

2. On the space dashboard, choose Create project.

3. Choose Start with a blueprint.

4. Choose a blueprint, and then choose Next.

5. Under Give a name to your project, enter the name that you want to assign to your project and its associated resource names. The name must be unique within your space.

6. Under Project resources, configure common project parameters.

7. (Optional) To view definition files with updates based on the project parameter selections you made, choose View code or View workflow from Generate project preview.

8. (Optional) Choose View details from the blueprint's card to view specific details about the blueprint, such as an overview of the blueprint's architecture, required connections and permissions, and the kind of resources the blueprint creates.

9. Choose Create project.

   For more information about project blueprints, see Project blueprint reference.

Creating an empty project in Amazon CodeCatalyst

You can create an empty project with no resources and manually add the resources you want at a later time.

Before you create a project, you must have the Space administrator or Power user role.

To create an empty project

1. Navigate to the space where you want to create a project.

2. On the space dashboard, choose Create project.

3. Choose Start from scratch.

4. Under Give a name to your project, enter the name that you want to assign to your project. The name must be unique within your space.

5. Choose Create project.

Creating a project with a linked GitHub repository

You can create a new CodeCatalyst project that links to a GitHub source repository. You can then use your linked GitHub source repository in your CodeCatalyst project.

Before you create a CodeCatalyst project, you must have the Space administrator or Power user role. For more information, see Creating a space that supports AWS Builder ID users and Inviting a user directly to a space .

You must already have a GitHub account, and you need to have already created the repository you want to link to.

To create a project in CodeCatalyst that links to a source repository in your GitHub account, you'll need to complete the following three tasks:

1. Install the GitHub repositories extension.

2. Connect your GitHub account to CodeCatalyst.

3. Create a CodeCatalyst project linked to your GitHub account.

To install the GitHub repositories extension

1. Navigate to the space where you want to create a project.

2. On the space dashboard, choose Create project.

3. Choose Bring your own code.

   If the GitHub repositories extension is not already installed, an install prompt displays.

4. Choose Install. Review the permissions required by the extension, and if you want to continue, choose Install again.

After you install the GitHub repositories extension, the next step is to connect your GitHub account to your CodeCatalyst space.

Note

You can't use empty or archived GitHub repositories with CodeCatalyst projects. The GitHub repositories extension isn't compatible with GitHub Enterprise Server repositories.

To connect your GitHub account to CodeCatalyst

1. On the Create project page in CodeCatalyst, if no GitHub account is connected, a prompt displays. Choose Connect GitHub account to go to the external site for GitHub.

2. Sign in to your GitHub account using your GitHub credentials, and then choose the account where you want to install Amazon CodeCatalyst.

   Tip

   If you have previously connected a GitHub account to the space, you will not be prompted to re-authorize. You will instead see a dialog box asking you where you would like to install the extension if you are a member or collaborator in more than one GitHub space, or the configuration page for the Amazon CodeCatalyst application if you only belong to one GitHub space. Configure the application for the repository access that you want to allow, and then choose Save. If the Save button is not active, make a change to the configuration, and then try again.

3. Choose whether you want to allow CodeCatalyst to access all current and future repositories, or choose the specific GitHub repositories you want to use in CodeCatalyst. The default option is to include all GitHub repositories in the GitHub account, including future repositories that will be accessed by CodeCatalyst.

4. Review the permissions given to CodeCatalyst, and then choose Install.

After connecting your GitHub account to CodeCatalyst, you will be able to link the GitHub repositories from that account to your CodeCatalyst projects.

To create your project

1. On the Create project page, from the GitHub account dropdown menu, do one of the following:

   • Choose a GitHub account that you have already connected to CodeCatalyst.

   • (Optional) If you don't see the GitHub account you want to use, choose Connect a GitHub account to go to the page for extensions in CodeCatalyst. For more information, see Using GitHub repositories in CodeCatalyst.

2. In the GitHub repository dropdown menu, the GitHub repositories for your connected GitHub account are shown in the dropdown. Choose the GitHub repository that you want to link to your project.

3. In the Name your project text input field, enter the name that you want to assign to your project. The name must be unique within your space.

4. Choose Create project.

After your project is ready, you can add resources and tasks.

• To learn about the CI/CD workflows created with your project, see Getting started with workflows in CodeCatalyst.

• To work with build actions similar to those in your new project that deploy build artifacts to an Amazon S3 bucket, see Building using workflows in CodeCatalyst and Tutorial: Upload artifacts to Amazon S3.

• To start with an empty project and work with deploying a similar serverless application with an AWS CloudFormation stack deployment, see Tutorial: Deploy a serverless application using AWS CloudFormation.

• To add an issues planning board, see Issues in CodeCatalyst.

• To view the project overview, project status, recent team activity, and assigned work, see Viewing a project.

• To view source code or create a pull request, see Source repositories in CodeCatalyst.

• To set up notifications that send status alerts for workflow run success or failure, see Managing notifications in Amazon CodeCatalyst.

• To invite members to your project, see Managing project members.

• To set up Dev Environments, see Dev Environments in CodeCatalyst.