update-webhook

Описание

Обновляет вебхук, связанный с проектом сборки CodeBuild.

Примечание

Если вы используете Bitbucket для вашего репозитория, rotateSecret игнорируется.

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

Синтаксис

  update-webhook
--project-name <value>
[--branch-filter <value>]
[--rotate-secret | --no-rotate-secret]
[--filter-groups <value>]
[--build-type <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]

Параметры

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

Имя проекта CodeBuild.

--branch-filter (строка)

Регулярное выражение, используемое для определения веток репозитория, которые будут собираться при срабатывании вебхука. Если имя ветки соответствует регулярному выражению, то она будет собрана. Если branchFilter пустое, то собираются все ветки.

Примечание

Рекомендуется использовать filterGroups вместо branchFilter .

--rotate-secret | --no-rotate-secret (логическое значение)

Логическое значение, указывающее, следует ли обновлять секретный токен связанного репозитория GitHub. Если вы используете Bitbucket для своего репозитория, rotateSecret игнорируется.

--filter-groups (список)

Массив массивов объектов WebhookFilter, используемых для определения, может ли событие вебхука инициировать сборку. Группа фильтров должна содержать по крайней мере один EVENT WebhookFilter .

(список)

(структура)

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

type -> (строка)

Тип фильтра вебхука. Существует 11 типов фильтров вебхуков: EVENT , ACTOR_ACCOUNT_ID , HEAD_REF , BASE_REF , FILE_PATH , COMMIT_MESSAGE , TAG_NAME , RELEASE_NAME , REPOSITORY_NAME , ORGANIZATION_NAME и WORKFLOW_NAME .

EVENT
- Событие вебхука запускает сборку, когда предоставленное pattern соответствует одному из девяти типов событий: PUSH , PULL_REQUEST_CREATED , PULL_REQUEST_UPDATED , PULL_REQUEST_CLOSED , PULL_REQUEST_REOPENED , PULL_REQUEST_MERGED , RELEASED , PRERELEASED и WORKFLOW_JOB_QUEUED . Шаблоны EVENT задаются в виде строки, разделенной запятыми. Например, PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED фильтрует все события push, создания запроса на изменение и обновления запроса на изменение.
Примечание

Типы PULL_REQUEST_REOPENED и WORKFLOW_JOB_QUEUED работают только с GitHub и GitHub Enterprise. Типы RELEASED и PRERELEASED работают только с GitHub.
ACTOR_ACCOUNT_ID
- Событие вебхука запускает сборку, когда идентификатор учетной записи GitHub, GitHub Enterprise или Bitbucket соответствует регулярному выражению pattern .
HEAD_REF
- Событие вебхука запускает сборку, когда ссылка head соответствует регулярному выражению pattern . Например, refs/heads/branch-name и refs/tags/tag-name .
Примечание

Работает с событиями push и запроса на изменение GitHub и GitHub Enterprise, push Bitbucket и запроса на изменение Bitbucket.
BASE_REF
- Событие вебхука запускает сборку, когда ссылка base соответствует регулярному выражению pattern . Например, refs/heads/branch-name .
Примечание

Работает только с событиями запроса на изменение.
FILE_PATH
- Вебхук запускает сборку, когда путь измененного файла соответствует регулярному выражению pattern .
Примечание

Работает только с событиями push и запроса на изменение.
COMMIT_MESSAGE
- Вебхук запускает сборку, когда сообщение о коммите соответствует регулярному выражению pattern .
Примечание

Работает только с событиями push и запроса на изменение.
TAG_NAME
- Вебхук запускает сборку, когда имя тега выпуска соответствует регулярному выражению pattern .
Примечание

Работает только с событиями RELEASED и PRERELEASED .
RELEASE_NAME
- Вебхук запускает сборку, когда имя выпуска соответствует регулярному выражению pattern .
Примечание

Работает только с событиями RELEASED и PRERELEASED .
REPOSITORY_NAME
- Вебхук запускает сборку, когда имя репозитория соответствует регулярному выражению pattern .
Примечание

Работает только с глобальными или организационными вебхуками GitHub.
ORGANIZATION_NAME
- Вебхук запускает сборку, когда имя организации соответствует регулярному выражению pattern .
Примечание

Работает только с глобальными вебхуками GitHub.
WORKFLOW_NAME
- Вебхук запускает сборку, когда имя рабочего процесса соответствует регулярному выражению pattern .
Примечание

Работает только с событиями WORKFLOW_JOB_QUEUED .

Примечание

Для сборок Buildkite runner, размещенных в CodeBuild, фильтры WORKFLOW_NAME будут фильтровать по имени конвейера.

pattern -> (строка)

Для WebHookFilter, использующей тип EVENT, строка, разделенная запятыми, указывающая один или несколько событий. Например, фильтр вебхука PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED разрешает всем событиям push, создания запроса на изменение и обновления запроса на изменение запускать сборку.

Для WebHookFilter, использующей любой другой тип фильтра, регулярное выражение. Например, WebHookFilter, использующая HEAD_REF для type и шаблон ^refs/heads/ запускает сборку, когда ссылка head является веткой с именем ссылки refs/heads/branch-name .

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

Используется для указания того, что pattern определяет, какие события вебхука не запускают сборку. Если значение true, то событие вебхука, не соответствующее pattern, запускает сборку. Если значение false, то событие вебхука, соответствующее pattern, запускает сборку.

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

[{type=string,pattern=string,excludeMatchedPattern=boolean},{type=string,pattern=string,excludeMatchedPattern=boolean}] ...

Синтаксис JSON:

[
  [
    {
      "type": "EVENT"|"BASE_REF"|"HEAD_REF"|"ACTOR_ACCOUNT_ID"|"FILE_PATH"|"COMMIT_MESSAGE"|"WORKFLOW_NAME"|"TAG_NAME"|"RELEASE_NAME"|"REPOSITORY_NAME"|"ORGANIZATION_NAME",
      "pattern": "string",
      "excludeMatchedPattern": true|false
    }
    ...
  ]
  ...
]

--build-type (строка)

Указывает тип сборки, которую запустит этот вебхук.

Примечание

RUNNER_BUILDKITE_BUILD доступен только для проектов типа источника NO_SOURCE, настроенных для сборок Buildkite runner. Дополнительную информацию о сборках Buildkite runner, размещенных в CodeBuild, см. в руководстве пользователя CodeBuild в разделе «Руководство: Настройка CodeBuild-hosted Buildkite runner».

Возможные значения:

BUILD
BUILD_BATCH
RUNNER_BUILDKITE_BUILD

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

Включить отладку регистрации.

--endpoint-url (string)

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

--no-verify-ssl (boolean)

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

--no-paginate (boolean)

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

--output (string)

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

json
text
table
yaml
yaml-stream

--query (string)

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

--profile (string)

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

--region (string)

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

--version (string)

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

--color (string)

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

on
off
auto

--no-sign-request (boolean)

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

--ca-bundle (string)

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

--cli-read-timeout (int)

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

--cli-connect-timeout (int)

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

--cli-binary-format (string)

Стиль форматирования для двоичных блоков. Формат по умолчанию — 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 (boolean)

Отключить вывод пагинатора CLI.

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Примеры

Примечание

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

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

Для обновления вебхука для проекта AWS CodeBuild

В следующем update-webhook примере обновляется вебхук для указанного проекта CodeBuild с двумя группами фильтров. Параметр --rotate-secret указывает, что GitHub должен обновлять секретный ключ проекта каждый раз, когда изменение кода запускает сборку. Первая группа фильтров определяет запросы на добавление, изменение или повторное открытие ветвей с именами Git-ссылок, соответствующими регулярному выражению ^refs/heads/master$, и ссылками голов, соответствующими ^refs/heads/myBranch$. Вторая группа фильтров определяет запросы на отправку изменений в ветви с именами Git-ссылок, не соответствующими регулярному выражению ^refs/heads/myBranch$.

aws codebuild update-webhook \
    --project-name Project2 \
    --rotate-secret \
    --filter-groups "[[{\"type\":\"EVENT\",\"pattern\":\"PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, PULL_REQUEST_REOPENED\"},{\"type\":\"HEAD_REF\",\"pattern\":\"^refs/heads/myBranch$\",\"excludeMatchedPattern\":true},{\"type\":\"BASE_REF\",\"pattern\":\"^refs/heads/master$\",\"excludeMatchedPattern\":true}],[{\"type\":\"EVENT\",\"pattern\":\"PUSH\"},{\"type\":\"HEAD_REF\",\"pattern\":\"^refs/heads/myBranch$\",\"excludeMatchedPattern\":true}]]"

Вывод:

{
    "webhook": {
        "filterGroups": [
            [
                {
                    "pattern": "PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, PULL_REQUEST_REOPENED",
                    "type": "EVENT"
                },
                {
                    "excludeMatchedPattern": true,
                    "pattern": "refs/heads/myBranch$",
                    "type": "HEAD_REF"
                },
                {
                    "excludeMatchedPattern": true,
                    "pattern": "refs/heads/master$",
                    "type": "BASE_REF"
                }
            ],
            [
                {
                    "pattern": "PUSH",
                    "type": "EVENT"
                },
                {
                    "excludeMatchedPattern": true,
                    "pattern": "refs/heads/myBranch$",
                    "type": "HEAD_REF"
                }
            ]
        ],
        "lastModifiedSecret": 1556312220.133
    }
}

Дополнительную информацию см. в разделе Изменение параметров проекта сборки (AWS CLI) в Руководстве пользователя AWS CodeBuild

Вывод

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

Информация о webhook хранилища, связанном с проектом в CodeBuild.

url -> (строка)

URL webhook.

payloadUrl -> (строка)

Конечная точка CodeBuild, куда отправляются события webhook.

secret -> (строка)

Секретный токен связанного хранилища.

Примечание

Bitbucket webhook не поддерживает secret .

branchFilter -> (строка)

Регулярное выражение, используемое для определения ветвей хранилища, которые будут построены при срабатывании webhook. Если имя ветки соответствует регулярному выражению, то она строится. Если branchFilter пусто, то строятся все ветви.

Примечание

Рекомендуется использовать filterGroups вместо branchFilter .

filterGroups -> (список)

Массив массивов объектов WebhookFilter, используемых для определения, какие webhook срабатывают. По крайней мере, один WebhookFilter в массиве должен указывать EVENT в качестве своего type .

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

(список)

(структура)

Фильтр, используемый для определения, какие webhook запускают сборку.

type -> (строка)

Тип фильтра webhook. Существует 11 типов фильтров webhook: EVENT , ACTOR_ACCOUNT_ID , HEAD_REF , BASE_REF , FILE_PATH , COMMIT_MESSAGE , TAG_NAME , RELEASE_NAME , REPOSITORY_NAME , ORGANIZATION_NAME и WORKFLOW_NAME .

EVENT
- Событие webhook запускает сборку, когда предоставленное pattern соответствует одному из девяти типов событий: PUSH , PULL_REQUEST_CREATED , PULL_REQUEST_UPDATED , PULL_REQUEST_CLOSED , PULL_REQUEST_REOPENED , PULL_REQUEST_MERGED , RELEASED , PRERELEASED и WORKFLOW_JOB_QUEUED . Шаблоны EVENT задаются как строка, разделённая запятыми. Например, PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED фильтрует все события push, создания pull-запроса и обновления pull-запроса.
Примечание

Типы PULL_REQUEST_REOPENED и WORKFLOW_JOB_QUEUED работают только с GitHub и GitHub Enterprise. Типы RELEASED и PRERELEASED работают только с GitHub.
ACTOR_ACCOUNT_ID
- Событие webhook запускает сборку, когда идентификатор учётной записи GitHub, GitHub Enterprise или Bitbucket соответствует регулярному выражению pattern .
HEAD_REF
- Событие webhook запускает сборку, когда ссылка head соответствует регулярному выражению pattern . Например, refs/heads/branch-name и refs/tags/tag-name .
Примечание

Работает с событиями push GitHub и GitHub Enterprise, pull-запросами GitHub и GitHub Enterprise, push Bitbucket и pull-запросами Bitbucket.
BASE_REF
- Событие webhook запускает сборку, когда ссылка base соответствует регулярному выражению pattern . Например, refs/heads/branch-name .
Примечание

Работает только с событиями pull-запроса.
FILE_PATH
- Webhook запускает сборку, когда путь изменённого файла соответствует регулярному выражению pattern .
Примечание

Работает только с событиями push и pull-запроса.
COMMIT_MESSAGE
- Webhook запускает сборку, когда сообщение о коммите соответствует регулярному выражению pattern .
Примечание

Работает только с событиями push и pull-запроса.
TAG_NAME
- Webhook запускает сборку, когда имя тега релиза соответствует регулярному выражению pattern .
Примечание

Работает только с событиями RELEASED и PRERELEASED .
RELEASE_NAME
- Webhook запускает сборку, когда имя релиза соответствует регулярному выражению pattern .
Примечание

Работает только с событиями RELEASED и PRERELEASED .
REPOSITORY_NAME
- Webhook запускает сборку, когда имя хранилища соответствует регулярному выражению pattern .
Примечание

Работает только с глобальными или организационными webhook GitHub.
ORGANIZATION_NAME
- Webhook запускает сборку, когда имя организации соответствует регулярному выражению pattern .
Примечание

Работает только с глобальными webhook GitHub.
WORKFLOW_NAME
- Webhook запускает сборку, когда имя workflow соответствует регулярному выражению pattern .
Примечание

Работает только с событиями WORKFLOW_JOB_QUEUED .

Примечание

Для сборок Buildkite runner, размещённых в CodeBuild, фильтры WORKFLOW_NAME будут фильтровать по имени пайплайна.

pattern -> (строка)

Для WebHookFilter, использующей тип EVENT , строка, разделённая запятыми, которая определяет одно или несколько событий. Например, фильтр webhook PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED позволяет всем событиям push, создания pull-запроса и обновления pull-запроса запускать сборку.

Для WebHookFilter, использующей любой другой тип фильтра, шаблон регулярного выражения. Например, WebHookFilter, использующая HEAD_REF для своего type и шаблон ^refs/heads/ запускает сборку, когда ссылка head — это ветка с именем ссылки refs/heads/branch-name .

excludeMatchedPattern -> (булево)

Используется для указания того, что pattern определяет события webhook, которые не запускают сборку. Если true, то событие webhook, которое не соответствует pattern , запускает сборку. Если false, то событие webhook, которое соответствует pattern , запускает сборку.

buildType -> (строка)

Указывает тип сборки, которую этот webhook запустит.

Примечание

RUNNER_BUILDKITE_BUILD доступен только для проектов типа источника NO_SOURCE, настроенных для сборок Buildkite runner. Для получения дополнительной информации о сборках Buildkite runner, размещённых в CodeBuild, см. Учебник: Настройка CodeBuild-hosted Buildkite runner в Руководстве пользователя CodeBuild.

manualCreation -> (булево)

Если manualCreation равно true, CodeBuild не создаёт webhook в GitHub и вместо этого возвращает значения payloadUrl и secret для webhook. Значения payloadUrl и secret в выводе можно использовать для ручного создания webhook в GitHub.

Примечание

manualCreation доступен только для webhook GitHub.

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

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

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

Настройка области действия для глобальных или организационных webhook.

Примечание

Глобальные или организационные webhook доступны только для webhook GitHub и Github Enterprise.

name -> (строка)

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

domain -> (строка)

Домен организации GitHub Enterprise или группы GitLab Self Managed. Обратите внимание, что этот параметр необходим только в том случае, если тип источника вашего проекта — GITHUB_ENTERPRISE или GITLAB_SELF_MANAGED.

scope -> (строка)

Тип области действия для webhook GitHub или GitLab. Значение по умолчанию — GITHUB_ORGANIZATION.

status -> (строка)

Статус webhook. Допустимые значения:

CREATING : webhook создаётся.
CREATE_FAILED : webhook не удалось создать.
ACTIVE : webhook успешно создан и активен.
DELETING : webhook удаляется.

statusMessage -> (строка)

Сообщение, связанное со статусом webhook.

END_OF_DOCUMENT_MARKER