CodeCommit

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

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

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

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

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

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

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

アクションタイプ

• カテゴリ:Source

• 所有者: AWS

• プロバイダー: CodeCommit

• バージョン: 1

設定パラメータ

RepositoryName

必須: はい

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

BranchName

必須: はい

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

PollForSourceChanges

必須: いいえ

PollForSourceChanges は、CodePipeline がソースの変更に対して 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サービスロール (を参照)追加CodeBuild GitCloneの権限CodeCommitソースアクション。また、追加する必要がありますcodecommit:GetRepositoryあなたへの許可CodePipelineサービスロール (を参照)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アプリケーションとデプロイグループ。このチュートリアルを使用して、次のようなパイプラインを作成します。CodeCommitAmazon EC2 インスタンスにデプロイするソース。