Creating a project - Amazon CodeCatalyst (original) (raw)

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 orPower user role.

Topics

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 orPower 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 third-party repository

You can keep your project's source code in a preferred third-party provider and still use all the CodeCatalyst features such as blueprints, lifecycle management, workflows, and more. To do this, you can create a new CodeCatalyst project that links to a GitHub repository, Bitbucket repository, or a GitLab project repository. You can then use your linked source repository in your CodeCatalyst project.

Before you create a CodeCatalyst project, you must have theSpace administrator or Power user role. For more information, see Creating a space and Inviting a user directly to a space .

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, Bitbucket repositories, or GitLab repositories extension. You're prompted in an external site to connect and provide CodeCatalyst with access to your repository, which is done as part of the next step.
Important

To install the GitHub repositories, Bitbucket repositories, or GitLab repositories extension to your CodeCatalyst space, you must be signed in with an account that has the Space administrator role in the space. 2. Connect your GitHub account or Bitbucket workspace, or GitLab user to CodeCatalyst.

Important

To connect your GitHub account, Bitbucket workspace, GitLab user to your CodeCatalyst space, you must be both the third-party source's administrator and the CodeCatalyst Space administrator.

Important

After you install a repository extension, any repositories you link to CodeCatalyst will have their code indexed and stored in CodeCatalyst. This will make the code searchable in CodeCatalyst. To better understand the data protection for your code when using linked repositories in CodeCatalyst, see Data protection in the Amazon CodeCatalyst User Guide. 3. Create a CodeCatalyst project linked to your GitHub repository, Bitbucket repository, or GitLab project repository.

Note

For more information, see Add functionality to projects with extensions in CodeCatalyst.

To install the third-party 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.
  4. Under Link existing repository, choose GitHub repositories, Bitbucket repositories, GitLab repositories depending on the third-party repository provider you want to use. You're prompted to connect your GitHub account, Bitbucket workspace, or GitLab account if you didn't do so previously. If the third-party extension of your choice isn't already installed, an install prompt displays.
  5. If prompted, choose Install. Review the permissions required by the extension, and if you want to continue, choose Install again.

After you install the third-party extension, the next step is to connect your GitHub account, Bitbucket workspace, or GitLab user to your CodeCatalyst space.

To connect your GitHub account, Bitbucket workspace, or GitLab user to CodeCatalyst

Do one of the following depending on the third-party extension you chose to configure:

After connecting your third-party source to CodeCatalyst, you can link the third-party repositories to your CodeCatalyst projects.

To create your project
  1. On the Create project page, choose the GitHub account you connected.
  2. Depending on the third-party repository provider you connected, choose the GitHub repositories, Bitbucket repositories, or GitLab repositories repository dropdown menu to view the third-party repositories, and then choose the 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 installing the GitHub repositories, Bitbucket repositories, or GitLab repositories extension, connecting your resource provider, and linking your third-party repository to your CodeCatalyst project, you can use it in CodeCatalyst workflows and Dev Environments. You can also create third-party repositories in the connected GitHub account, Bitbucket workspace, or GitLab user with code generated from a blueprint. You can also use the linked repositories with Amazon Q Developer, blueprints, and more. For more information, see Automatically starting a workflow run after third-party repository events and Creating a Dev Environment.

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 Creating a comprehensive project with CodeCatalyst blueprints.

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. From the CodeCatalyst blueprints or Space blueprints tab, choose a blueprint, and then choose Next.
  5. Under Name 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. (Optional) By default, the source code created by the blueprint is stored in a CodeCatalyst repository. Alternatively, you can choose to store the blueprint's source code in a third-party repository. For more information, see Add functionality to projects with extensions in CodeCatalyst.
    Do one of the following depending on the third-party repository provider you want to use:
    • GitHub repositories: Connect a GitHub account.
      Choose the Advanced dropdown menu, choose GitHub as the repository provider, and then choose the GitHub account where you want to store the source code created by the blueprint.
    • Bitbucket repositories: Connect a Bitbucket workspace.
      Choose the Advanced dropdown menu, choose Bitbucket as the repository provider, and then choose the Bitbucket workspace where you want to store the source code created by the blueprint.
    • GitLab repositories: Connect a GitLab user.
      Choose the Advanced dropdown menu, choose GitLab as the repository provider, and then choose the GitLab user where you want to store the source code created by the blueprint.
  7. Under Project resources, configure the blueprint parameters. Depending on the blueprint, you may have the option to name the source repository name.
  8. (Optional) To view definition files with updates based on the project parameter selections you made, choose View code or View workflow fromGenerate project preview.
  9. (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.
  10. Choose Create project.

Best practices when using Amazon Q to create projects or add functionality with blueprints

When you create a project or want to add new components to an existing project, you might be unsure about which blueprint to use or how to integrate capabilities. CodeCatalyst includes integration with a generative AI assistant called Amazon Q that can analyze your project requirements and suggest a blueprint that best fits your needs.

You can use Amazon Q to help you create a project with a blueprint that creates components based on your requirements, or you can use Amazon Q to help you add a blueprint to an existing project. For example, to add resources for a web application or modern application to a project, specify your requirements and then the resources will be added with a recommended blueprint. Issues for remaining components can be created for you.

Amazon Q also creates issues for requirements that can't be addressed by a suggested blueprint. Additionally, you can assign those issues to Amazon Q. If you assign the issue to Amazon Q, it will attempt to create a draft solution for you to evaluate. This can help you and your team to focus and optimize work on issues that require your attention, while Amazon Q works on a solution for problems you don't have resources to address immediately.

Note

Powered by Amazon Bedrock: AWS implements automated abuse detection. Because the Write description for me, Create content summary, Recommend tasks, Use Amazon Q to create or add features to a project, and Assign issues to Amazon Q feature with Amazon Q Developer Agent for software development features are built on Amazon Bedrock, users can take full advantage of the controls implemented in Amazon Bedrock to enforce safety, security, and the responsible use of artificial intelligence (AI).

The following are some best practices to help you create projects and add blueprints with Amazon Q.

Important

Generative AI features are only available in the US West (Oregon) Region.

Best practices for using blueprints with projects

The following are some best practices to help you create a project with blueprints or add blueprints.

Adding resources and tasks to created projects

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