Spec-Zone.ru › AWS CLI v2

[ aws . codecommit ]

Создание комментария для сравнения коммитов

Описание

Оставляет комментарий к сравнению двух коммитов.

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

Синтаксис

  post-comment-for-compared-commit
--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]

Параметры

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

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

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

Для определения направления сравнения, полный идентификатор коммита «до» изменения. Требуется для комментирования любого коммита, кроме начального.

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

Для определения направления сравнения, полный идентификатор коммита «после» изменения.

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

Место в сравнении, где нужно оставить комментарий.

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 команды на указанный.

--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 для вывода.

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

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

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

Отключение автоматического запроса параметров CLI.

Примеры

Примечание

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

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

Создание комментария к коммиту

Этот пример демонстрирует, как добавить комментарий "Can you add a test case for this?" к изменению в файле cl_sample.js в сравнении двух коммитов в репозитории с именем MyDemoRepo.

aws codecommit post-comment-for-compared-commit \
    --repository-name MyDemoRepo \
    --before-commit-id 317f8570EXAMPLE \
    --after-commit-id 5d036259EXAMPLE \
    --client-request-token 123Example \
    --content "Can you add a test case for this?" \
    --location filePath=cl_sample.js,filePosition=1232,relativeFileVersion=AFTER

Вывод:

{
    "afterBlobId": "1f330709EXAMPLE",
    "afterCommitId": "317f8570EXAMPLE",
    "beforeBlobId": "80906a4cEXAMPLE",
    "beforeCommitId": "6e147360EXAMPLE",
    "comment": {
        "authorArn": "arn:aws:iam::111111111111:user/Li_Juan",
        "clientRequestToken": "",
        "commentId": "553b509bEXAMPLE56198325",
        "content": "Can you add a test case for this?",
        "creationDate": 1508369612.203,
        "deleted": false,
        "commentId": "abc123-EXAMPLE",
        "lastModifiedDate": 1508369612.203,
        "callerReactions": [],
        "reactionCounts": []
    },
    "location": {
        "filePath": "cl_sample.js",
        "filePosition": 1232,
        "relativeFileVersion": "AFTER"
    ,
    "repositoryName": "MyDemoRepo"
    }
}

Вывод

repositoryName -> (строка)

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

beforeCommitId -> (строка)

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

afterCommitId -> (строка)

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

beforeBlobId -> (строка)

В заданном направлении сравнения, идентификатор блока «до» изменения.

afterBlobId -> (строка)

В заданном направлении сравнения, идентификатор блока «после» изменения.

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