「プロジェクトの作成」 - Amazon CodeCatalyst
空のプロジェクトの作成リンクされたサードパーティーリポジトリを使用したプロジェクトの作成ブループリントを使用したプロジェクトの作成Amazon Q を使用したプロジェクトの作成やブループリントの機能追加のベストプラクティスプロジェクトでブループリントを使用するためのベストプラクティス作成したプロジェクトへのリソースとタスクの追加

「プロジェクトの作成」

CodeCatalyst プロジェクトを使用すると、継続的インテグレーションと継続的デリバリー (CI/CD) の共有ワークフローとリポジトリを使用して、開発タスクの実行、リソースの管理、問題の追跡、ユーザーの追加を実行できます。

プロジェクトを作成する前に、スペース管理者またはパワーユーザーロールが必要です。

Amazon CodeCatalyst での空のプロジェクトの作成

リソースなしで空のプロジェクトを作成し、後で必要なリソースを手動で追加できます。

プロジェクトを作成する前に、スペース管理者またはパワーユーザーロールが必要です。

空のプロジェクトを作成するには

  1. プロジェクトを作成するスペースに移動します。

  2. スペースダッシュボードで、[プロジェクトの作成] を選択します。

  3. [最初から開始] を選択します。

  4. [プロジェクトに名前を付ける] に、プロジェクトに割り当てる名前を入力します。名前はスペース内で一意でなければなりません。

  5. [プロジェクトを作成] を選択します。

リンクされたサードパーティーリポジトリを使用したプロジェクトの作成

プロジェクトのソースコードを希望するサードパーティープロバイダーに保持しながら、CodeCatalyst のすべての機能 (ブループリント、ライフサイクル管理、ワークフローなど) を使用できます。これを行うには、GitHub リポジトリ、Bitbucket リポジトリ、または GitLab プロジェクトリポジトリにリンクする、新しい CodeCatalyst プロジェクトを作成できます。その後、CodeCatalyst プロジェクトでリンクされたソースリポジトリを使用できます。

CodeCatalyst プロジェクトを作成する前に、スペース管理者またはパワーユーザーロールが必要です。詳細については、「スペースを作成する」と「スペースへのユーザーの直接招待 」を参照してください。

GitHub アカウントのソースリポジトリにリンクするプロジェクトを CodeCatalyst で作成するには、次の 3 つのタスクを完了する必要があります。

  1. GitHub リポジトリ、Bitbucket リポジトリ、または GitLab リポジトリ拡張機能をインストールします。外部サイトでは、リポジトリに接続して CodeCatalyst にアクセス権を付与するように求められます。これは次のステップの一環として行われます。

    重要

    GitHub リポジトリ、Bitbucket リポジトリ、または GitLab リポジトリ拡張機能を CodeCatalyst スペースにインストールするには、スペースにスペース管理者ロールを持つアカウントでサインインする必要があります。

  2. GitHub アカウントまたは Bitbucket ワークスペース、または GitLab ユーザーを CodeCatalyst に接続します。

    重要

    GitHub アカウント、Bitbucket ワークスペース、GitLab ユーザーを CodeCatalyst スペースに接続するには、サードパーティーソースの管理者と CodeCatalyst スペース管理者の両方である必要があります。

    重要

    リポジトリ拡張機能をインストールすると、CodeCatalyst にリンクするすべてのリポジトリのコードがインデックス化され、CodeCatalyst に保存されます。これにより、コードが CodeCatalyst で検索できるようになります。CodeCatalyst でリンクされたリポジトリを使用する際のコードのデータ保護の詳細については、「Amazon CodeCatalyst ユーザーガイド」の「データ保護」を参照してください。

  3. GitHub リポジトリ、Bitbucket リポジトリ、または GitLab プロジェクトリポジトリにリンクされた CodeCatalyst プロジェクトを作成します。

    重要

    寄稿者は、GitHub リポジトリ、Bitbucket リポジトリ、または GitLab プロジェクトリポジトリをリンクすることはできますが、サードパーティーリポジトリのリンクを解除できるのはスペース管理者またはプロジェクト管理者のみです。詳細については、「CodeCatalyst での GitHub リポジトリ、Bitbucket リポジトリ、GitLab プロジェクトリポジトリ、および Jira プロジェクトのリンク解除」を参照してください。

    重要

    CodeCatalyst は、リンクされたリポジトリのデフォルトブランチの変更の検出をサポートしていません。リンクされたリポジトリのデフォルトブランチを変更するには、まず CodeCatalyst からリンクを解除し、デフォルトブランチを変更してから再度リンクする必要があります。詳細については、「CodeCatalyst での GitHub リポジトリ、Bitbucket リポジトリ、GitLab プロジェクトリポジトリ、および Jira プロジェクトのリンク」を参照してください。

    ベストプラクティスとして、リポジトリをリンクする前に、必ず最新バージョンの拡張機能があることを確認してください。

    注記

    • GitHub リポジトリ、Bitbucket リポジトリ、または GitLab プロジェクトリポジトリは、スペース内の 1 つの CodeCatalyst プロジェクトにのみリンクできます。

    • CodeCatalyst プロジェクトでは、空の GitHub リポジトリまたはアーカイブされた GitHub リポジトリ、Bitbucket リポジトリ、または GitLab プロジェクトリポジトリを使用することはできません。

    • CodeCatalyst プロジェクトのリポジトリと同じ名前の GitHub リポジトリ、Bitbucket リポジトリ、または GitLab プロジェクトリポジトリをリンクすることはできません。

    • GitHub リポジトリ拡張機能は GitHub Enterprise Server リポジトリと互換性がありません。

    • Bitbucket リポジトリ拡張機能は Bitbucket Data Center リポジトリと互換性がありません。

    • GitLab リポジトリ拡張機能は GitLab self-managed project リポジトリと互換性がありません。

    • リンクされたリポジトリでは、説明を記述する機能やコメントを要約する機能は使用できません。これらの機能は、CodeCatalyst のプルリクエストでのみ使用できます。

詳細については、「CodeCatalyst で拡張機能を持つプロジェクトに機能を追加する」を参照してください。

サードパーティー拡張機能をインストールするには

  1. プロジェクトを作成するスペースに移動します。

  2. スペースダッシュボードで、[プロジェクトの作成] を選択します。

  3. [独自のコードを使用する] を選択します。

  4. [既存のリポジトリのリンク] で、使用するサードパーティーリポジトリプロバイダーに応じて、[GitHub リポジトリ]、[Bitbucket リポジトリ]、[GitLab リポジトリ] を選択します。以前に接続していない場合は、GitHub アカウント、Bitbucket ワークスペース、または GitLab アカウントを接続するように求められます。選択したサードパーティー拡張機能がまだインストールされていない場合は、インストールプロンプトが表示されます。

  5. プロンプトが表示されたら、[インストール] を選択します。拡張機能に必要なアクセス許可を確認し、続行する場合は、[インストール] を再度選択します。

サードパーティーの拡張機能をインストールしたら、次のステップでは、GitHub アカウント、Bitbucket ワークスペース、または GitLab ユーザーを CodeCatalyst スペースに接続します。

GitHub アカウント、Bitbucket ワークスペース、または GitLab ユーザーを CodeCatalyst に接続するには

設定するサードパーティー拡張機能に応じて、次のいずれかを実行します。

  • GitHub リポジトリ: GitHub アカウントに接続します。

    1. [GitHub アカウントの接続] を選択して、GitHub の外部サイトに移動します。

    2. GitHub 認証情報を使用して GitHub アカウントにサインインし、Amazon CodeCatalyst をインストールするアカウントを選択します。

      ヒント

      以前に GitHub アカウントをスペースに接続したことがある場合、再承認を求めるプロンプトは表示されません。複数の GitHub スペースのメンバーまたは共同作業者である場合は、拡張機能をインストールする場所を尋ねるダイアログボックスが表示されます。1 つの GitHub スペースのみに属している場合は、Amazon CodeCatalyst アプリケーションの設定ページが表示されます。リポジトリへのアクセスを許可するアプリケーションを設定し、[保存] を選択します。[保存] ボタンがアクティブでない場合は、設定を変更してから再試行してください。

    3. CodeCatalyst で現在と今後のすべてのリポジトリにアクセスできるようにすることを選択するか、または CodeCatalyst で使用する特定の GitHub リポジトリを選択します。デフォルトのオプションでは、CodeCatalyst によってアクセスされる今後のリポジトリなど、GitHub アカウントにすべての GitHub リポジトリが含まれます。

    4. CodeCatalyst に付与されているアクセス許可を確認してから、[インストール] を選択します。

    GitHub アカウントを CodeCatalyst に接続すると、[GitHub リポジトリ] 拡張機能の詳細ページに移動します。このページでは、接続された GitHub アカウントとリンクされた GitHub リポジトリを表示および管理できます。

  • Bitbucket リポジトリ: Bitbucket ワークスペースに接続します。

    1. Bitbucket の外部サイトに移動するには、Bitbucket ワークスペースの接続] を選択します。

    2. Bitbucket 認証情報を使用して Bitbucket ワークスペースにサインインし、CodeCatalyst に付与されたアクセス許可を確認します。

    3. [ワークスペースの認証] ドロップダウンメニューから、CodeCatalyst へのアクセスを許可する Bitbucket ワークスペースを選択し、[アクセスを許可] を選択します。

      ヒント

      以前に Bitbucket ワークスペースをスペースに接続したことがある場合、再承認を求めるプロンプトは表示されません。複数の Bitbucket ワークスペースのメンバーまたは共同作業者である場合は、拡張機能をインストールする場所を尋ねるダイアログが表示されます。1 つの Bitbucket ワークスペースのみに属している場合は、Amazon CodeCatalyst アプリケーションの設定ページが表示されます。ワークスペースのアクセスを許可するアプリケーションを設定し、[アクセスを許可] を選択します。[アクセスを許可] ボタンがアクティブでない場合は、設定を変更してから、再試行してください。

    Bitbucket ワークスペースを CodeCatalyst に接続すると、[Bitbucket リポジトリ] 拡張機能の詳細ページに移動します。このページでは、接続された Bitbucket ワークスペースとリンクされた Bitbucket リポジトリを表示および管理できます。

  • GitLab リポジトリ: GitLab ユーザーに接続します。

    1. [GitLab ユーザーを接続] を選択して、GitLab の外部サイトに移動します。

    2. GitLab 認証情報を使用して GitLab ユーザーにログインし、CodeCatalyst に付与されたアクセス許可を確認します。

      ヒント

      以前に GitLab ユーザーをスペースに接続したことがある場合、再承認を求めるプロンプトは表示されません。代わりに、CodeCatalyst コンソールに戻ります。

    3. [GitLab の AWS コネクターを認証] を選択します。

    GitLab ユーザーを CodeCatalyst に接続すると、GitLab リポジトリ拡張機能の詳細ページに移動します。このページでは、接続された GitLab ユーザーと、リンクされた GitLab プロジェクトリポジトリを表示および管理できます。

サードパーティーソースを CodeCatalyst に接続したら、サードパーティーリポジトリを CodeCatalyst プロジェクトにリンクできます。

プロジェクトを作成するには

  1. [プロジェクトの作成] ページで、接続した GitHub アカウントを選択します。

  2. 接続したサードパーティーリポジトリプロバイダーに応じて、[GitHub リポジトリ]、[Bitbucket リポジトリ]、または [GitLab リポジトリ]のリポジトリドロップダウンメニューを選択し、サードパーティーリポジトリを表示して、プロジェクトにリンクするリポジトリを選択します。

  3. [プロジェクトに名前を付ける] テキスト入力フィールドに、プロジェクトに割り当てる名前を入力します。名前はスペース内で一意でなければなりません。

  4. [プロジェクトを作成] を選択します。

GitHub リポジトリ、Bitbucket リポジトリ、または GitLab リポジトリ拡張機能をインストールし、リソースプロバイダーを接続して、サードパーティーリポジトリを CodeCatalyst プロジェクトにリンクしたら、それを CodeCatalyst ワークフローと開発環境で使用できます。ブループリントから生成されたコードを使用して、接続された GitHub アカウント、Bitbucket ワークスペース、または GitLab ユーザーでサードパーティーリポジトリを作成することもできます。リンクされたリポジトリは、Amazon Q Developer、ブループリントなどでも使用できます。詳細については、「サードパーティーリポジトリイベント後にワークフローを自動的に開始」と「開発環境の作成」を参照してください。

ブループリントを使用したプロジェクトの作成

すべてのプロジェクトリソースとサンプルコードは、プロジェクトブループリントを使ってプロビジョニングできます。ブループリントについては、「CodeCatalyst ブループリントを使用した包括的なプロジェクトの作成」を参照してください。

ブループリントを使用してプロジェクトを作成する

  1. CodeCatalyst コンソールで、プロジェクトを作成するスペースに移動します。

  2. スペースダッシュボードで、[プロジェクトの作成] を選択します。

  3. [ブループリントから始める] を選択します。

    ヒント

    ブループリントを追加するには、Amazon Q にプロジェクト要件を入力すると、Amazon Q がブループリントを提案します。詳細については、「プロジェクトの作成時または機能の追加時に Amazon Q を使用してブループリントを選択する」と「Amazon Q を使用したプロジェクトの作成やブループリントの機能追加のベストプラクティス」を参照してください。この機能は、米国西部 (オレゴン) リージョンでのみ利用可能です。

    この機能を使用するには、スペースに対して生成 AI 機能を有効にする必要があります。詳細については、「Managing generative AI features」を参照してください。

  4. [CodeCatalyst ブループリント] タブまたは [スペースブループリント] タブで、ブループリントを選択し、[次へ] を選択します。

  5. [プロジェクトに名前を付ける] で、プロジェクトに割り当てる名前と、関連するリソース名を入力します。名前はスペース内で一意でなければなりません。

  6. (オプション) デフォルトでは、ブループリントが作成したソースコードは CodeCatalyst リポジトリに保存されます。または、ブループリントのソースコードをサードパーティーリポジトリに保存することもできます。詳細については、「CodeCatalyst で拡張機能を持つプロジェクトに機能を追加する」を参照してください。

    重要

    CodeCatalyst は、リンクされたリポジトリのデフォルトブランチの変更の検出をサポートしていません。リンクされたリポジトリのデフォルトブランチを変更するには、まず CodeCatalyst からリンクを解除し、デフォルトブランチを変更してから再度リンクする必要があります。詳細については、「CodeCatalyst での GitHub リポジトリ、Bitbucket リポジトリ、GitLab プロジェクトリポジトリ、および Jira プロジェクトのリンク」を参照してください。

    ベストプラクティスとして、リポジトリをリンクする前に、必ず最新バージョンの拡張機能があることを確認してください。

    使用するサードパーティーリポジトリプロバイダーに応じて、次のいずれかを実行します。

    • GitHub リポジトリ: GitHub アカウントを接続します。

      [高度] ドロップダウンメニューから、リポジトリプロバイダーとして GitHub を選択し、ブループリントによって作成されたソースコードを保存する GitHub アカウントを選択します。

      注記

      GitHub アカウントに接続している場合は、CodeCatalyst ID と GitHub ID 間の ID マッピングを確立するための個人用接続を作成する必要があります。詳細については、「個人用接続」と「個人接続を使用して GitHub リソースにアクセスする」を参照してください。

    • Bitbucket リポジトリ: Bitbucket ワークスペースを接続します。

      [高度] ドロップダウンメニューから、リポジトリプロバイダーとして Bitbucket を選択し、ブループリントによって作成されたソースコードを保存する Bitbucket ワークスペースを選択します。

    • GitLab リポジトリ: GitLab ユーザーを接続します。

      [高度] ドロップダウンメニューから、リポジトリプロバイダーとして GitLab を選択し、ブループリントによって作成されたソースコードを保存する GitLab アカウントを選択します。

  7. [プロジェクトリソース] で、ブループリントパラメータを設定します。ブループリントによっては、ソースリポジトリ名に名前を付けるオプションがある場合があります。

  8. (オプション) 選択したプロジェクトパラメータに基づいて更新を伴う定義ファイルを表示するには、[プロジェクトプレビューを生成] から [コードを表示] または [ワークフローを表示] を選択します。

  9. (オプション) ブループリントのカードから [詳細を表示] を選択すると、ブループリントのアーキテクチャの概要、必要な接続とアクセス許可、ブループリントで作成されるリソースの種類など、そのブループリントに関する具体的な情報が表示されます。

  10. [プロジェクトを作成] を選択します。

Amazon Q を使用したプロジェクトの作成やブループリントの機能追加のベストプラクティス

プロジェクトを作成する場合、または既存のプロジェクトに新しいコンポーネントを追加する場合、使用するブループリントや機能の統合方法がわからない場合があります。CodeCatalyst には Amazon Q と呼ばれる生成 AI アシスタントが統合されています。Amazon Q を使うと、プロジェクト要件を分析して、ニーズに最適なブループリントを提案できます。

Amazon Q を使用すると、要件に基づいてコンポーネントを作成するブループリントを備えたプロジェクトを作成できます。Amazon Q を使用して既存のプロジェクトにブループリントを追加することもできます。例えば、プロジェクトにウェブアプリケーションやモダンアプリケーションのリソースを追加するには、要件を指定すると、推奨されるブループリントにリソースが追加されます。残りのコンポーネントの問題も作成されます。

Amazon Q は、提案されたブループリントでは対処できない要件の問題を作成します。さらに、これらの問題を Amazon Q に割り当てることができます。問題を Amazon Q に割り当てると、評価用のソリューションの試案が作成されます。これにより、すぐにリソースを割くことができない問題の解決には Amazon Q を活用しながら、自分やチームは注意が必要な問題に集中して取り組むことで最適化を図ることができます。

注記

Amazon Bedrock を搭載: AWS は不正使用の自動検出を実装します。Amazon Q Developer Agent for Software Development の「説明を記述する」、「内容の要約を作成する」、「タスクを提案する」、「Amazon Q を使用してプロジェクトに機能を作成または追加する」、「Amazon Q に問題を割り当てる」機能は Amazon Bedrock を基盤に構築されているため、ユーザーは Amazon Bedrock に実装されている統制を最大限に活用して、AI の安全性、セキュリティ、責任ある使用を徹底することができます。

以下は、Amazon Q を使用して、プロジェクトを作成し、ブループリントを追加するためのベストプラクティスです。

重要

生成 AI 機能は、米国西部 (オレゴン) リージョンでのみ使用できます。

  • Amazon Q が提供するデフォルトのプロンプトを使用します。Amazon Q は、提供されたプロンプトに基づくブループリントを選択すると、最大限に効果を発揮します。

  • Amazon Q が提案する設定オプションを使用して、ブループリントをプレビューします。ブループリントを選択して、ブループリントで作成されたサンプルコードとリソースをプレビューします。

  • Amazon Q が有効になっているスペースを使用します。Amazon Q を使用してプロジェクトを作成したり、ブループリントを備えたプロジェクトに機能を追加したりするには、生成 AI 機能が有効になっているスペースを使用します。詳細については、「スペースの生成 AI 機能の有効化または無効化」を参照してください。

  • Amazon Q が推奨するブループリントの詳細情報を取得します。推奨されるブループリントで作成されたプロジェクトリソース、サンプルコード、コンポーネントの種類などを確認します。CodeCatalyst で使用可能なブループリントの詳細については、「CodeCatalyst ブループリントを使用した包括的なプロジェクトの作成」を参照してください。

  • Amazon Q で問題に対処できるようにします。Amazon Q で問題を作成し、割り当てて、追跡できるようにします。詳細については、「チュートリアル: CodeCatalyst の生成 AI 機能を使用して開発作業を高速化する」を参照してください。

  • Amazon Q で対処されない問題の割り当てを解除します。この例を完了したら、Amazon Q で対処されない問題の割り当てを解除します。Amazon Q が問題への対処を完了した場合、またはソリューションが見つからなかった場合は、Amazon Q の割り当てを解除して、生成 AI 機能のクォータ上限に達しないようにします。詳細については、「Managing generative AI features」および「Pricing」を参照してください。

  • Amazon Q の使用状況を表示します。ユーザーレベルで生成 AI 機能の使用状況を表示できます。[マイ設定] に移動して、生成 AI クォータを管理し、Builder ID またはシングルサインオン (SSO) ID ごとの使用状況を表示します。詳細については、「スペースでの生成 AI 機能の使用状況の表示」を参照してください。

重要

CodeCatalyst の生成 AI 機能は、クォータの対象となります。詳細については、「Amazon Q Developer の料金」、「スペースの生成 AI 機能の有効化または無効化」、および「請求」を参照してください。

プロジェクトでブループリントを使用するためのベストプラクティス

以下は、ブループリントを使用してプロジェクトを作成したり、ブループリントを追加したりするためのベストプラクティスです。

  • CodeCatalyst が提供するブループリントを使用して、プロジェクトを作成または追加します。ブループリントを使用して、デベロッパー向けのソースコードとリソースを含む完全なプロジェクトを作成できます。例えば、ウェブアプリケーションのブループリントは、アプリケーションとインフラストラクチャのリソースを作成して、ウェブアプリケーションをデプロイします。ブループリントを使用してプロジェクトを作成したり、既存のプロジェクトにカスタムブループリントを追加したりできます。詳細については、「ブループリントを使用したプロジェクトの作成」を参照してください。CodeCatalyst でブループリントを表示して、ブループリントで作成されるサンプルコードとリソースをプレビューします。

  • 組織によって設計されたカスタムブループリントを使用します。カスタムブループリントを使用すると、完全なプロジェクトをスペースに作成できます。組織が設計したカスタムブループリントは、標準化とベストプラクティスを提供します。これによって新しいプロジェクトをセットアップする労力を低減できます。カスタムブループリントの作成者は、スペース全体でそのブループリントを使用しているプロジェクトの詳細を表示できます。ライフサイクル管理を使用すると、すべてのプロジェクトのソフトウェア開発ライフサイクルを一元管理できます。ブループリントユーザーは、ライフサイクル管理を使用すると、更新されたオプションまたはブループリントのバージョンからコードベースを再生成できます。詳細については、「ブループリント作成者としてライフサイクル管理を使用する」を参照してください。

  • デベロッパーロールまたは適切な IAM ロールをプロジェクト のアカウントに追加します。プロジェクトの作成時または作成ステップの完了後、ブループリントのアクセス許可を設定するには、スペースに接続されている AWS アカウント の IAM ロールを選択するか、または作成します。

作成したプロジェクトへのリソースとタスクの追加

プロジェクトを作成したら、リソースとタスクを追加できます。