ワークフローの概念 - Amazon CodeCatalyst

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

ワークフローの概念

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

ワークフロー

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

ヒント

プロジェクトでワークフローを使用する方法を簡単に確認するには、設計図 を使用してプロジェクトを作成します。各設計図は、レビュー、実行、実験できる機能的なワークフローをデプロイします。

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

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

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

アクション

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

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

アクショングループ

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

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

アーティファクト

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

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

コンピューティング

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

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

環境

開発 CodeCatalyst 環境 と混同されない環境 は、 CodeCatalyst ワークフローが接続VPCするターゲット AWS アカウント とオプションの Amazon https://docs.aws.amazon.com/codecatalyst/latest/userguide/devenvironment.htmlを定義します。環境は、ワークフローがターゲットアカウント内の AWS サービスとリソースにアクセスするために必要なIAMロールも定義します。

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

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

ゲート

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

ワークフロー内の一連のアクション間にゲートを追加するか、最初のアクション (ソースのダウンロード直後に実行されます) の前にゲートを追加できます。最後のアクションの後にゲートを追加する必要がある場合は、ゲートを追加することもできます。

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

レポート

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

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

実行

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

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

[Sources] (出典)

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

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

変数

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

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

ワークフロートリガー

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

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

  • プッシュ – コードプッシュトリガーは、コミットがプッシュされるたびにワークフローの実行を開始します。

  • プルリクエスト – プルリクエストトリガーは、プルリクエストが作成、改訂、またはクローズされるたびにワークフロー実行を開始します。

  • スケジュール – スケジュールトリガーにより、ワークフローの実行が定義したスケジュールで開始されます。スケジュールトリガーを使用してソフトウェアのビルドを毎晩実行し、ソフトウェアデベロッパーが翌朝作業できるようにすることを検討してください。

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

トリガーはオプションです。設定しない場合、ワークフローを手動で開始することしかできません。

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