Spec-Zone.ru › AWS CLI v2

[ aws . codecommit ]

create-pull-request

Описание

Создаёт запрос на объединение в указанный репозиторий.

См. также: Документацию API AWS

Синтаксис

  create-pull-request
--title <value>
[--description <value>]
--targets <value>
[--client-request-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--title (строка)

Заголовок запроса на объединение. Используется для идентификации запроса другими пользователями в репозитории.

--description (строка)

Описание запроса на объединение.

--targets (список)

Цели запроса на объединение, включая исходный код для проверки (исходную ветку) и место назначения, куда создатель запроса намеревается объединить код после закрытия запроса (ветку назначения).

(структура)

Возвращает информацию о цели запроса на объединение.

repositoryName -> (строка)

Название репозитория, содержащего запрос на объединение.

sourceReference -> (строка)

Ветка репозитория, содержащая изменения для запроса на объединение. Также известна как исходная ветка.

destinationReference -> (строка)

Ветка репозитория, в которую объединяются изменения запроса на объединение. Также известна как ветка назначения.

Сокращённый синтаксис:

repositoryName=string,sourceReference=string,destinationReference=string ...

Синтаксис JSON:

[
  {
    "repositoryName": "string",
    "sourceReference": "string",
    "destinationReference": "string"
  }
  ...
]

--client-request-token (строка)

Уникальный, сгенерированный клиентом маркер идемпотенции, который, при указании в запросе, гарантирует, что запрос не может быть повторён с изменённым параметром. Если запрос получен с теми же параметрами и включён маркер, запрос возвращает информацию об исходном запросе, который использовал этот маркер.

Примечание

Сервисные инструменты Amazon Web Services SDKs автоматически добавляют маркеры идемпотенции. Если вы используете Amazon Web Services SDKs, то маркер идемпотенции будет сгенерирован для вас.

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON соответствует формату, указанному в --generate-cli-skeleton. Если другие аргументы указаны в командной строке, эти значения переопределят значения, предоставленные через JSON. Невозможно передавать произвольные двоичные значения через предоставленное значение JSON, так как строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит скелет JSON в стандартный вывод без отправки запроса к API. Если не указано значение или указано значение input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если указано yaml-input, будет выведен пример входного YAML, который можно использовать с --cli-input-yaml. Если указано значение output, то проверяются входные данные команды и возвращается пример выходного JSON для данной команды. Сгенерированный JSON-скелет нестабилен между версиями AWS CLI, и нет гарантий обратной совместимости в генерируемом JSON-скелете.

Глобальные параметры

--debug (булево)

Включить отладку.

--endpoint-url (строка)

Переопределить URL по умолчанию команды указанным URL.

--no-verify-ssl (булево)

По умолчанию AWS CLI использует SSL при общении с сервисами AWS. Для каждого подключения SSL AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет поведение проверки сертификатов SSL.

--no-paginate (булево)

Отключить автоматическую постраничность. Если автоматическая постраничность отключена, AWS CLI сделает только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования для вывода команд.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определённый профиль из файла параметров.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

  • on
  • off
  • auto

--no-sign-request (булево)

Не подписывать запросы. Кредиты не будут загружены, если этот аргумент указан.

--ca-bundle (строка)

Файл сертификатов CA для проверки сертификатов SSL. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение равно 0, чтение сокета будет выполняться в блочном режиме без таймаута. Значение по умолчанию 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения сокета в секундах. Если значение равно 0, подключение сокета будет выполняться в блочном режиме без таймаута. Значение по умолчанию 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию - base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как строка, закодированная в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, относящегося к двоичному блоку, fileb:// всегда будет рассматриваться как двоичное и использовать содержимое файла непосредственно, независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (булево)

Отключить пейджер CLI для вывода.

--cli-auto-prompt (булево)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (булево)

Отключить автоматическое запросы параметров ввода CLI.

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Более подробная информация доступна в руководстве по началу работы в Руководстве пользователя AWS CLI.

Если не указано иное, все примеры используют правила цитирования, характерные для Unix-подобных систем. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. Более подробно об использовании кавычек со строками см. в Руководстве пользователя AWS CLI .

Для создания запроса на объединение

Следующий пример создаёт запрос на объединение с именем «Анализатор трудностей произношения» и описанием «Пожалуйста, ознакомьтесь с этими изменениями к вторнику», который направлен на исходную ветку «jane-branch» и должен быть объединён с веткой по умолчанию «main» в репозитории AWS CodeCommit с именем «MyDemoRepo».

aws codecommit create-pull-request \
    --title "My Pull Request" \
    --description "Please review these changes by Tuesday" \
    --client-request-token 123Example \
    --targets repositoryName=MyDemoRepo,sourceReference=MyNewBranch

Вывод:

{
    "pullRequest": {
        "approvalRules": [
            {
                "approvalRuleContent": "{\"Version\": \"2018-11-08\",\"DestinationReferences\": [\"refs/heads/main\"],\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 2,\"ApprovalPoolMembers\": [\"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}",
                "approvalRuleId": "dd8b17fe-EXAMPLE",
                "approvalRuleName": "2-approver-rule-for-main",
                "creationDate": 1571356106.936,
                "lastModifiedDate": 571356106.936,
                "lastModifiedUser": "arn:aws:iam::123456789012:user/Mary_Major",
                "originApprovalRuleTemplate": {
                    "approvalRuleTemplateId": "dd3d22fe-EXAMPLE",
                    "approvalRuleTemplateName": "2-approver-rule-for-main"
                },
                "ruleContentSha256": "4711b576EXAMPLE"
            }
        ],
        "authorArn": "arn:aws:iam::111111111111:user/Jane_Doe",
        "description": "Please review these changes by Tuesday",
        "title": "Pronunciation difficulty analyzer",
        "pullRequestTargets": [
            {
                "destinationCommit": "5d036259EXAMPLE",
                "destinationReference": "refs/heads/main",
                "repositoryName": "MyDemoRepo",
                "sourceCommit": "317f8570EXAMPLE",
                "sourceReference": "refs/heads/jane-branch",
                "mergeMetadata": {
                    "isMerged": false
                }
            }
        ],
        "lastActivityDate": 1508962823.285,
        "pullRequestId": "42",
        "clientRequestToken": "123Example",
        "pullRequestStatus": "OPEN",
        "creationDate": 1508962823.285
    }
}

Вывод

pullRequest -> (структура)

Информация о только что созданном запросе на вытягивание.

pullRequestId -> (строка)

Сгенерированный системой идентификатор запроса на вытягивание.

title -> (строка)

Определяемое пользователем заголовок запроса на вытягивание. Этот заголовок отображается в списке запросов на вытягивание для других пользователей репозитория.

description -> (строка)

Определяемое пользователем описание запроса на вытягивание. Это описание может использоваться для уточнения того, что должно быть проверено, и других деталей запроса.

lastActivityDate -> (метка времени)

День и время последней активности пользователя или системы по запросу на вытягивание в формате метки времени.

creationDate -> (метка времени)

Дата и время первоначального создания запроса на вытягивание в формате метки времени.

pullRequestStatus -> (строка)

Статус запроса на вытягивание. Статус запроса на вытягивание может изменяться только с OPEN на CLOSED.

authorArn -> (строка)

Идентификатор ресурса Amazon (ARN) пользователя, который создал запрос на вытягивание.

pullRequestTargets -> (список)

Целевые объекты запроса на вытягивание, включая исходную и целевую ветви для запроса на вытягивание.

(структура)

Возвращает информацию о целевом объекте запроса на вытягивание.

repositoryName -> (строка)

Имя репозитория, содержащего исходную и целевую ветви запроса на вытягивание.

sourceReference -> (строка)

Ветка репозитория, содержащая изменения для запроса на вытягивание. Также известна как исходная ветка.

destinationReference -> (строка)

Ветка репозитория, в которую будут слиты изменения запроса на вытягивание. Также известна как целевая ветка.

destinationCommit -> (строка)

Полный идентификатор коммита, являющийся вершиной целевой ветки. Это коммит, где запрос на вытягивание был или будет слит.

sourceCommit -> (строка)

Полный идентификатор коммита вершины исходной ветки, используемой для создания запроса на вытягивание. Если ветка запроса на вытягивание обновляется путем отправки изменений, пока запрос на вытягивание открыт, идентификатор коммита изменяется, чтобы отразить новую вершину ветки.

mergeBase -> (строка)

Идентификатор коммита самого последнего коммита, который есть у исходной и целевой ветвей.

mergeMetadata -> (структура)

Возвращает метаданные о состоянии слияния, включая то, было ли произведено слияние.

isMerged -> (логическое значение)

Логическое значение, указывающее, было ли произведено слияние.

mergedBy -> (строка)

Идентификатор ресурса Amazon (ARN) пользователя, который произвел слияние ветвей.

mergeCommitId -> (строка)

Идентификатор коммита слияния, если таковой имеется.

mergeOption -> (строка)

Стратегия слияния, использованная при слиянии.

clientRequestToken -> (строка)

Уникальный, сгенерированный клиентом маркер идемпотентности, который, при предоставлении в запросе, гарантирует, что запрос нельзя повторить с измененным параметром. Если запрос получен с теми же параметрами и маркер включен, запрос возвращает информацию об исходном запросе, который использовал этот маркер.

revisionId -> (строка)

Сгенерированный системой идентификатор ревизии для запроса на вытягивание.

approvalRules -> (список)

Примененные к запросу на вытягивание правила согласования.

(структура)

Возвращает информацию о правиле согласования.

approvalRuleId -> (строка)

Сгенерированный системой идентификатор правила согласования.

approvalRuleName -> (строка)

Название правила согласования.

approvalRuleContent -> (строка)

Содержимое правила согласования.

ruleContentSha256 -> (строка)

Подпись SHA-256 для содержимого правила согласования.

lastModifiedDate -> (метка времени)

Дата последнего изменения правила согласования в формате метки времени.

creationDate -> (метка времени)

Дата создания правила согласования в формате метки времени.

lastModifiedUser -> (строка)

Идентификатор ресурса Amazon (ARN) пользователя, внесшего последние изменения в правило согласования.

originApprovalRuleTemplate -> (структура)

Шаблон правила согласования, используемый для создания правила.

approvalRuleTemplateId -> (строка)

Идентификатор шаблона, который создал правило согласования.

approvalRuleTemplateName -> (строка)

Название шаблона, который создал правило согласования.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API