Skip to content

create_unreferenced_merge_commit

create_unreferenced_merge_commit(
    repository_name: RepositoryName,
    source_commit_specifier: CommitName,
    destination_commit_specifier: CommitName,
    merge_option: MergeOptionTypeEnum,
    *,
    config_overrides: Optional[CodeCommitClientConfig] = None,
    conflict_detail_level: Optional[ConflictDetailLevelTypeEnum] = None,
    conflict_resolution_strategy: Optional[ConflictResolutionStrategyTypeEnum] = None,
    author_name: Optional[Name] = None,
    email: Optional[Email] = None,
    commit_message: Optional[Message] = None,
    keep_empty_folders: Optional[KeepEmptyFolders] = None,
    conflict_resolution: Optional[ConflictResolution] = None,
) -> CreateUnreferencedMergeCommitOutput

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.

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.

Parameters:

  • repository_name (RepositoryName) –

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

  • source_commit_specifier (CommitName) –

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

  • destination_commit_specifier (CommitName) –

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

  • merge_option (MergeOptionTypeEnum) –

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

  • conflict_detail_level (Optional[ConflictDetailLevelTypeEnum], default: None ) –

    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.

  • conflict_resolution_strategy (Optional[ConflictResolutionStrategyTypeEnum], default: None ) –

    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.

  • author_name (Optional[Name], default: None ) –

    The name of the author who created the unreferenced commit. This information is used as both the author and committer for the commit.

  • email (Optional[Email], default: None ) –

    The email address for the person who created the unreferenced commit.

  • commit_message (Optional[Message], default: None ) –

    The commit message for the unreferenced commit.

  • keep_empty_folders (Optional[KeepEmptyFolders], default: None ) –

    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.

  • conflict_resolution (Optional[ConflictResolution], default: None ) –

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

Raises:

Source code in docs_src/capo_codecommit/_services/code_commit.py
def create_unreferenced_merge_commit(
    self,
    repository_name: "capo_codecommit.types.repository_name.RepositoryName",
    source_commit_specifier: "capo_codecommit.types.commit_name.CommitName",
    destination_commit_specifier: "capo_codecommit.types.commit_name.CommitName",
    merge_option: "capo_codecommit.types.merge_option_type_enum.MergeOptionTypeEnum",
    *,
    config_overrides: Optional[CodeCommitClientConfig] = None,
    conflict_detail_level: Optional[
        "capo_codecommit.types.conflict_detail_level_type_enum.ConflictDetailLevelTypeEnum"
    ] = None,
    conflict_resolution_strategy: Optional[
        "capo_codecommit.types.conflict_resolution_strategy_type_enum.ConflictResolutionStrategyTypeEnum"
    ] = None,
    author_name: Optional["capo_codecommit.types.name.Name"] = None,
    email: Optional["capo_codecommit.types.email.Email"] = None,
    commit_message: Optional["capo_codecommit.types.message.Message"] = None,
    keep_empty_folders: Optional[
        "capo_codecommit.types.keep_empty_folders.KeepEmptyFolders"
    ] = None,
    conflict_resolution: Optional[
        "capo_codecommit.types.conflict_resolution.ConflictResolution"
    ] = None,
) -> "capo_codecommit.types.create_unreferenced_merge_commit_output.CreateUnreferencedMergeCommitOutput":
    """<p>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.</p> <note> <p>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.</p> </note>

    Args:
        repository_name: <p>The name of the repository where you want to create the unreferenced merge commit.</p>
        source_commit_specifier: <p>The branch, tag, HEAD, or other fully qualified reference used to identify a commit (for example, a branch name or a full commit ID).</p>
        destination_commit_specifier: <p>The branch, tag, HEAD, or other fully qualified reference used to identify a commit (for example, a branch name or a full commit ID).</p>
        merge_option: <p>The merge option or strategy you want to use to merge the code.</p>
        conflict_detail_level: <p>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.</p>
        conflict_resolution_strategy: <p>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.</p>
        author_name: <p>The name of the author who created the unreferenced commit. This information is used as both the author and committer for the commit.</p>
        email: <p>The email address for the person who created the unreferenced commit.</p>
        commit_message: <p>The commit message for the unreferenced commit.</p>
        keep_empty_folders: <p>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.</p>
        conflict_resolution: <p>If AUTOMERGE is the conflict resolution strategy, a list of inputs to use when resolving conflicts during a merge.</p>

    Raises:
        capo_codecommit.errors.commit_does_not_exist_exception.CommitDoesNotExistException: <p>The specified commit does not exist or no commit was specified, and the specified repository has no default branch.</p>
        capo_codecommit.errors.commit_message_length_exceeded_exception.CommitMessageLengthExceededException: <p>The commit message is too long. Provide a shorter string. </p>
        capo_codecommit.errors.commit_required_exception.CommitRequiredException: <p>A commit was not specified.</p>
        capo_codecommit.errors.concurrent_reference_update_exception.ConcurrentReferenceUpdateException: <p>The merge cannot be completed because the target branch has been modified. Another user might have modified the target branch while the merge was in progress. Wait a few minutes, and then try again.</p>
        capo_codecommit.errors.encryption_integrity_checks_failed_exception.EncryptionIntegrityChecksFailedException: <p>An encryption integrity check failed.</p>
        capo_codecommit.errors.encryption_key_access_denied_exception.EncryptionKeyAccessDeniedException: <p>An encryption key could not be accessed.</p>
        capo_codecommit.errors.encryption_key_disabled_exception.EncryptionKeyDisabledException: <p>The encryption key is disabled.</p>
        capo_codecommit.errors.encryption_key_not_found_exception.EncryptionKeyNotFoundException: <p>No encryption key was found.</p>
        capo_codecommit.errors.encryption_key_unavailable_exception.EncryptionKeyUnavailableException: <p>The encryption key is not available.</p>
        capo_codecommit.errors.file_content_size_limit_exceeded_exception.FileContentSizeLimitExceededException: <p>The file cannot be added because it is too large. The maximum file size is 6 MB, and the combined file content change size is 7 MB. Consider making these changes using a Git client.</p>
        capo_codecommit.errors.file_mode_required_exception.FileModeRequiredException: <p>The commit cannot be created because no file mode has been specified. A file mode is required to update mode permissions for a file.</p>
        capo_codecommit.errors.folder_content_size_limit_exceeded_exception.FolderContentSizeLimitExceededException: <p>The commit cannot be created because at least one of the overall changes in the commit results in a folder whose contents exceed the limit of 6 MB. Either reduce the number and size of your changes, or split the changes across multiple folders.</p>
        capo_codecommit.errors.invalid_commit_exception.InvalidCommitException: <p>The specified commit is not valid.</p>
        capo_codecommit.errors.invalid_conflict_detail_level_exception.InvalidConflictDetailLevelException: <p>The specified conflict detail level is not valid.</p>
        capo_codecommit.errors.invalid_conflict_resolution_exception.InvalidConflictResolutionException: <p>The specified conflict resolution list is not valid.</p>
        capo_codecommit.errors.invalid_conflict_resolution_strategy_exception.InvalidConflictResolutionStrategyException: <p>The specified conflict resolution strategy is not valid.</p>
        capo_codecommit.errors.invalid_email_exception.InvalidEmailException: <p>The specified email address either contains one or more characters that are not allowed, or it exceeds the maximum number of characters allowed for an email address.</p>
        capo_codecommit.errors.invalid_file_mode_exception.InvalidFileModeException: <p>The specified file mode permission is not valid. For a list of valid file mode permissions, see <a>PutFile</a>. </p>
        capo_codecommit.errors.invalid_merge_option_exception.InvalidMergeOptionException: <p>The specified merge option is not valid for this operation. Not all merge strategies are supported for all operations.</p>
        capo_codecommit.errors.invalid_path_exception.InvalidPathException: <p>The specified path is not valid.</p>
        capo_codecommit.errors.invalid_replacement_content_exception.InvalidReplacementContentException: <p>Automerge was specified for resolving the conflict, but the replacement type is not valid or content is missing. </p>
        capo_codecommit.errors.invalid_replacement_type_exception.InvalidReplacementTypeException: <p>Automerge was specified for resolving the conflict, but the specified replacement type is not valid.</p>
        capo_codecommit.errors.invalid_repository_name_exception.InvalidRepositoryNameException: <p>A specified repository name is not valid.</p> <note> <p>This exception occurs only when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.</p> </note>
        capo_codecommit.errors.manual_merge_required_exception.ManualMergeRequiredException: <p>The pull request cannot be merged automatically into the destination branch. You must manually merge the branches and resolve any conflicts.</p>
        capo_codecommit.errors.maximum_conflict_resolution_entries_exceeded_exception.MaximumConflictResolutionEntriesExceededException: <p>The number of allowed conflict resolution entries was exceeded.</p>
        capo_codecommit.errors.maximum_file_content_to_load_exceeded_exception.MaximumFileContentToLoadExceededException: <p>The number of files to load exceeds the allowed limit.</p>
        capo_codecommit.errors.maximum_items_to_compare_exceeded_exception.MaximumItemsToCompareExceededException: <p>The number of items to compare between the source or destination branches and the merge base has exceeded the maximum allowed.</p>
        capo_codecommit.errors.merge_option_required_exception.MergeOptionRequiredException: <p>A merge option or stategy is required, and none was provided.</p>
        capo_codecommit.errors.multiple_conflict_resolution_entries_exception.MultipleConflictResolutionEntriesException: <p>More than one conflict resolution entries exists for the conflict. A conflict can have only one conflict resolution entry.</p>
        capo_codecommit.errors.name_length_exceeded_exception.NameLengthExceededException: <p>The user name is not valid because it has exceeded the character limit for author names. </p>
        capo_codecommit.errors.path_required_exception.PathRequiredException: <p>The folderPath for a location cannot be null.</p>
        capo_codecommit.errors.replacement_content_required_exception.ReplacementContentRequiredException: <p>USE_NEW_CONTENT was specified, but no replacement content has been provided.</p>
        capo_codecommit.errors.replacement_type_required_exception.ReplacementTypeRequiredException: <p>A replacement type is required.</p>
        capo_codecommit.errors.repository_does_not_exist_exception.RepositoryDoesNotExistException: <p>The specified repository does not exist.</p>
        capo_codecommit.errors.repository_name_required_exception.RepositoryNameRequiredException: <p>A repository name is required, but was not specified.</p>
        capo_codecommit.errors.tips_divergence_exceeded_exception.TipsDivergenceExceededException: <p>The divergence between the tips of the provided commit specifiers is too great to determine whether there might be any merge conflicts. Locally compare the specifiers using <code>git diff</code> or a diff tool.</p>
        capo_codecommit.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_codecommit.types.create_unreferenced_merge_commit_input.CreateUnreferencedMergeCommitInput]",
    ) -> OperationResponse[
        "capo_codecommit.types.create_unreferenced_merge_commit_output.CreateUnreferencedMergeCommitOutput"
    ]:
        import capo_codecommit._operations.code_commit_20150413.create_unreferenced_merge_commit

        output, http_response = (
            capo_codecommit._operations.code_commit_20150413.create_unreferenced_merge_commit.create_unreferenced_merge_commit(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateUnreferencedMergeCommit")
    )
    input_: capo_codecommit.types.create_unreferenced_merge_commit_input.CreateUnreferencedMergeCommitInput = {
        "repository_name": repository_name,
        "source_commit_specifier": source_commit_specifier,
        "destination_commit_specifier": destination_commit_specifier,
        "merge_option": merge_option,
    }
    if conflict_detail_level is not None:
        input_["conflict_detail_level"] = conflict_detail_level
    if conflict_resolution_strategy is not None:
        input_["conflict_resolution_strategy"] = conflict_resolution_strategy
    if author_name is not None:
        input_["author_name"] = author_name
    if email is not None:
        input_["email"] = email
    if commit_message is not None:
        input_["commit_message"] = commit_message
    if keep_empty_folders is not None:
        input_["keep_empty_folders"] = keep_empty_folders
    if conflict_resolution is not None:
        input_["conflict_resolution"] = conflict_resolution

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output