Spec-Zone.ru › AWS CLI v2

[ aws . codecommit ]

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

Описание

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

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

Синтаксис

  post-comment-for-pull-request
--pull-request-id <value>
--repository-name <value>
--before-commit-id <value>
--after-commit-id <value>
[--location <value>]
--content <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]

Параметры

--pull-request-id (строка)

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

--repository-name (строка)

Имя репозитория, в котором вы хотите добавить комментарий к запросу на вытягивание.

--before-commit-id (строка)

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

--after-commit-id (строка)

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

--location (структура)

Местоположение изменения, где вы хотите добавить комментарий. Если местоположение не указано, комментарий добавляется как общий комментарий к разнице между коммитом до изменения (beforeCommitId) и коммитом после изменения (afterCommitId).

filePath -> (строка)

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

filePosition -> (целое число)

Позиция изменения в сравниваемом файле в формате номера строки.

relativeFileVersion -> (строка)

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

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

filePath=string,filePosition=long,relativeFileVersion=string

Синтаксис JSON:

{
  "filePath": "string",
  "filePosition": long,
  "relativeFileVersion": "BEFORE"|"AFTER"
}

--content (строка)

Содержание вашего комментария к изменению.

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

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

--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
  • текст
  • таблица
  • yaml
  • yaml-поток

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • включить
  • выключить
  • авто

--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-auto-prompt (булево)

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

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

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

Примеры

Примечание

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

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

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

Следующий пример post-comment-for-pull-request добавляет комментарий «Эти значения, похоже, нигде не используются. Можно ли их удалить?» к изменению файла ahs_count.py в запросе на вытягивание с ID 47 в репозитории с именем MyDemoRepo.

aws codecommit post-comment-for-pull-request \
    --pull-request-id "47" \
    --repository-name MyDemoRepo \
    --before-commit-id 317f8570EXAMPLE \
    --after-commit-id 5d036259EXAMPLE \
    --client-request-token 123Example \
    --content "These don't appear to be used anywhere. Can we remove them?" \
    --location filePath=ahs_count.py,filePosition=367,relativeFileVersion=AFTER

Вывод:

{
     "afterBlobId": "1f330709EXAMPLE",
     "afterCommitId": "5d036259EXAMPLE",
     "beforeBlobId": "80906a4cEXAMPLE",
     "beforeCommitId": "317f8570EXAMPLE",
     "comment": {
            "authorArn": "arn:aws:iam::111111111111:user/Saanvi_Sarkar",
            "clientRequestToken": "123Example",
            "commentId": "abcd1234EXAMPLEb5678efgh",
            "content": "These don't appear to be used anywhere. Can we remove them?",
            "creationDate": 1508369622.123,
            "deleted": false,
            "CommentId": "",
            "lastModifiedDate": 1508369622.123,
            "callerReactions": [],
            "reactionCounts": []
        },
        "location": {
            "filePath": "ahs_count.py",
            "filePosition": 367,
            "relativeFileVersion": "AFTER"
         },
     "repositoryName": "MyDemoRepo",
     "pullRequestId": "47"
}

Вывод

repositoryName -> (строка)

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

pullRequestId -> (строка)

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

beforeCommitId -> (строка)

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

afterCommitId -> (строка)

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

beforeBlobId -> (строка)

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

afterBlobId -> (строка)

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

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

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

filePath -> (строка)

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

filePosition -> (целое число)

Позиция изменения в сравниваемом файле в формате номера строки.

relativeFileVersion -> (строка)

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

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

Содержание добавленного вами комментария.

commentId -> (строка)

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

content -> (строка)

Содержание комментария.

inReplyTo -> (строка)

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

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

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

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

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

authorArn -> (строка)

Amazon Resource Name (ARN) человека, который добавил комментарий.

deleted -> (булево)

Логическое значение, указывающее, был ли комментарий удалён.

clientRequestToken -> (строка)

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

callerReactions -> (список)

Эмоджи-реакции на комментарий, если таковые имеются, представленные пользователем, чьи учетные данные связаны с вызовом API.

(строка)

reactionCounts -> (отображение)

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

ключ -> (строка)

значение -> (целое число)

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

Spec-Zone.ru

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