CodeCommit / Client / merge_pull_request_by_squash

merge_pull_request_by_squash#

CodeCommit.Client.merge_pull_request_by_squash(**kwargs)#

Attempts to merge the source commit of a pull request into the specified destination branch for that pull request at the specified commit using the squash merge strategy. If the merge is successful, it closes the pull request.

Request Syntax

response = client.merge_pull_request_by_squash(
    pullRequestId='string',
    repositoryName='string',
    sourceCommitId='string',
    conflictDetailLevel='FILE_LEVEL'|'LINE_LEVEL',
    conflictResolutionStrategy='NONE'|'ACCEPT_SOURCE'|'ACCEPT_DESTINATION'|'AUTOMERGE',
    commitMessage='string',
    authorName='string',
    email='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:

pullRequestId (string) –
[REQUIRED]

The system-generated ID of the pull request. To get this ID, use ListPullRequests.
repositoryName (string) –
[REQUIRED]

The name of the repository where the pull request was created.
sourceCommitId (string) – The full commit ID of the original or updated commit in the pull request source branch. Pass this value if you want an exception thrown if the current commit ID of the tip of the source branch does not match this commit ID.
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.
commitMessage (string) – The commit message to include in the commit information for the merge.
authorName (string) – The name of the author who created the commit. This information is used as both the author and committer for the commit.
email (string) – The email address of the person merging the branches. This information is used in the commit information for the merge.
keepEmptyFolders (boolean) – If the commit contains deletions, whether to keep a folder or folder structure if the changes leave the folders empty. If 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

{
    'pullRequest': {
        'pullRequestId': 'string',
        'title': 'string',
        'description': 'string',
        'lastActivityDate': datetime(2015, 1, 1),
        'creationDate': datetime(2015, 1, 1),
        'pullRequestStatus': 'OPEN'|'CLOSED',
        'authorArn': 'string',
        'pullRequestTargets': [
            {
                'repositoryName': 'string',
                'sourceReference': 'string',
                'destinationReference': 'string',
                'destinationCommit': 'string',
                'sourceCommit': 'string',
                'mergeBase': 'string',
                'mergeMetadata': {
                    'isMerged': True|False,
                    'mergedBy': 'string',
                    'mergeCommitId': 'string',
                    'mergeOption': 'FAST_FORWARD_MERGE'|'SQUASH_MERGE'|'THREE_WAY_MERGE'
                }
            },
        ],
        'clientRequestToken': 'string',
        'revisionId': 'string',
        'approvalRules': [
            {
                'approvalRuleId': 'string',
                'approvalRuleName': 'string',
                'approvalRuleContent': 'string',
                'ruleContentSha256': 'string',
                'lastModifiedDate': datetime(2015, 1, 1),
                'creationDate': datetime(2015, 1, 1),
                'lastModifiedUser': 'string',
                'originApprovalRuleTemplate': {
                    'approvalRuleTemplateId': 'string',
                    'approvalRuleTemplateName': 'string'
                }
            },
        ]
    }
}

Response Structure

(dict) –
- pullRequest (dict) –
  
  Returns information about a pull request.
  - pullRequestId (string) –
    
    The system-generated ID of the pull request.
  - title (string) –
    
    The user-defined title of the pull request. This title is displayed in the list of pull requests to other repository users.
  - description (string) –
    
    The user-defined description of the pull request. This description can be used to clarify what should be reviewed and other details of the request.
  - lastActivityDate (datetime) –
    
    The day and time of the last user or system activity on the pull request, in timestamp format.
  - creationDate (datetime) –
    
    The date and time the pull request was originally created, in timestamp format.
  - pullRequestStatus (string) –
    
    The status of the pull request. Pull request status can only change from OPEN to CLOSED.
  - authorArn (string) –
    
    The Amazon Resource Name (ARN) of the user who created the pull request.
  - pullRequestTargets (list) –
    
    The targets of the pull request, including the source branch and destination branch for the pull request.
    - (dict) –
      
      Returns information about a pull request target.
      - repositoryName (string) –
        
        The name of the repository that contains the pull request source and destination branches.
      - sourceReference (string) –
        
        The branch of the repository that contains the changes for the pull request. Also known as the source branch.
      - destinationReference (string) –
        
        The branch of the repository where the pull request changes are merged. Also known as the destination branch.
      - destinationCommit (string) –
        
        The full commit ID that is the tip of the destination branch. This is the commit where the pull request was or will be merged.
      - sourceCommit (string) –
        
        The full commit ID of the tip of the source branch used to create the pull request. If the pull request branch is updated by a push while the pull request is open, the commit ID changes to reflect the new tip of the branch.
      - mergeBase (string) –
        
        The commit ID of the most recent commit that the source branch and the destination branch have in common.
      - mergeMetadata (dict) –
        
        Returns metadata about the state of the merge, including whether the merge has been made.
        
        isMerged (boolean) –
        
        A Boolean value indicating whether the merge has been made.
        
        mergedBy (string) –
        
        The Amazon Resource Name (ARN) of the user who merged the branches.
        
        mergeCommitId (string) –
        
        The commit ID for the merge commit, if any.
        
        mergeOption (string) –
        
        The merge strategy used in the merge.
  - clientRequestToken (string) –
    
    A unique, client-generated idempotency token that, when provided in a request, ensures the request cannot be repeated with a changed parameter. If a request is received with the same parameters and a token is included, the request returns information about the initial request that used that token.
  - revisionId (string) –
    
    The system-generated revision ID for the pull request.
  - approvalRules (list) –
    
    The approval rules applied to the pull request.
    - (dict) –
      
      Returns information about an approval rule.
      - approvalRuleId (string) –
        
        The system-generated ID of the approval rule.
      - approvalRuleName (string) –
        
        The name of the approval rule.
      - approvalRuleContent (string) –
        
        The content of the approval rule.
      - ruleContentSha256 (string) –
        
        The SHA-256 hash signature for the content of the approval rule.
      - lastModifiedDate (datetime) –
        
        The date the approval rule was most recently changed, in timestamp format.
      - creationDate (datetime) –
        
        The date the approval rule was created, in timestamp format.
      - lastModifiedUser (string) –
        
        The Amazon Resource Name (ARN) of the user who made the most recent changes to the approval rule.
      - originApprovalRuleTemplate (dict) –
        
        The approval rule template used to create the rule.
        
        approvalRuleTemplateId (string) –
        
        The ID of the template that created the approval rule.
        
        approvalRuleTemplateName (string) –
        
        The name of the template that created the approval rule.

Exceptions

CodeCommit.Client.exceptions.PullRequestAlreadyClosedException
CodeCommit.Client.exceptions.PullRequestDoesNotExistException
CodeCommit.Client.exceptions.PullRequestIdRequiredException
CodeCommit.Client.exceptions.InvalidPullRequestIdException
CodeCommit.Client.exceptions.InvalidCommitIdException
CodeCommit.Client.exceptions.ManualMergeRequiredException
CodeCommit.Client.exceptions.TipOfSourceReferenceIsDifferentException
CodeCommit.Client.exceptions.TipsDivergenceExceededException
CodeCommit.Client.exceptions.NameLengthExceededException
CodeCommit.Client.exceptions.InvalidEmailException
CodeCommit.Client.exceptions.CommitMessageLengthExceededException
CodeCommit.Client.exceptions.InvalidConflictDetailLevelException
CodeCommit.Client.exceptions.InvalidConflictResolutionStrategyException
CodeCommit.Client.exceptions.InvalidConflictResolutionException
CodeCommit.Client.exceptions.ReplacementTypeRequiredException
CodeCommit.Client.exceptions.InvalidReplacementTypeException
CodeCommit.Client.exceptions.MultipleConflictResolutionEntriesException
CodeCommit.Client.exceptions.ReplacementContentRequiredException
CodeCommit.Client.exceptions.MaximumConflictResolutionEntriesExceededException
CodeCommit.Client.exceptions.ConcurrentReferenceUpdateException
CodeCommit.Client.exceptions.PathRequiredException
CodeCommit.Client.exceptions.InvalidPathException
CodeCommit.Client.exceptions.InvalidFileModeException
CodeCommit.Client.exceptions.InvalidReplacementContentException
CodeCommit.Client.exceptions.FileContentSizeLimitExceededException
CodeCommit.Client.exceptions.FolderContentSizeLimitExceededException
CodeCommit.Client.exceptions.MaximumFileContentToLoadExceededException
CodeCommit.Client.exceptions.MaximumItemsToCompareExceededException
CodeCommit.Client.exceptions.RepositoryNameRequiredException
CodeCommit.Client.exceptions.InvalidRepositoryNameException
CodeCommit.Client.exceptions.RepositoryDoesNotExistException
CodeCommit.Client.exceptions.RepositoryNotAssociatedWithPullRequestException
CodeCommit.Client.exceptions.PullRequestApprovalRulesNotSatisfiedException
CodeCommit.Client.exceptions.EncryptionIntegrityChecksFailedException
CodeCommit.Client.exceptions.EncryptionKeyAccessDeniedException
CodeCommit.Client.exceptions.EncryptionKeyDisabledException
CodeCommit.Client.exceptions.EncryptionKeyNotFoundException
CodeCommit.Client.exceptions.EncryptionKeyUnavailableException