Spec-Zone.ru › AWS CLI v2

[ aws . codeguru-reviewer ]

create-code-review

Описание

Используется для создания обзора кода с типом CodeReviewType RepositoryAnalysis . Этот тип обзора кода анализирует весь код в указанной ветке связанного репозитория. Обзоры кода типа PullRequest автоматически запускаются при создании запроса на вытягивание.

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

Синтаксис

  create-code-review
--name <value>
--repository-association-arn <value>
--type <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]

Параметры

--name (строка)

Имя обзора кода. Имя каждого обзора кода в вашей учетной записи Amazon Web Services должно быть уникальным.

--repository-association-arn (строка)

Amazon Resource Name (ARN) объекта RepositoryAssociation. Вы можете получить этот ARN, вызвав ListRepositoryAssociations .

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

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

Тип обзора кода для создания. Это указывается с помощью объекта CodeReviewType. Вы можете создать обзор кода только типа RepositoryAnalysis .

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

Обзор кода, анализирующий весь код в указанной ветке связанного репозитория. Связанный репозиторий указывается с помощью его ARN в CreateCodeReview .

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

SourceCodeType, указывающий вершину ветки в связанном репозитории.

BranchName -> (строка)

Имя ветки в связанном репозитории. RepositoryHeadSourceCodeType указывает вершину этой ветки.

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

Указывает исходный код, анализируемый в обзоре кода.

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

SourceCodeType, указывающий разницу коммитов, созданную запросом на вытягивание в связанном репозитории.

SourceCommit -> (строка)

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

DestinationCommit -> (строка)

SHA целевого коммита, используемого для создания разницы коммитов. Это поле является обязательным для обзора кода по запросу на вытягивание.

MergeBaseCommit -> (строка)

SHA базового коммита слияния.

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

SourceCodeType, указывающий вершину ветки в связанном репозитории.

BranchName -> (строка)

Имя ветки в связанном репозитории. RepositoryHeadSourceCodeType указывает вершину этой ветки.

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

Тип SourceCodeType, указывающий имя исходной и целевой ветвей в связанном репозитории.

SourceBranchName -> (строка)

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

DestinationBranchName -> (строка)

Целевая ветвь для разницы в связанном репозитории.

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

Информация о связанном репозитории в ведре S3, включающая его имя и объект S3RepositoryDetails . Объект S3RepositoryDetails включает имя ведра S3, ключ S3 для файла исходного кода .zip и ключ S3 для файла с файлами сборки .zip. S3BucketRepository требуется в SourceCodeType для обзоров кода, основанных на S3BucketRepository .

Name -> (строка)

Имя репозитория, когда ProviderType является S3Bucket .

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

Объект S3RepositoryDetails, который указывает имя ведра S3 и объект CodeArtifacts . Объект CodeArtifacts включает ключи S3 объектов для файла исходного кода .zip и файла с файлами сборки .zip.

BucketName -> (строка)

Имя ведра S3, используемого для связывания нового репозитория S3. Оно должно начинаться с codeguru-reviewer- .

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

Объект CodeArtifacts . Объект CodeArtifacts включает ключ S3 объекта для файла исходного кода .zip и файла с файлами сборки .zip, содержащего файлы .jar или .class.

SourceCodeArtifactsObjectKey -> (строка)

Ключ S3 объекта для файла исходного кода .zip. Это требуется для всех обзоров кода.

BuildArtifactsObjectKey -> (строка)

Ключ S3 объекта для файла с файлами сборки .zip, содержащего файлы .jar или .class. Это требуется для обзора кода с анализом безопасности. Для получения дополнительной информации см. Создание обзоров кода с помощью GitHub Actions в Руководстве пользователя Amazon CodeGuru Reviewer .

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

Метаданные, связанные с обзором кода. Это относится к любому типу обзора кода, поддерживаемому CodeGuru Reviewer. Поле RequestMetadaa захватывает любые метаданные события. Например, оно может захватить метаданные, связанные со срабатыванием события, такого как push или запрос на вытягивание.

RequestId -> (строка)

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

Requester -> (строка)

Идентификатор, такой как имя или идентификатор учетной записи, связанный с запрашивающим. Requester используется для захвата имени author/actor запрошенного события.

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

Информация об событии, связанном с обзором кода.

Name -> (строка)

Название события. Возможные названия - pull_request , workflow_dispatch , schedule и push

State -> (строка)

Состояние события. Состояние может быть открытым, закрытым или другим.

VendorName -> (строка)

Название поставщика репозитория, используемого для загрузки кода в ведро S3 для обзора кода CI/CD. Например, если код и артефакты загружаются в ведро S3 для обзора кода CI/CD скриптами GitHub из репозитория GitHub, то ProviderType репозитория ассоциации равен S3Bucket, а имя поставщика репозитория CI/CD равно GitHub. Для получения дополнительной информации см. определение ProviderType в RepositoryAssociation .

AnalysisTypes -> (список)

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

(строка)

Синтаксис JSON:

{
  "RepositoryAnalysis": {
    "RepositoryHead": {
      "BranchName": "string"
    },
    "SourceCodeType": {
      "CommitDiff": {
        "SourceCommit": "string",
        "DestinationCommit": "string",
        "MergeBaseCommit": "string"
      },
      "RepositoryHead": {
        "BranchName": "string"
      },
      "BranchDiff": {
        "SourceBranchName": "string",
        "DestinationBranchName": "string"
      },
      "S3BucketRepository": {
        "Name": "string",
        "Details": {
          "BucketName": "string",
          "CodeArtifacts": {
            "SourceCodeArtifactsObjectKey": "string",
            "BuildArtifactsObjectKey": "string"
          }
        }
      },
      "RequestMetadata": {
        "RequestId": "string",
        "Requester": "string",
        "EventInfo": {
          "Name": "string",
          "State": "string"
        },
        "VendorName": "GitHub"|"GitLab"|"NativeS3"
      }
    }
  },
  "AnalysisTypes": ["Security"|"CodeQuality", ...]
}

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

Amazon CodeGuru Reviewer использует это значение, чтобы предотвратить случайное создание дублирующих обзоров кода в случае ошибок и повторных попыток.

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

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

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

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

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

Примеры

Примечание

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

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

Чтобы создать обзор кода.

Следующий create-code-review создает обзор кода в ветке mainline репозитория AWS CodeCommit с именем my-repository-name.

aws codeguru-reviewer create-code-review \
    --name my-code-review \
    --repository-association-arn arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \
    --type '{"RepositoryAnalysis": {"RepositoryHead": {"BranchName": "mainline"}}}'

Вывод:

{
    "CodeReview": {
        "Name": "my-code-review",
        "CodeReviewArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE22222:code-review:RepositoryAnalysis-my-code-review",
        "RepositoryName": "my-repository-name",
        "Owner": "123456789012",
        "ProviderType": "CodeCommit",
        "State": "Pending",
        "StateReason": "CodeGuru Reviewer has received the request, and a code review is scheduled.",
        "CreatedTimeStamp": 1618873489.195,
        "LastUpdatedTimeStamp": 1618873489.195,
        "Type": "RepositoryAnalysis",
        "SourceCodeType": {
            "RepositoryHead": {
                "BranchName": "mainline"
            }
        },
        "AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
    }
}

Дополнительную информацию см. в разделе «Создание обзоров кода в Amazon CodeGuru Reviewer» в Руководстве пользователя Amazon CodeGuru Reviewer.

Вывод

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

Информация об обзоре кода. Обзор кода принадлежит связанному репозиторию, содержащему просматриваемый код.

Имя -> (строка)

Имя обзора кода.

CodeReviewArn -> (строка)

Amazon Resource Name (ARN) объекта CodeReview.

RepositoryName -> (строка)

Имя репозитория.

Владелец -> (строка)

Владелец репозитория. Для репозитория Amazon Web Services CodeCommit это идентификатор учетной записи Amazon Web Services, владеющей репозиторием. Для репозиториев GitHub, GitHub Enterprise Server или Bitbucket это имя пользователя учетной записи, владеющей репозиторием. Для репозитория S3 это может быть имя пользователя или идентификатор учетной записи Amazon Web Services.

ProviderType -> (строка)

Тип репозитория, содержащего просматриваемый код (например, GitHub или Bitbucket).

Состояние -> (строка)

Допустимые состояния обзора кода:

  • Completed : Обзор кода завершен.
  • Pending : Обзор кода начат, но не завершен и не завершился ошибкой.
  • Failed : Обзор кода завершился ошибкой.
  • Deleting : Обзор кода удаляется.

StateReason -> (строка)

Причина состояния обзора кода.

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

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

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

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

Тип -> (строка)

Тип обзора кода.

PullRequestId -> (строка)

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

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

Тип исходного кода для обзора кода.

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

SourceCodeType, указывающий на разницу между коммитами, созданную запросом на вытягивание в связанном репозитории.

SourceCommit -> (строка)

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

DestinationCommit -> (строка)

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

MergeBaseCommit -> (строка)

SHA базового коммита слияния.

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

SourceCodeType, указывающий на конец ветки в связанном репозитории.

BranchName -> (строка)

Имя ветки в связанном репозитории. RepositoryHeadSourceCodeType указывает на конец этой ветки.

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

Тип SourceCodeType, указывающий имя исходной ветки и имя целевой ветки в связанном репозитории.

SourceBranchName -> (строка)

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

DestinationBranchName -> (строка)

Целевая ветка для разницы в связанном репозитории.

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

Информация о связанном репозитории в ведре S3, включая его имя и объект S3RepositoryDetails. Объект S3RepositoryDetails включает имя ведра S3, ключ S3 для файла исходного кода .zip и ключ S3 для файла артефактов сборки .zip. S3BucketRepository требуется в SourceCodeType для обзоров кода, основанных на S3BucketRepository.

Name -> (строка)

Имя репозитория, когда ProviderType является S3Bucket.

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

Объект S3RepositoryDetails, который определяет имя ведра S3 и объект CodeArtifacts. Объект CodeArtifacts включает ключи объектов S3 для файла исходного кода .zip и файла артефактов сборки .zip.

BucketName -> (строка)

Имя ведра S3, используемого для ассоциации нового репозитория S3. Оно должно начинаться с codeguru-reviewer-.

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

Объект CodeArtifacts. Объект CodeArtifacts включает ключ объекта S3 для файла исходного кода .zip и для файла артефактов сборки .zip, содержащего файлы .jar или .class.

SourceCodeArtifactsObjectKey -> (строка)

Ключ объекта S3 для файла исходного кода .zip. Это обязательно для всех обзоров кода.

BuildArtifactsObjectKey -> (строка)

Ключ объекта S3 для файла артефактов сборки .zip, содержащего файлы .jar или .class. Это обязательно для обзора кода с анализом безопасности. Дополнительную информацию см. в разделе «Создание обзоров кода с помощью GitHub Actions» в Руководстве пользователя Amazon CodeGuru Reviewer.

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

Метаданные, связанные с обзором кода. Это относится к любому типу обзора кода, поддерживаемому CodeGuru Reviewer. Поле RequestMetadaa содержит метаданные любого события. Например, это могут быть метаданные, связанные со срабатыванием события, например, с push или pull запросом.

RequestId -> (строка)

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

Requester -> (строка)

Идентификатор, например, имя или идентификатор учетной записи, связанный с запросившим. Requester используется для захвата имени author/actor запроса события.

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

Информация о событии, связанном с обзором кода.

Имя -> (строка)

Имя события. Возможные имена: pull_request, workflow_dispatch, schedule и push.

Состояние -> (строка)

Состояние события. Состояние может быть открытым, закрытым или другим.

VendorName -> (строка)

Имя поставщика репозитория, используемого для загрузки кода в ведро S3 для обзора кода CI/CD. Например, если код и артефакты загружаются в ведро S3 для обзора кода CI/CD скриптами GitHub из репозитория GitHub, то ProviderType ассоциации репозитория является S3Bucket, а имя поставщика репозитория CI/CD — GitHub. Дополнительную информацию см. в определении ProviderType в RepositoryAssociation.

AssociationArn -> (строка)

Amazon Resource Name (ARN) объекта RepositoryAssociation, содержащего просматриваемый исходный код. Вы можете получить связанные ARN репозиториев, вызвав ListRepositoryAssociations.

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

Статистика из обзора кода.

MeteredLinesOfCodeCount -> (длинное целое)

MeteredLinesOfCodeCount — количество строк кода в репозитории, где произошел обзор кода. Это не включает строки, не являющиеся кодом, такие как комментарии и пустые строки.

SuppressedLinesOfCodeCount -> (длинное целое)

SuppressedLinesOfCodeCount — количество строк кода в репозитории, где произошел обзор кода, который CodeGuru Reviewer не проанализировал. Строки, подавленные при анализе, основаны на переменной excludeFiles в файле aws-codeguru-reviewer.yml. Это число не включает строки, не являющиеся кодом, такие как комментарии и пустые строки.

FindingsCount -> (длинное целое)

Общее количество рекомендаций, найденных в обзоре кода.

AnalysisTypes -> (список)

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

(строка)

ConfigFileState -> (строка)

Состояние файла конфигурации aws-codeguru-reviewer.yml, который позволяет настроить анализ CodeGuru Reviewer. Файл существует, не существует или существует с ошибками в корневой директории вашего репозитория.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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