CodeCommit

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

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

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

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

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

• [フルクローン] — ソースアクションが、後続のアクションのためにリポジトリへの Git URL リファレンスを出力するように設定します。

  現在、Git URL リファレンスは、リポジトリおよび関連する Git メタデータのクローンを作成するためにダウンストリーム CodeBuild アクションでのみ使用できます。Git URL 参照を 以外のCodeBuild アクションに渡すと、エラーが発生します。

アクションタイプ

• カテゴリ:Source

• 所有者: AWS

• プロバイダー: CodeCommit

• バージョン: 1

設定パラメータ

RepositoryName

必須: はい

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

BranchName

必須: はい

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

PollForSourceChanges

必須: いいえ

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

重要

CloudWatch イベントルールを設定する場合は、パイプラインの実行が重複しないように false PollForSourceChangesを に設定する必要があります。

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

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

  注記

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

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

OutputArtifactFormat

必須: いいえ

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

重要

CODEBUILD_CLONE_REF オプションはダウンストリーム CodeBuildアクションでのみ使用できます。

このオプションを選択した場合は、「」に示すように、 CodeBuild サービスロールに アクセスcodecommit:GitPull許可を追加する必要がありますソースアクションの CodeBuild GitClone CodeCommitアクセス許可を追加する。また、 CodePipeline「」に示すように、サービスロールにアクセスcodecommit:GetRepository許可を追加する必要があります CodePipeline サービスロールにアクセス許可を追加する。[フルクローン] オプションを使用する方法を示すチュートリアルについては、チュートリアル: CodeCommit パイプラインソースでフルクローンを使用する を参照してください。

入力アーティファクト

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

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

出力アーティファクト

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

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

出力変数

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

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

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 ソースを持つパイプラインを作成します。