カスタムブループリントの開始方法

ブループリントを作成するプロセス中に、ブループリントを設定し、プロジェクトリソースのプレビューを生成できます。各カスタムブループリントは、デフォルトでスペースのブループリントカタログに公開するためのワークフローを含む CodeCatalyst プロジェクトによって管理されます。

カスタムブループリントの詳細を設定するときに、ブループリントのソースコードをサードパーティーリポジトリに保存することもできます。このリポジトリでは、カスタムブループリントを管理し、ライフサイクル管理機能を利用して、カスタムブループリントが変更されてもスペースのプロジェクトを同期させることができます。詳細については、「で拡張機能を使用してプロジェクトに機能を追加する CodeCatalyst」および「ブループリントの作成者としてライフサイクル管理を使用する」を参照してください。

標準化とベストプラクティスを備えたソースリポジトリが既にある場合は、そのソースリポジトリをカスタムブループリントに変換することを選択できます。詳細については、「ソースリポジトリのカスタムブループリントへの変換」を参照してください。

前提条件

カスタムブループリントを作成する前に、次の要件を考慮してください。

• CodeCatalyst スペースはエンタープライズ階層である必要があります。詳細については、「Amazon CodeCatalyst 管理者ガイド」の「請求の管理」を参照してください。

• カスタムブループリントを作成するには、スペース管理者またはパワーユーザーロールが必要です。詳細については、「ユーザーロールによるアクセスの許可」を参照してください。

ステップ 1: でカスタムブループリントを作成する CodeCatalyst

スペースの設定からカスタムブループリントを作成すると、リポジトリが自動的に作成されます。リポジトリには、スペースのブループリントカタログに公開する前にブループリントを開発するために必要なすべてのリソースが含まれています。

カスタムブループリントを作成するには

1. https://codecatalyst.aws/ で CodeCatalyst コンソールを開きます。

2. CodeCatalyst コンソールで、カスタムブループリントを作成するスペースに移動します。

3. スペースダッシュボードで、設定タブを選択し、ブループリント を選択します。

4. ブループリントの作成 を選択します。

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

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

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

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

     詳細ドロップダウンメニューを選択し、リポジトリプロバイダーとして を選択し GitHub、設計図によって作成されたソースコードを保存する GitHub アカウントを選択します。

     注記

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

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

     詳細ドロップダウンメニューを選択し、リポジトリプロバイダーとして Bitbucket を選択し、設計図によって作成されたソースコードを保存する Bitbucket ワークスペースを選択します。

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

     詳細ドロップダウンメニューを選択し、リポジトリプロバイダーとして を選択し GitLab、設計図によって作成されたソースコードを保存する GitLab ユーザーを選択します。

7. 設計図の詳細 で、次の操作を行います。

   1. 設計図の表示名のテキスト入力フィールドに、スペースの設計図カタログに表示される名前を入力します。

   2. 説明テキスト入力フィールドに、カスタムブループリントの説明を入力します。

   3. 作成者名のテキスト入力フィールドに、カスタム設計図の作成者名を入力します。

   4. （オプション) 詳細設定 を選択します。

      1. + 追加 を選択して、package.jsonファイルに追加されるタグを追加します。

      2. ライセンスドロップダウンメニューを選択し、カスタムブループリントのライセンスを選択します。

      3. 設計図パッケージ名のテキスト入力フィールドに、設計図パッケージを識別する名前を入力します。

      4. デフォルトでは、リリースワークフローは Blueprint Builder と呼ばれるプロジェクト内の公開ブループリントを使用して生成されます。リリースワークフローで公開許可が有効になっているため、ワークフローは変更をプッシュすると、最新のブループリントバージョンをスペースに公開します。ワークフロー生成をオフにするには、「ワークフローのリリース」チェックボックスをオフにします。

8. （オプション) ブループリントプロジェクトには、スペースのブループリントカタログへのブループリントの公開をサポートする定義済みコードが付属しています。行ったプロジェクトパラメータの選択に基づいて更新を含む定義ファイルを表示するには、「設計図プレビューの生成」から「コードを表示」または「ワークフローを表示」を選択します。

9. ブループリントの作成 を選択します。

カスタムブループリントのワークフロー生成をオフにしなかった場合、ブループリントの作成時にワークフローが自動的に実行され始めます。ワークフローの実行が完了すると、デフォルトでカスタムブループリントをスペースのブループリントカタログに追加できます。最新のブループリントバージョンをスペースに自動的に公開したくない場合は、公開許可をオフにできます。詳細については、「カスタムブループリントの発行許可の設定」および「ワークフローの実行」を参照してください。

という名前の公開ワークフローblueprint-releaseは設計図を使用して作成されるため、設計図はプロジェクトに適用された設計図として確認できます。詳細については、「プロジェクトに設計図を追加してリソースを統合する」および「プロジェクトからブループリントの関連付けを解除して更新を停止する」を参照してください。

ステップ 2: コンポーネントを使用してカスタムブループリントを作成する

ブループリントウィザードは、カスタムブループリントの作成時に生成され、カスタムブループリントの開発時にコンポーネントで変更できます。src/blueprints.js および src/defaults.json ファイルを更新してウィザードを変更できます。

重要

外部ソースからのブループリントパッケージを使用する場合は、それらのパッケージに伴うリスクを考慮してください。スペースに追加するカスタムブループリントとそれらが生成するコードは、お客様の責任となります。

設計図コードを設定する前に、サポートされている統合開発環境 (IDE) を使用して CodeCatalyst プロジェクトに開発環境を作成します。開発環境は、必要なツールとパッケージを操作するために必要です。

開発環境を作成するには

1. ナビゲーションペインで、次のいずれかを実行します。

   1. 「概要」を選択し、「開発環境」セクションに移動します。

   2. コード を選択し、開発環境 を選択します。

   3. コード を選択し、ソースリポジトリ を選択し、ブループリントの作成時に作成したリポジトリを選択します。

2. [開発環境を作成] を選択します。

3. ドロップダウンメニューからサポートされている IDE を選択します。詳細については、「開発環境でサポートされている統合開発環境」を参照してください。

4. 「既存のブランチで作業」を選択し、「既存のブランチ」ドロップダウンメニューから、作成した機能ブランチを選択します。

5. （オプション) エイリアス - オプションのテキスト入力フィールドに、エイリアスを入力して開発環境を識別します。

6. [作成] を選択します。開発環境の作成中に、開発環境のステータス列に開始 が表示され、開発環境の作成時にステータス列に実行中が表示されます。

詳細については、「で開発環境を使用してコードを記述および変更する CodeCatalyst」を参照してください。

カスタムブループリントを開発するには

1. 作業ターミナルで、次のyarnコマンドを使用して依存関係をインストールします。

   yarn

   必要なツールとパッケージは、Yarn を含む CodeCatalyst 開発環境を通じて利用できます。開発環境なしでカスタムブループリントを使用している場合は、まずシステムに Yarn をインストールします。詳細については、「Yarn のインストールドキュメント」を参照してください。

2. カスタムブループリントを開発して、設定に合わせて設定します。コンポーネントを追加することで、ブループリントのウィザードを変更できます。詳細については、プロジェクト要件を満たすためのカスタムブループリントの開発、フロントエンドウィザードを使用した設計図機能の変更、およびスペースへのカスタムブループリントの発行を参照してください。

ステップ 3: カスタムブループリントをプレビューする

カスタムブループリントを設定して開発したら、ブループリントのプレビューバージョンをプレビューしてスペースに公開できます。プレビューバージョンを使用すると、ブループリントが新しいプロジェクトの作成に使用されたり、既存のプロジェクトに適用されたりする前に、ブループリントが目的のものであることを確認することができます。

カスタムブループリントをプレビューするには

1. 作業ターミナルで、次のyarnコマンドを使用します。

   yarn blueprint:preview

2. 提供されているSee this blueprint at:リンクに移動して、カスタムブループリントをプレビューします。

3. 設定に基づいて、テキストを含む UI が想定どおりに表示されることを確認します。カスタムブループリントを変更する場合は、blueprint.tsファイルを編集し、ブループリントを再合成してから、プレビューバージョンを再度公開できます。詳細については、「再合成」を参照してください。

（オプション) ステップ 4: カスタムブループリントプレビューバージョンを公開する

カスタムブループリントのプレビューバージョンをスペースのブループリントカタログに追加する場合は、スペースに公開できます。これにより、非プレビューバージョンをカタログに追加する前に、ブループリントをユーザーとして表示できます。プレビューバージョンでは、実際のバージョンを使用せずに公開できます。例えば、ある0.0.1バージョンで作業する場合、プレビューバージョンを公開して追加できるため、2 番目のバージョンに対する新しい更新を公開して として追加できます0.0.2。

カスタムブループリントのプレビューバージョンを公開するには

提供されているEnable version [version number] at:リンクに移動して、カスタムブループリントを有効にします。このリンクは、 で yarn コマンドを実行するときに提供されますステップ 3: カスタムブループリントをプレビューする。

カスタムブループリントを作成、開発、プレビュー、公開した後、スペースのブループリントカタログに最終的なブループリントバージョンを公開して追加できます。詳細については、「スペースへのカスタムブループリントの発行」および「スペースブループリントカタログへのカスタムブループリントの追加」を参照してください。