Skip to main content
Skip to content

Выдача веб-перехватчиков состояния и рабочих процессов

Используйте веб-перехватчики и GitHub Actions рабочие процессы для реагирования на изменения состояния проблемы.

Примечание.

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

Сведения о событиях изменения состояния

При изменении GitHub состояния проблемы отправляет issues событие веб-перехватчика с действием status_changed . Полезные данные для каждого issues действия также включают текущее состояние проблемы.issue.status Эти события можно использовать для синхронизации других средств с проблемами или запуска GitHub Actions рабочего процесса при достижении определенного состояния проблемы.

Состояния включаются только для проблем в репозиториях, использующих состояния проблемы. Для других проблем полезные данные не включаются issue.statusи GitHub не отправляются status_changed.

Сведения о полной схеме полезных данных см. в разделе События и полезные данные веб-перехватчика.

Объекты состояний

Полезные данные веб-перехватчика описывают каждое состояние объекта с тремя свойствами.

PropertyTypeDescription
idIntegerИдентификатор состояния.
nameStringОтображаемое имя состояния, например In progress. Имя может измениться.
categoryStringКатегория состояния, например backlog, planned, started, , completed``not_plannedили duplicate. В будущем можно добавить дополнительные категории.

Несколько состояний могут принадлежать одной категории. Например, во время выполнения и при проверке started оба относятся к категории. Чтобы сопоставить одно состояние в коде или рабочем процессе, используйте его id. Чтобы соответствовать каждому состоянию в категории, используйте его category. Не совпадайте name.

issue.status — если null проблема не имеет состояния. Например, проблема, созданная до того, как состояния были доступны в своем репозитории, не имеет состояния, пока кто-то не задает его или пока проблема не будет закрыта или повторно открыта.

Полезные status_changed данные

issueПомимо , repository``senderи других свойств, которые включают все issues полезные данные, status_changed полезные данные включают следующие свойства. Для этого действия используется пользователь или приложение, sender которое изменило состояние.

PropertyDescription
statusСостояние проблемы изменилось.
changes.status.fromСостояние проблемы было до изменения или null если у него нет.
changes.state.fromПредыдущая state проблема open или closed. Включается только в том случае, если изменение состояния также закрыто или повторно открыло проблему.
changes.state_reason.fromПредыдущая state_reason проблема. Только в том случае, если изменение состояния также изменило причину состояния, например путем закрытия или повторного открытия проблемы, или путем изменения причины его закрытия. Это когда null проблема не имеет причины состояния, например при первом закрытии.

Захваченные значения и текущая проблема

changes Свойства status описывают изменение во время его сохранения. Свойство issue , в том числе issue.status, описывает проблему при построении доставки, так же, как и для каждого другого issues действия. Если проблема снова изменится до этого, issue.status может отличаться от status. Например, если кто-то переместит проблему из "Выполняется" на "В обзоре", а затем быстро до "Готово", доставка для первого изменения может иметь issue.status значение "Готово".

Чтобы узнать, что такое определенное изменение, используйте status и changes. Задержка, извлечение или повторная полезные данные могут быть устаревшими, поэтому issue.status может не быть последним состоянием проблемы. Дополнительные сведения см. в разделе "Доставка" далее в этой статье.

Когда status_changed отправляется

GitHub status_changed отправляет каждый раз состояние проблемы, включая изменения, внесенные GitHub при создании, закрытии или повторном открытии проблемы.

  • Установка состояния: кто-то выбирает другое состояние проблемы.
  • Создание проблемы: новая проблема получает состояние невыполненной работы, если пользователь, создающий его, не выбирает другое состояние. changes.status.from равно null. GitHub opened отправляет, а также status_changed.
  • Установка первого состояния: существующая проблема без состояния получает одно. changes.status.from равно null.
  • Закрытие или повторное открытие проблемы: закрытие проблемы по мере завершения задает состояние Готово, закрывая его как не запланированные наборы не запланированные, и закрывая его в виде повторяющихся наборов. Повторное открытие проблемы без выбора набора состояния невыполненной работы. GitHub closed отправляет или reopened такжеstatus_changed.
  • Связывание запроса на вытягивание: связывание открытого запроса на вытягивание с открытой проблемой, которая не имеет состояния или состояния невыполненной работы или состояния Todo, перемещает проблему на ход выполнения. sender — это лицо или приложение, связанное с запросом на вытягивание. Если они не могут выбрать состояние проблемы, состояние не изменится.

GitHub не отправляется status_changed в следующих случаях:

  • Состояние не изменяется, например, если кто-то выбирает состояние, которое уже имеет проблема.
  • Проблема передается в другой репозиторий. Новая проблема сохраняет состояние, в котором полезные transferred данные включаются changes.new_issue.status.

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

Состояния в completedкатегориях и not_planned``duplicate категориях предназначены для закрытых проблем. Выбор одного из этих состояний для открытой проблемы закрывает проблему и выбирает состояние в любой другой категории для закрытой проблемы повторно открывает ее.

Когда изменение состояния закрывается или повторно открывает проблему, GitHub отправляет две поставки: status_changedи closed или reopened. Две поставки могут поступать в любом порядке.

Изменение закрытой проблемы на состояние с другой причиной закрытия, например от "Готово" до "Не запланировано", отправляется status_changed без changes.state_reason changes.stateнее. GitHub также отправляет другую closed доставку с новым state_reason.

Если интеграция обрабатывается status_changed так же, как closed или reopened, убедитесь, что она может обрабатывать одинаковые изменения, сообщаемые обеими поставками.

Доставка

GitHub status_changed поставляется так же, как и другие события веб-перехватчика. Доставка — это лучшие усилия. GitHub не гарантирует, что каждое изменение доставляется ровно один раз или что поставки поступают в порядок, в котором произошли изменения.

  • Неудачные поставки: доставка может завершиться ошибкой, например если сервер недоступен. GitHub не выполняет автоматическое повторное создание неудачных поставок, но их можно переделить. Дополнительные сведения см. в разделе Обработка неудачных поставок веб-перехватчика.
  • Повторяющиеся поставки: вы можете получать одну и ту же доставку более одного раза, например при повторном выполнении. Redelivery имеет тот же X-GitHub-Delivery заголовок, что и исходная доставка, поэтому можно использовать заголовок для пропуска поставок, которые вы уже обработали.
  • Заказ: Поставки могут поступать из заказа, а также отложенные, повторные или повторно используемые полезные данные могут быть устаревшими, в том числе issue.status. Не используйте заказ, в котором прибывают поставки, чтобы определить последнее состояние проблемы.

Чтобы получить последнее состояние проблемы, получите проблему с REST API. Дополнительные сведения см. в разделе Конечные точки REST API для проблем. В репозиториях, принадлежащих организации, ответ включает в себя status любой GitHub App прошедший проверку подлинности запрос, включая запросы, прошедшие проверку подлинности в качестве установки и запросов, используемых GITHUB_TOKEN в рабочем процессе. предварительный просмотрВ репозиториях, принадлежащих личной учетной записи, ответ включает status только в том случае, если запрос выполняется от имени пользователя, имеющего доступ к предварительной версии. Если ответ не включает status, используйте состояние от доставки с осторожностью, так как доставка, которая прибывает позже, может нести более старое состояние.

Кто может изменить состояние

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

  • Пользовательские роли репозитория: в репозиториях, принадлежащих организации, люди с настраиваемой ролью, наследующей роль Triage, Write или Maintain, могут выбирать состояния. Пользователи с настраиваемой ролью, наследующей роль чтения, не могут выбирать состояния, даже если роль может задать типы проблем.
  • Приложения и рабочие процессы: в репозиториях, принадлежащих организации, GitHub Apps с доступом на запись для разрешения репозитория "Проблемы" также могут выбирать состояния, включая рабочие процессы, используемые GITHUB_TOKEN с разрешением issues: write .
  • Личные учетные записи: во время предварительный просмотррепозиториев, принадлежащих личной учетной записи, только пользователи, имеющие доступ к предварительной версии, могут выбирать состояния.

При выборе состояния, закрывающего или повторно открывающего проблему, также требуется разрешение на закрытие или повторное открытие проблемы. Изменение того, почему закрытая проблема закрыта, например от Done to Not planned, требует разрешения как закрыть, так и повторно открыть его.

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

Выполнение рабочего процесса при изменении состояния

Чтобы запустить рабочий GitHub Actions процесс при изменении состояния проблемы, используйте status_changed тип issues действия события. Рабочий процесс выполняется при изменении состояния проблемы. В рабочем процессе следующие свойства контекста github.event описывают изменение.

  • github.event.status содержит состояние, на который была изменена проблема.
  • github.event.changes.status.from содержит предыдущее состояние или null если проблема не была установлена.
  • github.event.issue.status содержит состояние проблемы при создании полезных данных. Полезные данные для каждого issues типа действия включают это свойство.

Внимание

Рабочие процессы, использующие issues событие без types выполнения status_changed. Эти рабочие процессы выполняются всякий раз, когда кто-то изменяет состояние проблемы и выполняет дополнительное время при создании, закрытии или повторном открытии, так как GitHub отправляется status_changed , а также opened, closedили reopened. Чтобы избежать непредвиденных запусков, выведите список типов действий, необходимых рабочему процессу.

предварительный просмотрВо время редакторов, проверяющих файлы рабочего процесса, например редактор GitHubрабочих процессов, может сообщаться status_changed как недопустимый тип действия. Эту ошибку можно игнорировать.

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

Примеры нагрузок действий

В следующих фрагментах показаны свойства полезных status_changed данных, описывающих изменение. Полные полезные данные также включают полныеissue``repository, а также sender объекты и другие свойства.

Создание проблемы

Когда кто-то создает проблему без выбора состояния, проблема получает состояние невыполненной работы. changes.status.from is null, и changes не включает state или state_reason.

{
  "action": "status_changed",
  "issue": {
    "number": 1347,
    "state": "open",
    "state_reason": null,
    "status": {
      "id": 2,
      "name": "Backlog",
      "category": "backlog"
    }
  },
  "status": {
    "id": 2,
    "name": "Backlog",
    "category": "backlog"
  },
  "changes": {
    "status": {
      "from": null
    }
  }
}

Изменение состояния в той же категории

Перемещение проблемы из "Выполняется" в "Проверка" не изменяет его состояние или ее категорию, поэтому changes включает только в себя status.

{
  "action": "status_changed",
  "issue": {
    "number": 1347,
    "state": "open",
    "state_reason": null,
    "status": {
      "id": 8,
      "name": "In review",
      "category": "started"
    }
  },
  "status": {
    "id": 8,
    "name": "In review",
    "category": "started"
  },
  "changes": {
    "status": {
      "from": {
        "id": 4,
        "name": "In progress",
        "category": "started"
      }
    }
  }
}

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

Перемещение проблемы из "В просмотре" в "Готово" закрывает проблему. changes.state.from is open, и changes.state_reason.from это null потому, что проблема не имеет причины состояния раньше. GitHub также отправляет доставку closed для этого изменения.

{
  "action": "status_changed",
  "issue": {
    "number": 1347,
    "state": "closed",
    "state_reason": "completed",
    "status": {
      "id": 5,
      "name": "Done",
      "category": "completed"
    }
  },
  "status": {
    "id": 5,
    "name": "Done",
    "category": "completed"
  },
  "changes": {
    "status": {
      "from": {
        "id": 8,
        "name": "In review",
        "category": "started"
      }
    },
    "state": {
      "from": "open"
    },
    "state_reason": {
      "from": null
    }
  }
}