翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

ワークフローの概念

CodeCatalyst でワークフローを使用してコードを構築、テスト、またはデプロイするときに知っておくべき概念と用語をいくつか紹介します。

ワークフロー

ワークフローは、CI/CD (Continuous Integration/Continuous Delivery) システムの一部としてコードを構築、テスト、デプロイする方法を説明する自動手順です。ワークフローは、ワークフローの実行中に実行する一連のステップまたはアクションを定義します。ワークフローは、ワークフローを開始するイベント、またはトリガーも定義します。ワークフローを設定するには、CodeCatalyst コンソールのビジュアルエディタまたは YAML エディタを使用してワークフロー定義ファイルを作成します。

ワークフロー定義ファイル

ワークフロー定義ファイルは、ワークフローを記述する YAML ファイルです。デフォルトでは、ファイルはソースリポジトリのルートにある ~/.codecatalyst/workflows/ フォルダに保存されます。ファイルには .yml または .yaml 拡張子を使用でき、拡張子は小文字にする必要があります。

ワークフロー定義ファイルの詳細については、「ワークフロー YAML 定義」を参照してください。

アクション

アクションはワークフローの主要な構成要素であり、ワークフローの実行中に実行する作業またはタスクの論理単位を定義します。通常、ワークフローには、設定方法に応じて順次または並列に実行される複数のアクションが含まれます。

アクションの詳細については、「ワークフローアクションの構成」を参照してください。

アクショングループ

アクショングループには 1 つ以上のアクションが含まれています。アクションをアクショングループにグループ化すると、ワークフローを整理するのに役立ち、異なるグループ間の依存関係を構成できるようになります。

アクショングループの詳細については、「アクショングループへのアクションのグループ化」を参照してください。

アーティファクト

アーティファクトはワークフローアクションの出力であり、通常はフォルダまたはファイルのアーカイブで構成されます。アーティファクトは、アクション間でのファイルや情報の共有を可能にするため重要です。

アーティファクトの詳細については、「アクション間でのアーティファクトとファイルの共有」を参照してください。

コンピューティング

コンピューティングとは、CodeCatalyst がワークフローアクションを実行するために管理および保守するコンピューティングエンジン (CPU、メモリ、およびオペレーティングシステム) を指します。

コンピューティングの詳細については、「コンピューティングイメージとランタイムイメージの構成」を参照してください。

環境

CodeCatalyst 環境は、開発環境と混同しないように、CodeCatalyst ワークフローが接続するターゲット AWS アカウント とオプションの Amazon VPC を定義します。環境は、ターゲットアカウント内の AWS サービスとリソースにアクセスするためにワークフローが必要とする IAM ロールも定義します。

複数の環境をセットアップし、開発、テスト、ステージング、本番稼働などの名前を付けることができます。これらの環境にデプロイすると、デプロイに関する情報が環境内で CodeCatalyst の [デプロイアクティビティ] タブと [デプロイターゲット] タブに表示されます。

環境の詳細については、「AWS アカウント と VPCs へのデプロイ」を参照してください。

ゲート

ゲートは、特定の条件が満たされない限り、ワークフロー実行が続行されないようにするために使用できるワークフローコンポーネントです。ゲートの例として、ワークフロー実行の続行を許可する前に CodeCatalyst コンソールでユーザーが承認を送信する必要がある承認ゲートがあります。

ワークフロー内の連続するアクションの間にゲートを追加することも、最初のアクション (ソースのダウンロード直後に実行) の前にゲートを追加することもできます。必要に応じて、最後のアクションの後にゲートを追加することもできます。

ゲートの詳細については、「ゲートを使用したワークフロー実行の続行防止」を参照してください。

レポート

レポートには、ワークフロー実行中に発生するテストの詳細が含まれています。テストレポート、コードカバレッジレポート、ソフトウェア構成分析レポート、静的分析レポートなどのレポートを作成できます。レポートを使用することで、ワークフロー中に問題をトラブルシューティングできます。複数のワークフローからのレポートが多数ある場合は、レポートを使用して傾向と失敗率を表示し、アプリケーションとデプロイの構成を最適化できます。

レポートの詳細については、「品質レポートのタイプ」を参照してください。

実行

実行はワークフローの 1 回の反復です。実行中、CodeCatalyst ではワークフロー構成ファイルで定義されているアクションを実行し、関連するログ、アーティファクト、変数を出力します。

実行の詳細については、「ワークフローの実行」を参照してください。

[Sources] (出典)

ソースは入力ソースとも呼ばれ、ワークフローアクションがオペレーションの実行に必要なファイルを取得するために接続するソースリポジトリです。例えば、ワークフローアクションがソースリポジトリに接続して、アプリケーションを構築するためにアプリケーションソースファイルを取得する場合があります。

sources の詳細については、「ワークフローへのソースリポジトリの接続」を参照してください。

[変数]

変数は、Amazon CodeCatalyst ワークフローで参照できる情報を含むキーと値のペアです。変数の値部分は、ワークフロー実行時に実際の値に置き換えられます。

変数の詳細については、「ワークフローでの変数の使用」を参照してください。

ワークフロートリガー

ワークフロートリガー (または単にトリガー) を使用すると、コードプッシュなどの特定のイベントが発生したときにワークフロー実行を自動的に開始できます。ソフトウェアデベロッパーが CodeCatalyst コンソールを使用してワークフロー実行を手動で開始する必要がないようにトリガーを構成することもできます。

次の 3 種類のトリガーを使用できます。

プッシュ、プルリクエスト、スケジュールの各トリガーは単独で使用することも、同じワークフロー内で組み合わせて使用することもできます。

トリガーは必須ではありません。トリガーを構成しない場合はワークフローを手動で開始する必要があります。

トリガーについての詳細は、「トリガーを使用したワークフロー実行の自動的な開始」を参照してください。