CodeCommit

設定された CodeCommit リポジトリとブランチで新しいコミットが行われたときに、パイプラインを開始します。

コンソールを使用してパイプラインを作成または編集する場合、CodePipeline は、リポジトリで変更が発生したときにパイプラインを開始する CodeCommit CloudWatch イベントルールを作成します。

CodeCommit アクションを使用してパイプラインを接続する前に、CodeCommit リポジトリを作成しておく必要があります。

コードの変更が検出された後は、後続のアクションにコードを渡すための次のオプションがあります。

• デフォルト値— コミットの浅いコピーを含む ZIP ファイルを出力するように CodeCommit ソースアクションを設定します。

• フルクローン作成— 後続のアクションに対して Git URL リファレンスをリポジトリに出力するようにソースアクションを設定します。

  現在、Git URL リファレンスは、リポジトリと関連する Git メタデータをクローンするために下流の CodeBuild アクションでのみ使用できます。Git URL リファレンスを非 CodeBuild アクションに渡そうとすると、エラーが発生します。

アクションの種類

• カテゴリ: Source

• 所有者: AWS

• プロバイダー: CodeCommit

• バージョン: 1

設定パラメータ

RepositoryName

必須 はい

ソースの変更が検出されるリポジトリの名前。

BranchName

必須 はい

ソースの変更が検出されるブランチの名前。

PollForSourceChanges

必須 いいえ

PollForSourceChangesは、CodePipeline Mit リポジトリをソースの変更に対して CodeCommit リポジトリをポーリングするかどうかを制御します。代わりに、CloudWatch イベントを使用してソースの変更を検出することをお勧めします。CloudWatch イベントの設定の詳細については、」プッシュイベント用にパイプラインを更新する (CodeCommit ソース) (CLI)またはプッシュイベント用にパイプラインを更新する (CodeCommit ソース) (AWS CloudFormationテンプレート)。

重要

CloudWatch イベントルールを設定する場合は、PollForSourceChanges～falseを使用して、パイプラインの重複実行を回避できます。

このパラメータの有効な値:

• true: 設定されている場合、CodePipeline は、ソースの変更についてポーリングします。

  注記

  省略するとPollForSourceChangesに設定されている場合、CodePipeline は、ソースの変更についてデフォルトでポーリングします。この動作は、PollForSourceChanges が含まれており、true に設定されている場合と同じです。

• false: 設定されている場合、CodePipeline は、ソースの変更についてリポジトリをポーリングしません。ソースの変更を検出するように CloudWatch イベントルールを設定する場合は、この設定を使用します。

OutputArtifactFormat

必須 いいえ

出力アーティファクト形式。値は、次のいずれかです。CODEBUILD_CLONE_REFまたはCODE_ZIP。指定しない場合、デフォルトの CODE_ZIP が使用されます。

重要

-CODEBUILD_CLONE_REFオプションは、CodeBuild 下流のアクションのみで使用できます。

このオプションを選択する場合は、オプションとしてcodecommit:GitPullアクセス許可を CodeBuild サービスロールに付与します。CodeCommit ソースアクションの CodeBuild GitClone アクセス許可を追加する。また、追加する必要もあります。codecommit:GetRepositoryアクセス許可を CodePipeline サービスロールに付与します。CodePipeline サービスロールにアクセス許可を追加する。を使用する方法を示すチュートリアルでは、フルクローン作成オプションの詳細については、チュートリアル: CodeCommit パイプラインソースで完全クローンを使用する。

入力アーティファクト

• アーティファクトの数: 0

• 説明: 入力アーティファクトは、このアクションタイプには適用されません。

出力アーティファクト

• アーティファクトの数: 1

• 説明: このアクションの出力アーティファクトは、パイプライン実行のソースリビジョンとして指定されたコミットで設定されたリポジトリとブランチの内容を含む ZIP ファイルです。リポジトリから生成されたアーティファクトは、CodeCommit アクションの出力アーティファクトです。ソースコードのコミット ID は、トリガーされたパイプライン実行のソースリビジョンとして、CodePipeline に表示されます。

出力変数

このアクションを設定すると、パイプライン内のダウンストリームアクションのアクション設定によって参照できる変数が生成されます。このアクションは、アクションに名前空間がない場合でも、出力変数として表示できる変数を生成します。名前空間を使用してアクションを設定し、これらの変数をダウンストリームアクションの設定で使用できるようにします。

詳細については、「Variables」を参照してください。

CommitId

パイプライン実行をトリガーした CodeCommit ID。コミット ID は、コミットの完全な SHA です。

CommitMessage

パイプライン実行をトリガーしたコミットに関連付けられた説明メッセージ (存在する場合)。

RepositoryName

パイプラインをトリガーしたコミットが行われた CodeCommit リポジトリの名前。

BranchName

ソースが変更された CodeCommit リポジトリのブランチの名前。

AuthorDate

コミットが認証された日付 (タイムスタンプ形式)。

Git での著者とコミッターの違いに関する詳細については、Scott Chacon と Ben Straub による Pro Git の「コミット履歴の表示」を参照してください。

CommitterDate

コミットがコミットされた日付 (タイムスタンプ形式)。

Git での著者とコミッターの違いに関する詳細については、Scott Chacon と Ben Straub による Pro Git の「コミット履歴の表示」を参照してください。

アクション設定の例

デフォルトの出力アーティファクト形式の例

YAML

Actions:
  - OutputArtifacts:
      - Name: Artifact_MyWebsiteStack
    InputArtifacts: []
    Name: source
    Configuration:
      RepositoryName: MyWebsite
      BranchName: main
      PollForSourceChanges: 'false'
    RunOrder: 1
    ActionTypeId:
      Version: '1'
      Provider: CodeCommit
      Category: Source
      Owner: AWS
  Name: Source

JSON

{
    "Actions": [
        {
            "OutputArtifacts": [
                {
                    "Name": "Artifact_MyWebsiteStack"
                }
            ],
            "InputArtifacts": [],
            "Name": "source",
            "Configuration": {
                "RepositoryName": "MyWebsite",
                "BranchName": "main",
                "PollForSourceChanges": "false"
            },
            "RunOrder": 1,
            "ActionTypeId": {
                "Version": "1",
                "Provider": "CodeCommit",
                "Category": "Source",
                "Owner": "AWS"
            }
        }
    ],
    "Name": "Source"
},

完全なクローン出力アーティファクト形式の例

YAML

name: Source
actionTypeId:
  category: Source
  owner: AWS
  provider: CodeCommit
  version: '1'
runOrder: 1
configuration:
  BranchName: main
  OutputArtifactFormat: CODEBUILD_CLONE_REF
  PollForSourceChanges: 'false'
  RepositoryName: MyWebsite
outputArtifacts:
  - name: SourceArtifact
inputArtifacts: []
region: us-west-2
namespace: SourceVariables

JSON

{
    "name": "Source",
    "actionTypeId": {
        "category": "Source",
        "owner": "AWS",
        "provider": "CodeCommit",
        "version": "1"
    },
    "runOrder": 1,
    "configuration": {
        "BranchName": "main",
        "OutputArtifactFormat": "CODEBUILD_CLONE_REF",
        "PollForSourceChanges": "false",
        "RepositoryName": "MyWebsite"
    },
    "outputArtifacts": [
        {
            "name": "SourceArtifact"
        }
    ],
    "inputArtifacts": [],
    "region": "us-west-2",
    "namespace": "SourceVariables"
}

以下の資料も参照してください。

このアクションを利用する際に役立つ関連リソースは以下の通りです。

• チュートリアル: シンプルなパイプラインを作成する (CodeCommit リポジトリ)— このチュートリアルでは、サンプルアプリケーション仕様ファイル、サンプル CodeDeploy アプリケーションおよびデプロイグループを提供します。このチュートリアルを参照して、Amazon EC2 インスタンスにデプロイする CodeCommit ソースを含むパイプラインを作成します。