CodeCommit / Client / create_unreferenced_merge_commit

create_unreferenced_merge_commit#

CodeCommit.Client.create_unreferenced_merge_commit(**kwargs)#

Creates an unreferenced commit that represents the result of merging two branches using a specified merge strategy. This can help you determine the outcome of a potential merge. This API cannot be used with the fast-forward merge strategy because that strategy does not create a merge commit.

Note

This unreferenced merge commit can only be accessed using the GetCommit API or through git commands such as git fetch. To retrieve this commit, you must specify its commit ID or otherwise reference it.

See also: AWS API Documentation

Request Syntax

response = client.create_unreferenced_merge_commit(
    repositoryName='string',
    sourceCommitSpecifier='string',
    destinationCommitSpecifier='string',
    mergeOption='FAST_FORWARD_MERGE'|'SQUASH_MERGE'|'THREE_WAY_MERGE',
    conflictDetailLevel='FILE_LEVEL'|'LINE_LEVEL',
    conflictResolutionStrategy='NONE'|'ACCEPT_SOURCE'|'ACCEPT_DESTINATION'|'AUTOMERGE',
    authorName='string',
    email='string',
    commitMessage='string',
    keepEmptyFolders=True|False,
    conflictResolution={
        'replaceContents': [
            {
                'filePath': 'string',
                'replacementType': 'KEEP_BASE'|'KEEP_SOURCE'|'KEEP_DESTINATION'|'USE_NEW_CONTENT',
                'content': b'bytes',
                'fileMode': 'EXECUTABLE'|'NORMAL'|'SYMLINK'
            },
        ],
        'deleteFiles': [
            {
                'filePath': 'string'
            },
        ],
        'setFileModes': [
            {
                'filePath': 'string',
                'fileMode': 'EXECUTABLE'|'NORMAL'|'SYMLINK'
            },
        ]
    }
)
Parameters:

  • repositoryName (string) –

    [REQUIRED]

    The name of the repository where you want to create the unreferenced merge commit.

  • sourceCommitSpecifier (string) –

    [REQUIRED]

    The branch, tag, HEAD, or other fully qualified reference used to identify a commit (for example, a branch name or a full commit ID).

  • destinationCommitSpecifier (string) –

    [REQUIRED]

    The branch, tag, HEAD, or other fully qualified reference used to identify a commit (for example, a branch name or a full commit ID).

  • mergeOption (string) –

    [REQUIRED]

    The merge option or strategy you want to use to merge the code.

  • conflictDetailLevel (string) – The level of conflict detail to use. If unspecified, the default FILE_LEVEL is used, which returns a not-mergeable result if the same file has differences in both branches. If LINE_LEVEL is specified, a conflict is considered not mergeable if the same file in both branches has differences on the same line.

  • conflictResolutionStrategy (string) – Specifies which branch to use when resolving conflicts, or whether to attempt automatically merging two versions of a file. The default is NONE, which requires any conflicts to be resolved manually before the merge operation is successful.

  • authorName (string) – The name of the author who created the unreferenced commit. This information is used as both the author and committer for the commit.

  • email (string) – The email address for the person who created the unreferenced commit.

  • commitMessage (string) – The commit message for the unreferenced commit.

  • keepEmptyFolders (boolean) – If the commit contains deletions, whether to keep a folder or folder structure if the changes leave the folders empty. If this is specified as true, a .gitkeep file is created for empty folders. The default is false.

  • conflictResolution (dict) –

    If AUTOMERGE is the conflict resolution strategy, a list of inputs to use when resolving conflicts during a merge.

    • replaceContents (list) –

      Files to have content replaced as part of the merge conflict resolution.

      • (dict) –

        Information about a replacement content entry in the conflict of a merge or pull request operation.

        • filePath (string) – [REQUIRED]

          The path of the conflicting file.

        • replacementType (string) – [REQUIRED]

          The replacement type to use when determining how to resolve the conflict.

        • content (bytes) –

          The base-64 encoded content to use when the replacement type is USE_NEW_CONTENT.

        • fileMode (string) –

          The file mode to apply during conflict resoltion.

    • deleteFiles (list) –

      Files to be deleted as part of the merge conflict resolution.

      • (dict) –

        A file that is deleted as part of a commit.

        • filePath (string) – [REQUIRED]

          The full path of the file to be deleted, including the name of the file.

    • setFileModes (list) –

      File modes that are set as part of the merge conflict resolution.

      • (dict) –

        Information about the file mode changes.

        • filePath (string) – [REQUIRED]

          The full path to the file, including the name of the file.

        • fileMode (string) – [REQUIRED]

          The file mode for the file.

Return type:

dict

Returns:

Response Syntax

{
    'commitId': 'string',
    'treeId': 'string'
}

Response Structure

  • (dict) –

    • commitId (string) –

      The full commit ID of the commit that contains your merge results.

    • treeId (string) –

      The full SHA-1 pointer of the tree information for the commit that contains the merge results.

Exceptions