トリガーとフィルタリングを使用してパイプラインを自動的に開始する

プルリクエストなど単一フィルタータイプの場合、複数のフィルターを組み合わせることができます。これらのフィルターは AND 演算を使用するため、完全に一致する場合にのみパイプラインが開始します。次の例は、2 つの異なるフィルター (filePaths と branches) を持つプッシュイベントタイプの Git 設定を示しています。次の例で、filePaths は branches と AND 演算されます。

{
  "filePaths": {
    "includes": ["common/**/*.js"]
  },
  "branches": {
    "includes": ["feature/**"]
  }
}

上の Git 設定の場合、次の例は AND 演算の成功により、パイプライン実行を開始するイベントを示しています。つまり、ファイルパス common/app.js はフィルターに含まれ、指定されたブランチ refs/heads/feature/triggers に影響がない場合でも、パイプラインは AND として開始されます。

{
  "ref": "refs/heads/feature/triggers",
  ...
  "commits": [
    {
      ...
      "modified": [
        "common/app.js"
      ]
      ...
    }
  ]
}

次の例は、ブランチはフィルタリングできるが、ファイルパスはフィルタリングできないため、パイプライン実行を開始しない、上記設定を持つトリガーのイベントを示しています。

{
   "ref": "refs/heads/feature/triggers",
  ...
  "commits": [
    {
      ...
      "modified": [
        "src/Main.java"
      ]
      ...
    }
  ]
}

単一のプルリクエストイベントタイプのブランチなどのトリガーフィルターは、包含と除外の間に AND 演算を使用します。これにより、複数のトリガーが同じパイプラインの実行を開始するように設定できます。次の例は、プッシュイベントの設定オブジェクト内に 1 つのフィルタータイプ (branches) を含むトリガー設定の例を示しています。Includes 演算と Excludes 演算は AND 演算されるため、ブランチが除外パターン (例の feature-branch など) と一致する場合、包含も一致しない限り、パイプラインはトリガーされません。包含パターンが一致すると (main ブランチの場合など)、パイプラインはトリガーされます。

たとえば、次の JSON の例の場合:

{
  "branches": {
      "Includes": [
          "main"
      ],
      "Excludes": [
          "feature-branch"
      ]
   }

プッシュイベントタイプとプルリクエストイベントタイプを含むトリガーなどのトリガー設定オブジェクトは、2 つのイベントタイプ間で OR 演算を使用します。次の例は、main ブランチを含むプッシュイベントタイプと、同じブランチ main を除外する 1 つのプルリクエストイベントタイプのトリガー設定を示しています。さらに、プッシュイベントタイプには、1 つのファイルパス LICENSE.txt が除外され、1 つのファイルパス README.MD が含まれます。2 番目のイベントタイプでは、feature-branch ブランチで Closed または Created のプルリクエストがパイプラインを開始し、feature-branch-2 または main ブランチでプルリクエストが作成または終了する際にパイプラインを開始しません。Includes および Excludes 演算はデフォルトの除外になり、AND は使用されません。例えば、feature-branch ブランチ (プルリクエストに含まれる) のプルリクエストイベントの場合、feature-branch ブランチはプッシュイベントタイプから除外されるため、デフォルトの除外になります。

次の例では

次の画像は、構成を示しています。

以下は、設定の JSON の例です。

"triggers": [
            {
                "providerType": "CodeStarSourceConnection",
                "gitConfiguration": {
                    "sourceActionName": "Source",
                    "push": [
                        {
                            "branches": {
                                "includes": [
                                    "main"
                                ],
                                "excludes": [
                                    "feature-branch",
                                    "feature-branch-2"
                                ]
                            },
                            "filePaths": {
                                "includes": [
                                    "README.md"
                                ],
                                "excludes": [
                                    "LICENSE.txt"
                                ]
                            }
                        }
                    ],
                    "pullRequest": [
                        {
                            "events": [
                                "CLOSED",
                                "OPEN"
                            ],
                            "branches": {
                                "includes": [
                                    "feature-branch"
                                ],
                                "excludes": [
                                    "feature-branch-2",
                                    "main"
                                ]
                            }
                        }
                    ]
                }
            }
        ]
    },

次の図は、タグ release-1 (包含) でフィルタリングするように指定するプッシュフィルタータイプを示しています。2 番目のプッシュフィルタータイプが追加され、ブランチ main をフィルタリングするように指定され(包含)、feature* ブランチへのプッシュを開始しないように指定されます (除外)。

次の例では

次の [編集] ページの例は、2 つのプッシュフィルタータイプと、それらのフィルタータイプの包含と除外の設定を示しています。

アクション設定のデフォルト BranchName フィールドは、パイプラインを手動で開始するときに使用する単一のブランチを定義しますが、フィルター付きのトリガーは、指定した任意のブランチに使用できます。

以下は、BranchName フィールドを示すアクション設定の JSON の例です。

{
                "name": "Source",
                "actions": [
                    {
                        "name": "Source",
                        "actionTypeId": {
                            "category": "Source",
                            "owner": "AWS",
                            "provider": "CodeStarSourceConnection",
                            "version": "1"
                        },
                        "runOrder": 1,
                        "configuration": {
                            "BranchName": "main",
                            "ConnectionArn": "ARN",
                            "DetectChanges": "false",
                            "FullRepositoryId": "owner-name/my-bitbucket-repo",
                            "OutputArtifactFormat": "CODE_ZIP"
                        },
                        "outputArtifacts": [
                            {
                                "name": "SourceArtifact"
                            }
                        ],
                        "inputArtifacts": [],
                        "region": "us-west-2",
                        "namespace": "SourceVariables"
                    }
                ],

次のアクション出力の例は、パイプラインを手動で開始したときに使用されたデフォルトのブランチ main を示しています。

次のアクション出力の例は、プルリクエストでフィルタリングされたときにトリガーに使用されたプルリクエストとブランチを示しています。