Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . codecommit ]

merge-pull-request-by-fast-forward

Description

Closes a pull request and 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 fast-forward merge option.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  merge-pull-request-by-fast-forward
--pull-request-id <value>
--repository-name <value>
[--source-commit-id <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--pull-request-id (string)

The system-generated ID of the pull request. To get this ID, use ListPullRequests .

--repository-name (string)

The name of the repository where the pull request was created.

--source-commit-id (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.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To merge and close a pull request

This example demonstrates how to merge and close a pull request with the ID of '47' and a source commit ID of '99132ab0EXAMPLE' in a repository named 'MyDemoRepo':

aws codecommit merge-pull-request-by-fast-forward --pull-request-id 47 --source-commit-id 99132ab0EXAMPLE --repository-name MyDemoRepo

Output:

{
 "pullRequest": {
    "authorArn": "arn:aws:iam::111111111111:user/Li_Juan",
    "clientRequestToken": "",
    "creationDate": 1508530823.142,
    "description": "Review the latest changes and updates to the global variables",
    "lastActivityDate": 1508887223.155,
    "pullRequestId": "47",
    "pullRequestStatus": "CLOSED",
    "pullRequestTargets": [
       {
          "destinationCommit": "9f31c968EXAMPLE",
          "destinationReference": "refs/heads/master",
          "mergeMetadata": {
             "isMerged": true,
             "mergedBy": "arn:aws:iam::111111111111:user/Mary_Major"
          },
          "repositoryName": "MyDemoRepo",
          "sourceCommit": "99132ab0EXAMPLE",
          "sourceReference": "refs/heads/variables-branch"
       }
    ],
    "title": "Consolidation of global variables"
  }
}

Output

pullRequest -> (structure)

Information about the specified pull request, including information about the merge.

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 users of the repository.

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 -> (timestamp)

The day and time of the last user or system activity on the pull request, in timestamp format.

creationDate -> (timestamp)

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.

(structure)

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 will be merged into. 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 will change 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 -> (structure)

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.

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 will return information about the initial request that used that token.