Pipeline

以下は Copilot Pipeline の Manifest で利用できるすべてのプロパティのリストです。Pipeline の概念説明のページも合わせてご覧ください。

GitHub のリポジトリからトリガーされる Pipeline のサンプル Manifest
name: pipeline-sample-app-frontend
version: 1

source:
  provider: GitHub
  properties:
    branch: main
    repository: https://github.com/<user>/sample-app-frontend
    # オプション。既存の CodeStar Connection の接続名を指定します。
    connection_name: a-connection

build:
  image: aws/codebuild/amazonlinux2-x86_64-standard:3.0

stages:
    - 
      name: test
      test_commands:
        - make test
        - echo "woo! Tests passed"
    - 
      name: prod
      requires_approval: true

name String
Pipeline 名。

version String
テンプレートのスキーマバージョン。現在サポートされているバージョンは 1 だけです。

source Map Pipeline のトリガーに関する設定。

source.provider String
プロバイダー名。現在 GitHubBitbucket そして CodeCommit がサポートされています。

source.properties Map
Pipeline のトリガーに関するプロバイダー固有の設定。

source.properties.access_token_secret String
Pipeline をトリガーするための GitHub アクセストークンを保持する AWS Secrets Manager シークレットの名前。 (プロバイダーが GitHub で、個人のアクセストークンを利用して Pipeline を作成した場合)

Info

Copilot v1.4.0 から GitHub リポジトリをソースにする場合のアクセストークンは不要になりました。代わりに Copilot は AWS CodeStar の GitHub への接続を使って Pipeline をトリガーします。

source.properties.branch String
Pipeline をトリガーするリポジトリのブランチ名。 GitHub と CodeCommit の場合デフォルトは main で Bitbucket の場合デフォルトは master です。

source.properties.repository String
リポジトリの URL 。

source.properties.connection_name String
既存の CodeStar Connections の接続名。指定しない場合 Copilot は接続を作成します。

build Map
CodeBuild プロジェクトに関する設定。

build.image String
CodeBuild のビルドプロジェクトで利用する Docker イメージの URI。aws/codebuild/amazonlinux2-x86_64-standard:3.0 がデフォルトで利用されます。

stages Array of Maps
Pipeline のデプロイ先である 1 つ以上の Environment をデプロイしたい順番に並べたリスト。

stages.name String
Service をデプロイする Environment 名。

stages.requires_approval Boolean
デプロイの前に手動承認ステップを追加するかどうかの指定。

stages.test_commands Array of Strings
デプロイ後にインテグレーションテストまたは E2E テストを実行するコマンド。