GitHub — хостинг git-репозиториев. Блок ходит в API (Application Programming Interface — программный интерфейс) по токену: PR (pull request — запрос на слияние), задачи, файлы, ветки, релизы, GitHub Actions (автоматические сценарии) и проекты.
С GitHub в Pailot вы можете:
- Читать PR, комментировать, создавать, сливать и закрывать
- Работать с задачами, метками и исполнителями
- Читать и менять файлы, ветки и защиту ветки
- Управлять релизами, workflow и проектами V2
- Запускать процесс по событию GitHub, если включён триггер
Нужен токен API GitHub. Блок ставят на холст как отдельный шаг или прикрепляют к агенту. Токен — в переменных окружения рабочего пространства. Не публикуйте URL вебхука (входящего HTTP-запроса).
Карточка PR: diff и изменённые файлы
| Параметр | Тип | Обязательный | Описание |
|---|
owner | string | Да | Владелец репозитория |
repo | string | Да | Имя репозитория |
pullNumber | number | Да | Номер pull request |
apiKey | string | Да | Токен API GitHub |
| Параметр | Тип | Описание |
|---|
id | number | ID запроса на слияние |
number | number | Номер pull request |
title | string | Название PR |
state | string | Статус PR (open/closed) |
html_url | string | URL на GitHub |
diff_url | string | URL сырого diff |
body | string | Описание PR |
user | json | Кто создал PR |
head | json | Исходная ветка |
base | json | Целевая ветка |
merged | boolean | PR слит |
mergeable | boolean | PR можно слить |
merged_by | json | Кто слил PR |
comments | number | Число комментариев |
review_comments | number | Число комментариев ревью |
commits | number | Число коммитов |
additions | number | Добавлено строк |
deletions | number | Удалено строк |
changed_files | number | Число изменённых файлов |
created_at | string | Когда создали |
updated_at | string | Когда обновляли |
closed_at | string | Когда закрыли |
merged_at | string | Когда слили |
files | array | Массив изменённых файлов |
Комментарии к PR GitHub
| Параметр | Тип | Обязательный | Описание |
|---|
owner | string | Да | Владелец репозитория |
repo | string | Да | Имя репозитория |
body | string | Да | Текст комментария |
pullNumber | number | Да | Номер pull request |
path | string | Нет | Путь файла для комментария ревью |
position | number | Нет | Номер строки для комментария ревью |
commentType | string | Нет | Тип комментария (pr_comment или file_comment) |
line | number | Нет | Номер строки для комментария ревью |
side | string | Нет | Сторона diff (LEFT или RIGHT) |
commitId | string | Нет | SHA коммита для комментария |
apiKey | string | Да | Токен API GitHub |
| Параметр | Тип | Описание |
|---|
id | number | ID комментария |
body | string | Текст комментария |
html_url | string | URL на GitHub |
user | json | Кто написал комментарий |
path | string | Путь файла (если комментарий к файлу) |
line | number | Номер строки |
side | string | Сторона diff |
commit_id | string | ID коммита |
created_at | string | Когда создали |
updated_at | string | Когда обновляли |
Метаданные репозитория: звёзды, форки, задачи, основной язык. Публичные и закрытые репозитории.
| Параметр | Тип | Обязательный | Описание |
|---|
owner | string | Да | Владелец репозитория (user or organization) |
repo | string | Да | Имя репозитория |
apiKey | string | Да | Персональный токен доступа GitHub |
| Параметр | Тип | Описание |
|---|
id | number | ID репозитория |
name | string | Имя репозитория |
full_name | string | Полное имя репозитория (owner/repo) |
description | string | Описание репозитория |
html_url | string | URL на GitHub |
homepage | string | URL домашней страницы |
language | string | Основной язык |
default_branch | string | Имя основной ветки |
visibility | string | Видимость репозитория (public/private) |
private | boolean | Репозиторий закрытый |
fork | boolean | Это форк |
archived | boolean | Репозиторий в архиве |
disabled | boolean | Репозиторий отключён |
stargazers_count | number | Число звёзд |
watchers_count | number | Число наблюдателей |
forks_count | number | Число форков |
open_issues_count | number | Число открытых задач |
topics | array | Темы репозитория |
created_at | string | Когда создали |
updated_at | string | Когда обновляли |
pushed_at | string | Когда был последний push |
owner | json | Владелец репозитория object |
license | json | Сведения о лицензии |
Последний коммит репозитория GitHub
| Параметр | Тип | Обязательный | Описание |
|---|
owner | string | Да | Владелец репозитория (user or organization) |
repo | string | Да | Имя репозитория |
branch | string | Нет | Имя ветки (по умолчанию основная) |
apiKey | string | Да | Токен API GitHub |
| Параметр | Тип | Описание |
|---|
sha | string | SHA коммита |
html_url | string | URL на GitHub |
commit | json | Коммит: сообщение, автор, коммитер |
author | json | Пользователь-автор |
committer | json | Коммитер |
Комментарий к задаче GitHub
| Параметр | Тип | Обязательный | Описание |
|---|
owner | string | Да | Владелец репозитория |
repo | string | Да | Имя репозитория |
issue_number | number | Да | Номер задачи |
body | string | Да | Текст комментария |
apiKey | string | Да | Токен API GitHub |
| Параметр | Тип | Описание |
|---|
id | number | ID комментария |
body | string | Текст комментария |
html_url | string | URL на GitHub |
user | json | Кто написал комментарий |
created_at | string | Когда создали |
updated_at | string | Когда обновляли |
Список комментариев задачи GitHub
| Параметр | Тип | Обязательный | Описание |
|---|
owner | string | Да | Владелец репозитория |
repo | string | Да | Имя репозитория |
issue_number | number | Да | Номер задачи |
since | string | Нет | Только комментарии после этой метки ISO 8601 |
per_page | number | Нет | Результатов на страницу (максимум 100) |
page | number | Нет | Номер страницы |
apiKey | string | Да | Токен API GitHub |
| Параметр | Тип | Описание |
|---|
items | array | Массив комментариев |
↳ id | number | ID комментария |
↳ body | string | Текст комментария |
↳ user | object | Кто написал комментарий |
↳ html_url | string | URL на GitHub |
↳ created_at | string | Когда создали |
↳ updated_at | string | Когда обновляли |
count | number | Число комментариев returned |
Обновить комментарий к задаче или PR
| Параметр | Тип | Обязательный | Описание |
|---|
owner | string | Да | Владелец репозитория |
repo | string | Да | Имя репозитория |
comment_id | number | Да | ID комментария |
body | string | Да | Обновлённый текст комментария |
apiKey | string | Да | Токен API GitHub |
| Параметр | Тип | Описание |
|---|
id | number | ID комментария |
body | string | Текст комментария |
html_url | string | URL на GitHub |
user | json | Кто обновил комментарий |
created_at | string | Когда создали |
updated_at | string | Когда обновляли |
Удалить комментарий к задаче или PR
| Параметр | Тип | Обязательный | Описание |
|---|
owner | string | Да | Владелец репозитория |
repo | string | Да | Имя репозитория |
comment_id | number | Да | ID комментария |
apiKey | string | Да | Токен API GitHub |
| Параметр | Тип | Описание |
|---|
deleted | boolean | Удаление удалось |
comment_id | number | ID удалённого комментария |
Комментарии ревью PR
| Параметр | Тип | Обязательный | Описание |
|---|
owner | string | Да | Владелец репозитория |
repo | string | Да | Имя репозитория |
pullNumber | number | Да | Номер pull request |
sort | string | Нет | Сортировка: created или updated |
direction | string | Нет | Направление (asc или desc) |
since | string | Нет | Только комментарии после этой метки ISO 8601 |
per_page | number | Нет | Результатов на страницу (максимум 100) |
page | number | Нет | Номер страницы |
apiKey | string | Да | Токен API GitHub |
| Параметр | Тип | Описание |
|---|
items | array | Комментарии ревью |
↳ id | number | ID комментария |
↳ body | string | Текст комментария |
↳ path | string | Путь к файлу |
↳ line | number | Номер строки |
↳ user | object | Кто написал комментарий |
↳ html_url | string | URL на GitHub |
↳ diff_hunk | string | Контекст diff |
↳ created_at | string | Когда создали |
↳ updated_at | string | Когда обновляли |
count | number | Число комментариев returned |
Создать pull request
| Параметр | Тип | Обязательный | Описание |
|---|
owner | string | Да | Владелец репозитория |
repo | string | Да | Имя репозитория |
title | string | Да | Название PR |
head | string | Да | Ветка с вашими изменениями |
base | string | Да | Ветка, в которую вливаете изменения |
body | string | Нет | Описание PR (Markdown) |
draft | boolean | Нет | Создать PR как черновик |
apiKey | string | Да | Токен API GitHub |
| Параметр | Тип | Описание |
|---|
id | number | ID запроса на слияние |
number | number | Номер pull request |
title | string | Название PR |
state | string | Статус PR |
html_url | string | URL на GitHub |
body | string | Описание PR |
user | json | Кто создал PR |
head | json | Исходная ветка |
base | json | Целевая ветка |
draft | boolean | PR — черновик |
merged | boolean | PR слит |
mergeable | boolean | PR можно слить |
created_at | string | Когда создали |
updated_at | string | Когда обновляли |
Обновить pull request
| Параметр | Тип | Обязательный | Описание |
|---|
owner | string | Да | Владелец репозитория |
repo | string | Да | Имя репозитория |
pullNumber | number | Да | Номер pull request |
title | string | Нет | Новое название PR |
body | string | Нет | Новое описание PR (Markdown) |
state | string | Нет | Новый статус (open или closed) |
base | string | Нет | Новая целевая ветка |
apiKey | string | Да | Токен API GitHub |
| Параметр | Тип | Описание |
|---|
id | number | PR ID |
number | number | Номер PR |
title | string | Название PR |
state | string | Статус PR |
html_url | string | URL на GitHub |
body | string | Описание PR |
user | json | Кто создал PR |
head | json | Исходная ветка |
base | json | Целевая ветка |
draft | boolean | PR — черновик |
merged | boolean | PR слит |
created_at | string | Когда создали |
updated_at | string | Когда обновляли |
Слить pull request
| Параметр | Тип | Обязательный | Описание |
|---|
owner | string | Да | Владелец репозитория |
repo | string | Да | Имя репозитория |
pullNumber | number | Да | Номер pull request |
commit_title | string | Нет | Заголовок коммита слияния |
commit_message | string | Нет | Дополнение к сообщению коммита слияния |
merge_method | string | Нет | Способ слияния: merge, squash или rebase |
apiKey | string | Да | Токен API GitHub |
| Параметр | Тип | Описание |
|---|
sha | string | SHA коммита слияния |
merged | boolean | Слияние удалось |
message | string | Сообщение ответа |
Список pull request
| Параметр | Тип | Обязательный | Описание |
|---|
owner | string | Да | Владелец репозитория |
repo | string | Да | Имя репозитория |
state | string | Нет | Фильтр статуса: open, closed или all |
head | string | Нет | Фильтр по автору или ветке (user:ref-name или organization:ref-name) |
base | string | Нет | Фильтр по целевой ветке |
sort | string | Нет | Сортировка: created, updated, popularity или long-running |
direction | string | Нет | Направление: asc или desc |
per_page | number | Нет | Результатов на страницу (максимум 100) |
page | number | Нет | Номер страницы |
apiKey | string | Да | Токен API GitHub |
| Параметр | Тип | Описание |
|---|
items | array | Массив pull request |
↳ id | number | PR ID |
↳ number | number | Номер PR |
↳ title | string | Название PR |
↳ state | string | Статус PR |
↳ html_url | string | URL на GitHub |
↳ user | object | Объект автора |
↳ head | object | Исходная ветка |
↳ base | object | Целевая ветка |
↳ created_at | string | Когда создали |
↳ updated_at | string | Когда обновляли |
count | number | Сколько PR вернули |
Файлы, изменённые в PR
| Параметр | Тип | Обязательный | Описание |
|---|
owner | string | Да | Владелец репозитория |
repo | string | Да | Имя репозитория |
pullNumber | number | Да | Номер pull request |
per_page | number | Нет | Результатов на страницу (максимум 100) |
page | number | Нет | Номер страницы |
apiKey | string | Да | Токен API GitHub |
| Параметр | Тип | Описание |
|---|
items | array | Массив изменённых файлов |
↳ filename | string | Путь к файлу |
↳ status | string | Статус изменения (added/modified/deleted/renamed) |
↳ additions | number | Добавлено строк |
↳ deletions | number | Удалено строк |
↳ changes | number | Всего изменений |
↳ patch | string | Патч diff файла |
↳ sha | string | SHA файла |
↳ blob_url | string | URL блоба GitHub |
↳ raw_url | string | URL сырого файла |
↳ previous_filename | string | Прежнее имя (если переименовали) |
count | number | Всего файлов |
Закрыть pull request
| Параметр | Тип | Обязательный | Описание |
|---|
owner | string | Да | Владелец репозитория |
repo | string | Да | Имя репозитория |
pullNumber | number | Да | Номер pull request |
apiKey | string | Да | Токен API GitHub |
| Параметр | Тип | Описание |
|---|
id | number | PR ID |
number | number | Номер PR |
title | string | Название PR |
state | string | Статус PR (closed) |
html_url | string | URL на GitHub |
body | string | Описание PR |
user | json | Кто создал PR |
head | json | Исходная ветка |
base | json | Целевая ветка |
draft | boolean | PR — черновик |
merged | boolean | PR слит |
closed_at | string | Когда закрыли |
created_at | string | Когда создали |
updated_at | string | Когда обновляли |
Запросить ревьюеров PR
| Параметр | Тип | Обязательный | Описание |
|---|
owner | string | Да | Владелец репозитория |
repo | string | Да | Имя репозитория |
pullNumber | number | Да | Номер pull request |
reviewers | string | Да | Логины ревьюеров через запятую |
team_reviewers | string | Нет | Слаги команд для ревью через запятую |
apiKey | string | Да | Токен API GitHub |
| Параметр | Тип | Описание |
|---|
id | number | PR ID |
number | number | Номер PR |
title | string | Название PR |
html_url | string | URL на GitHub |
requested_reviewers | array | Запрошенные ревьюеры |
requested_teams | array | Запрошенные команды |
Содержимое файла репозитория (до 1 МБ), в читаемом виде.
| Параметр | Тип | Обязательный | Описание |
|---|
owner | string | Да | Владелец репозитория (user or organization) |
repo | string | Да | Имя репозитория |
path | string | Да | Путь к файлу в репозитории (например, src/index.ts) |
ref | string | Нет | Ветка, тег или SHA (по умолчанию основная ветка) |
apiKey | string | Да | Персональный токен доступа GitHub |
| Параметр | Тип | Описание |
|---|
name | string | Имя файла |
path | string | Полный путь в репозитории |
sha | string | SHA git-блоба |
size | number | Размер файла в байтах |
type | string | Тип содержимого (file/dir/symlink/submodule) |
content | string | Декодированное содержимое файла |
encoding | string | Кодировка содержимого |
html_url | string | URL на GitHub |
download_url | string | Прямая ссылка на скачивание |
git_url | string | URL API git-блоба |
_links | json | Связанные ссылки |
Создать файл в репозитории (до 1 МБ). Содержимое кодируется в Base64.
| Параметр | Тип | Обязательный | Описание |
|---|
owner | string | Да | Владелец репозитория (user or organization) |
repo | string | Да | Имя репозитория |
path | string | Да | Путь нового файла (например, src/newfile.ts) |
message | string | Да | Сообщение коммита создания файла |
content | string | Да | Содержимое файла (обычный текст, закодируется в Base64) |
branch | string | Нет | Ветка для создания файла (по умолчанию основная) |
apiKey | string | Да | Персональный токен доступа GitHub |
| Параметр | Тип | Описание |
|---|
content | json | Данные созданного файла |
commit | json | Данные коммита |
Обновить файл. Нужен SHA. Содержимое кодируется в Base64 (до 1 МБ).
| Параметр | Тип | Обязательный | Описание |
|---|
owner | string | Да | Владелец репозитория (user or organization) |
repo | string | Да | Имя репозитория |
path | string | Да | Путь обновляемого файла (например, src/index.ts) |
message | string | Да | Сообщение коммита обновления файла |
content | string | Да | Новое содержимое (обычный текст, закодируется в Base64) |
sha | string | Да | SHA блоба заменяемого файла (из github_get_file_content) |
branch | string | Нет | Ветка для обновления файла (по умолчанию основная) |
apiKey | string | Да | Персональный токен доступа GitHub |
| Параметр | Тип | Описание |
|---|
content | json | Обновлённые данные файла |
commit | json | Данные коммита |
Удалить файл. Нужен SHA. Через API откатить нельзя.
| Параметр | Тип | Обязательный | Описание |
|---|
owner | string | Да | Владелец репозитория (user or organization) |
repo | string | Да | Имя репозитория |
path | string | Да | Путь удаляемого файла (например, src/oldfile.ts) |
message | string | Да | Сообщение коммита удаления файла |
sha | string | Да | SHA блоба удаляемого файла (из github_get_file_content) |
branch | string | Нет | Ветка, из которой удалить файл (по умолчанию основная) |
apiKey | string | Да | Персональный токен доступа GitHub |
| Параметр | Тип | Описание |
|---|
content | json | Данные файла (null при удалении) |
commit | json | Данные коммита |
Содержимое каталога: файлы и подкаталоги. Пустой путь — корень.
| Параметр | Тип | Обязательный | Описание |
|---|
owner | string | Да | Владелец репозитория (user or organization) |
repo | string | Да | Имя репозитория |
path | string | Нет | Путь каталога (например, src/components). Пусто — корень |
ref | string | Нет | Ветка, тег или SHA (по умолчанию основная ветка) |
apiKey | string | Да | Персональный токен доступа GitHub |
| Параметр | Тип | Описание |
|---|
items | array | Массив файлов и каталогов |
↳ name | string | Имя файла или каталога |
↳ path | string | Полный путь в репозитории |
↳ sha | string | SHA git-объекта |
↳ size | number | Размер в байтах |
↳ type | string | Тип (file/dir/symlink/submodule) |
↳ html_url | string | URL на GitHub |
↳ download_url | string | Прямая ссылка на скачивание |
↳ git_url | string | URL API git-блоба |
↳ url | string | URL API объекта |
↳ _links | json | Связанные ссылки |
count | number | Всего элементов |
Список веток. Можно фильтр по защите и постраничный вывод.
| Параметр | Тип | Обязательный | Описание |
|---|
owner | string | Да | Владелец репозитория (user or organization) |
repo | string | Да | Имя репозитория |
protected | boolean | Нет | Фильтр веток по защите |
per_page | number | Нет | Результатов на страницу (максимум 100, по умолчанию 30) |
page | number | Нет | Номер страницы (default 1) |
apiKey | string | Да | Персональный токен доступа GitHub |
| Параметр | Тип | Описание |
|---|
items | array | Массив веток |
↳ name | string | Имя ветки |
↳ commit | object | Коммит: sha и url |
↳ protected | boolean | Ветка защищена |
count | number | Сколько веток вернули |
Карточка ветки: коммит и защита.
| Параметр | Тип | Обязательный | Описание |
|---|
owner | string | Да | Владелец репозитория (user or organization) |
repo | string | Да | Имя репозитория |
branch | string | Да | Имя ветки |
apiKey | string | Да | Персональный токен доступа GitHub |
| Параметр | Тип | Описание |
|---|
name | string | Имя ветки |
commit | json | Объект коммита: sha, url и др. |
protected | boolean | Ветка защищена |
protection | json | Объект настроек защиты |
protection_url | string | URL настроек защиты |
Создать ветку — git-ссылка на SHA коммита.
| Параметр | Тип | Обязательный | Описание |
|---|
owner | string | Да | Владелец репозитория (user or organization) |
repo | string | Да | Имя репозитория |
branch | string | Да | Имя создаваемой ветки |
sha | string | Да | SHA коммита для ветки |
apiKey | string | Да | Персональный токен доступа GitHub |
| Параметр | Тип | Описание |
|---|
ref | string | Полное имя ссылки (refs/heads/branch) |
node_id | string | Node ID git-ссылки |
url | string | URL API ссылки |
object | json | Git-объект: тип и sha |
Удалить ветку (снять git-ссылку). Защищённые ветки удалить нельзя.
| Параметр | Тип | Обязательный | Описание |
|---|
owner | string | Да | Владелец репозитория (user or organization) |
repo | string | Да | Имя репозитория |
branch | string | Да | Имя удаляемой ветки |
apiKey | string | Да | Персональный токен доступа GitHub |
| Параметр | Тип | Описание |
|---|
deleted | boolean | Ветка удалена |
branch | string | Имя удалённой ветки |
Правила защиты ветки: проверки, ревью, ограничения.
| Параметр | Тип | Обязательный | Описание |
|---|
owner | string | Да | Владелец репозитория (user or organization) |
repo | string | Да | Имя репозитория |
branch | string | Да | Имя ветки |
apiKey | string | Да | Персональный токен доступа GitHub |
| Параметр | Тип | Описание |
|---|
url | string | URL настроек защиты |
required_status_checks | json | Требования статус-проверок |
enforce_admins | json | Применение правил к администраторам |
required_pull_request_reviews | json | Требования ревью PR |
restrictions | json | Ограничения push |
required_linear_history | json | Требование линейной истории |
allow_force_pushes | json | Настройки force push |
allow_deletions | json | Настройки удаления |
block_creations | json | Блокировка создания |
required_conversation_resolution | json | Требование закрыть обсуждение |
required_signatures | json | Требования подписи |
Обновить защиту ветки: проверки, ревью, права админов, ограничения push.
| Параметр | Тип | Обязательный | Описание |
|---|
owner | string | Да | Владелец репозитория (user or organization) |
repo | string | Да | Имя репозитория |
branch | string | Да | Имя ветки |
required_status_checks | object | Да | Обязательные проверки (null — отключить). Объект: strict и contexts |
enforce_admins | boolean | Да | Применять ограничения и к администраторам |
required_pull_request_reviews | object | Да | Требования ревью (null — отключить). Объект: required_approving_review_count, dismiss_stale_reviews, require_code_owner_reviews |
restrictions | object | Да | Ограничения push (null — отключить). Объект: users и teams (массивы строк) |
apiKey | string | Да | Персональный токен доступа GitHub |
| Параметр | Тип | Описание |
|---|
url | string | URL защиты |
required_status_checks | json | Требования статус-проверок |
enforce_admins | json | Применение правил к администраторам |
required_pull_request_reviews | json | Требования ревью PR |
restrictions | json | Ограничения push |
required_linear_history | json | Требование линейной истории |
allow_force_pushes | json | Настройки force push |
allow_deletions | json | Настройки удаления |
Создать задачу в репозитории
| Параметр | Тип | Обязательный | Описание |
|---|
owner | string | Да | Владелец репозитория |
repo | string | Да | Имя репозитория |
title | string | Да | Название задачи |
body | string | Нет | Описание задачи |
assignees | string | Нет | Исполнители через запятую |
labels | string | Нет | Метки через запятую — добавить к задаче |
milestone | number | Нет | Номер вехи для задачи |
apiKey | string | Да | Токен API GitHub |
| Параметр | Тип | Описание |
|---|
id | number | ID задачи |
number | number | Номер задачи |
title | string | Название задачи |
state | string | Статус задачи (open/closed) |
html_url | string | URL на GitHub |
body | string | Текст задачи |
user | json | Кто создал задачу |
labels | array | Массив меток |
assignees | array | Массив исполнителей |
milestone | json | Объект вехи |
created_at | string | Когда создали |
updated_at | string | Когда обновляли |
closed_at | string | Когда закрыли |
Обновить задачу
| Параметр | Тип | Обязательный | Описание |
|---|
owner | string | Да | Владелец репозитория |
repo | string | Да | Имя репозитория |
issue_number | number | Да | Номер задачи |
title | string | Нет | Новое название задачи |
body | string | Нет | Новое описание задачи |
state | string | Нет | Статус задачи (open или closed) |
labels | array | Нет | Имена меток (заменяют все текущие) |
assignees | array | Нет | Имена пользователей (заменяют исполнителей) |
apiKey | string | Да | Токен API GitHub |
| Параметр | Тип | Описание |
|---|
id | number | ID задачи |
number | number | Номер задачи |
title | string | Название задачи |
state | string | Статус задачи |
html_url | string | URL на GitHub |
body | string | Текст задачи |
user | json | Кто создал задачу |
labels | array | Массив меток |
assignees | array | Массив исполнителей |
milestone | json | Объект вехи |
created_at | string | Когда создали |
updated_at | string | Когда обновляли |
closed_at | string | Когда закрыли |
Список задач. В GitHub PR тоже считаются задачами.
| Параметр | Тип | Обязательный | Описание |
|---|
owner | string | Да | Владелец репозитория |
repo | string | Да | Имя репозитория |
state | string | Нет | Фильтр статуса: open, closed или all (по умолчанию open) |
assignee | string | Нет | Фильтр по исполнителю |
creator | string | Нет | Фильтр по автору |
labels | string | Нет | Метки через запятую для фильтра |
sort | string | Нет | Сортировка: created, updated или comments (по умолчанию created) |
direction | string | Нет | Направление: asc или desc (по умолчанию desc) |
per_page | number | Нет | Результатов на страницу (максимум 100, по умолчанию 30) |
page | number | Нет | Номер страницы (по умолчанию 1) |
apiKey | string | Да | Токен API GitHub |
| Параметр | Тип | Описание |
|---|
items | array | Массив задач GitHub |
↳ id | number | ID задачи |
↳ number | number | Номер задачи |
↳ title | string | Название задачи |
↳ state | string | Статус задачи (open/closed) |
↳ html_url | string | URL на GitHub |
↳ body | string | Текст задачи |
↳ user | object | Кто создал задачу |
↳ labels | array | Массив меток |
↳ assignees | array | Массив исполнителей |
↳ milestone | object | Объект вехи |
↳ created_at | string | Когда создали |
↳ updated_at | string | Когда обновляли |
↳ closed_at | string | Когда закрыли |
count | number | Сколько задач вернули |
Карточка задачи
| Параметр | Тип | Обязательный | Описание |
|---|
owner | string | Да | Владелец репозитория |
repo | string | Да | Имя репозитория |
issue_number | number | Да | Номер задачи |
apiKey | string | Да | Токен API GitHub |
| Параметр | Тип | Описание |
|---|
id | number | ID задачи |
number | number | Номер задачи |
title | string | Название задачи |
state | string | Статус задачи (open/closed) |
html_url | string | URL на GitHub |
body | string | Текст задачи |
user | json | Кто создал задачу |
labels | array | Массив меток |
assignees | array | Массив исполнителей |
milestone | json | Объект вехи |
comments | number | Число комментариев |
created_at | string | Когда создали |
updated_at | string | Когда обновляли |
closed_at | string | Когда закрыли |
closed_by | json | Кто закрыл задачу |
Закрыть задачу
| Параметр | Тип | Обязательный | Описание |
|---|
owner | string | Да | Владелец репозитория |
repo | string | Да | Имя репозитория |
issue_number | number | Да | Номер задачи |
state_reason | string | Нет | Причина закрытия: completed или not_planned |
apiKey | string | Да | Токен API GitHub |
| Параметр | Тип | Описание |
|---|
id | number | ID задачи |
number | number | Номер задачи |
title | string | Название задачи |
state | string | Статус задачи (closed) |
state_reason | string | Причина закрытия |
html_url | string | URL на GitHub |
body | string | Текст задачи |
user | json | Кто создал задачу |
labels | array | Массив меток |
assignees | array | Массив исполнителей |
closed_at | string | Когда закрыли |
created_at | string | Когда создали |
updated_at | string | Когда обновляли |
Добавить метки к задаче
| Параметр | Тип | Обязательный | Описание |
|---|
owner | string | Да | Владелец репозитория |
repo | string | Да | Имя репозитория |
issue_number | number | Да | Номер задачи |
labels | string | Да | Метки через запятую — добавить к задаче |
apiKey | string | Да | Токен API GitHub |
| Параметр | Тип | Описание |
|---|
items | array | Метки задачи |
↳ id | number | ID метки |
↳ name | string | Имя метки |
↳ color | string | Цвет метки |
↳ description | string | Описание метки |
count | number | Число меток |
Снять метку с задачи
| Параметр | Тип | Обязательный | Описание |
|---|
owner | string | Да | Владелец репозитория |
repo | string | Да | Имя репозитория |
issue_number | number | Да | Номер задачи |
name | string | Да | Имя метки для снятия |
apiKey | string | Да | Токен API GitHub |
| Параметр | Тип | Описание |
|---|
items | array | Оставшиеся метки задачи |
↳ id | number | ID метки |
↳ name | string | Имя метки |
↳ color | string | Цвет метки |
↳ description | string | Описание метки |
count | number | Сколько меток осталось |
Назначить исполнителей задачи
| Параметр | Тип | Обязательный | Описание |
|---|
owner | string | Да | Владелец репозитория |
repo | string | Да | Имя репозитория |
issue_number | number | Да | Номер задачи |
assignees | string | Да | Исполнители через запятую |
apiKey | string | Да | Токен API GitHub |
| Параметр | Тип | Описание |
|---|
id | number | ID задачи |
number | number | Номер задачи |
title | string | Название задачи |
state | string | Статус задачи |
html_url | string | URL на GitHub |
body | string | Текст задачи |
user | json | Автор задачи |
labels | array | Массив меток |
assignees | array | Массив исполнителей |
created_at | string | Когда создали |
updated_at | string | Когда обновляли |
Создать релиз: тег, коммит, название, описание, черновик или пререлиз.
| Параметр | Тип | Обязательный | Описание |
|---|
owner | string | Да | Владелец репозитория (user or organization) |
repo | string | Да | Имя репозитория |
tag_name | string | Да | Имя тега релиза |
target_commitish | string | Нет | Откуда создать git-тег: ветка или SHA. По умолчанию основная ветка |
name | string | Нет | Имя релиза |
body | string | Нет | Текст релиза (поддерживается Markdown) |
draft | boolean | Нет | true — черновик релиза, false — опубликовать |
prerelease | boolean | Нет | true — пререлиз, false — полный релиз |
apiKey | string | Да | Персональный токен доступа GitHub |
| Параметр | Тип | Описание |
|---|
id | number | ID релиза |
tag_name | string | Имя git-тега |
name | string | Имя релиза |
body | string | Описание релиза |
html_url | string | URL на GitHub |
tarball_url | string | URL скачивания tar |
zipball_url | string | URL скачивания zip |
draft | boolean | Это черновик |
prerelease | boolean | Это пререлиз |
author | json | Автор релиза |
assets | array | Артефакты релиза |
created_at | string | Когда создали |
published_at | string | Когда опубликовали |
Обновить релиз: тег, коммит, название, описание, черновик или пререлиз.
| Параметр | Тип | Обязательный | Описание |
|---|
owner | string | Да | Владелец репозитория (user or organization) |
repo | string | Да | Имя репозитория |
release_id | number | Да | Уникальный ID релиза |
tag_name | string | Нет | Имя тега |
target_commitish | string | Нет | Откуда создать тег (ветка или SHA) |
name | string | Нет | Имя релиза |
body | string | Нет | Текст релиза (поддерживается Markdown) |
draft | boolean | Нет | true — черновик, false — опубликовать |
prerelease | boolean | Нет | true — пререлиз, false — полный релиз |
apiKey | string | Да | Персональный токен доступа GitHub |
| Параметр | Тип | Описание |
|---|
id | number | ID релиза |
tag_name | string | Имя git-тега |
name | string | Имя релиза |
body | string | Описание релиза |
html_url | string | URL на GitHub |
tarball_url | string | URL скачивания tar |
zipball_url | string | URL скачивания zip |
draft | boolean | Это черновик |
prerelease | boolean | Это пререлиз |
created_at | string | Когда создали |
published_at | string | Когда опубликовали |
Список релизов: теги, имена, ссылки на скачивание.
| Параметр | Тип | Обязательный | Описание |
|---|
owner | string | Да | Владелец репозитория (user or organization) |
repo | string | Да | Имя репозитория |
per_page | number | Нет | Результатов на страницу (максимум 100) |
page | number | Нет | Номер страницы результатов |
apiKey | string | Да | Персональный токен доступа GitHub |
| Параметр | Тип | Описание |
|---|
items | array | Массив релизов |
↳ id | number | ID релиза |
↳ tag_name | string | Имя git-тега |
↳ name | string | Имя релиза |
↳ body | string | Описание релиза |
↳ html_url | string | URL на GitHub |
↳ tarball_url | string | URL скачивания tar |
↳ zipball_url | string | URL скачивания zip |
↳ draft | boolean | Это черновик |
↳ prerelease | boolean | Это пререлиз |
↳ author | object | Автор релиза |
↳ assets | array | Артефакты релиза |
↳ created_at | string | Когда создали |
↳ published_at | string | Когда опубликовали |
count | number | Сколько релизов вернули |
Карточка релиза по ID: артефакты и ссылки.
| Параметр | Тип | Обязательный | Описание |
|---|
owner | string | Да | Владелец репозитория (user or organization) |
repo | string | Да | Имя репозитория |
release_id | number | Да | Уникальный ID релиза |
apiKey | string | Да | Персональный токен доступа GitHub |
| Параметр | Тип | Описание |
|---|
id | number | ID релиза |
tag_name | string | Имя git-тега |
name | string | Имя релиза |
body | string | Описание релиза |
html_url | string | URL на GitHub |
tarball_url | string | URL скачивания tar |
zipball_url | string | URL скачивания zip |
draft | boolean | Это черновик |
prerelease | boolean | Это пререлиз |
author | json | Автор релиза |
assets | array | Массив артефактов релиза |
created_at | string | Когда создали |
published_at | string | Когда опубликовали |
target_commitish | string | Целевой коммит или ветка |
Удалить релиз по ID. Тег git не удаляется.
| Параметр | Тип | Обязательный | Описание |
|---|
owner | string | Да | Владелец репозитория (user or organization) |
repo | string | Да | Имя репозитория |
release_id | number | Да | ID удаляемого релиза |
apiKey | string | Да | Персональный токен доступа GitHub |
| Параметр | Тип | Описание |
|---|
deleted | boolean | Релиз удалён |
release_id | number | ID удалённого релиза |
Список workflow: ID, имя, путь, статус, URL бейджа.
| Параметр | Тип | Обязательный | Описание |
|---|
owner | string | Да | Владелец репозитория (user or organization) |
repo | string | Да | Имя репозитория |
per_page | number | Нет | Результатов на страницу (по умолчанию 30, максимум 100) |
page | number | Нет | Номер страницы (по умолчанию 1) |
apiKey | string | Да | Персональный токен доступа GitHub |
| Параметр | Тип | Описание |
|---|
total_count | number | Всего workflow |
items | array | Массив workflow |
↳ id | number | ID сценария workflow |
↳ node_id | string | Node ID сценария workflow |
↳ name | string | Имя workflow |
↳ path | string | Путь к файлу workflow |
↳ state | string | Состояние workflow |
↳ html_url | string | URL на GitHub |
↳ badge_url | string | URL бейджа |
↳ created_at | string | Когда создали |
↳ updated_at | string | Когда обновляли |
↳ deleted_at | string | Когда удалили |
Карточка workflow по ID или имени файла.
| Параметр | Тип | Обязательный | Описание |
|---|
owner | string | Да | Владелец репозитория (user or organization) |
repo | string | Да | Имя репозитория |
workflow_id | string | Да | ID workflow или имя файла (например, main.yaml) |
apiKey | string | Да | Персональный токен доступа GitHub |
| Параметр | Тип | Описание |
|---|
id | number | ID сценария workflow |
node_id | string | Node ID сценария workflow |
name | string | Имя workflow |
path | string | Путь к файлу workflow |
state | string | Состояние workflow (active/disabled) |
html_url | string | URL на GitHub |
badge_url | string | URL бейджа |
url | string | URL API |
created_at | string | Когда создали |
updated_at | string | Когда обновляли |
deleted_at | string | Когда удалили |
Запустить workflow_dispatch. У workflow должен быть этот триггер. Успех — 204.
| Параметр | Тип | Обязательный | Описание |
|---|
owner | string | Да | Владелец репозитория (user or organization) |
repo | string | Да | Имя репозитория |
workflow_id | string | Да | ID workflow или имя файла (например, main.yaml) |
ref | string | Да | Git-ссылка (ветка или тег) для запуска workflow |
inputs | object | Нет | Входные ключи и значения из файла workflow |
apiKey | string | Да | Персональный токен доступа GitHub |
| Параметр | Тип | Описание |
|---|
triggered | boolean | Workflow запущен |
workflow_id | string | ID workflow или имя файла |
ref | string | Использованная git-ссылка |
Список запусков workflow: фильтр по автору, ветке, событию, статусу.
| Параметр | Тип | Обязательный | Описание |
|---|
owner | string | Да | Владелец репозитория (user or organization) |
repo | string | Да | Имя репозитория |
actor | string | Нет | Фильтр по тому, кто запустил workflow |
branch | string | Нет | Фильтр по ветке |
event | string | Нет | Фильтр по типу события (push, pull_request, workflow_dispatch) |
status | string | Нет | Фильтр статуса (queued, in_progress, completed, waiting, requested, pending) |
per_page | number | Нет | Результатов на страницу (по умолчанию 30, максимум 100) |
page | number | Нет | Номер страницы (по умолчанию 1) |
apiKey | string | Да | Персональный токен доступа GitHub |
| Параметр | Тип | Описание |
|---|
total_count | number | Всего запусков workflow |
items | array | Массив запусков workflow |
↳ id | number | ID запуска workflow |
↳ name | string | Имя workflow |
↳ head_branch | string | Имя ветки |
↳ head_sha | string | SHA коммита |
↳ run_number | number | Номер запуска |
↳ event | string | Событие-триггер |
↳ status | string | Статус запуска |
↳ conclusion | string | Итог запуска |
↳ html_url | string | URL на GitHub |
↳ created_at | string | Когда создали |
↳ updated_at | string | Когда обновляли |
↳ triggering_actor | json | Кто запустил |
↳ pull_requests | array | Связанные pull request |
↳ referenced_workflows | array | Связанные workflow |
↳ head_commit | json | Данные головного коммита |
↳ run_started_at | string | Когда запуск начался |
Карточка запуска workflow по ID.
| Параметр | Тип | Обязательный | Описание |
|---|
owner | string | Да | Владелец репозитория (user or organization) |
repo | string | Да | Имя репозитория |
run_id | number | Да | ID запуска workflow |
apiKey | string | Да | Персональный токен доступа GitHub |
| Параметр | Тип | Описание |
|---|
id | number | ID запуска workflow |
name | string | Имя workflow |
head_branch | string | Имя ветки |
head_sha | string | SHA коммита |
run_number | number | Номер запуска |
run_attempt | number | Номер попытки запуска |
event | string | Тип события-триггера |
status | string | Статус запуска |
conclusion | string | Итог запуска |
workflow_id | number | ID сценария workflow |
html_url | string | URL на GitHub |
logs_url | string | URL скачивания логов |
jobs_url | string | URL API заданий |
artifacts_url | string | URL API артефактов |
triggering_actor | json | Кто запустил |
pull_requests | array | Связанные pull request |
referenced_workflows | array | Связанные workflow |
head_commit | json | Данные головного коммита |
run_started_at | string | Когда запуск начался |
created_at | string | Когда создали |
updated_at | string | Когда обновляли |
Отменить запуск workflow. 202 — отмена начата, 409 — уже завершён.
| Параметр | Тип | Обязательный | Описание |
|---|
owner | string | Да | Владелец репозитория (user or organization) |
repo | string | Да | Имя репозитория |
run_id | number | Да | ID запуска workflow для отмены |
apiKey | string | Да | Персональный токен доступа GitHub |
| Параметр | Тип | Описание |
|---|
cancelled | boolean | Отмена начата |
run_id | number | ID запуска workflow |
Повторить запуск workflow. Можно включить отладочные логи. Успех — 201.
| Параметр | Тип | Обязательный | Описание |
|---|
owner | string | Да | Владелец репозитория (user or organization) |
repo | string | Да | Имя репозитория |
run_id | number | Да | ID запуска workflow для повтора |
enable_debug_logging | boolean | Нет | Отладочные логи повторного запуска (по умолчанию false) |
apiKey | string | Да | Персональный токен доступа GitHub |
| Параметр | Тип | Описание |
|---|
rerun_requested | boolean | Повторный запуск запрошен |
run_id | number | ID запуска workflow |
Список проектов V2 организации или пользователя (до 20).
| Параметр | Тип | Обязательный | Описание |
|---|
owner_type | string | Да | Тип владельца: org или user |
owner_login | string | Да | Логин организации или пользователя |
apiKey | string | Да | Персональный токен доступа GitHub с правом чтения проекта |
| Параметр | Тип | Описание |
|---|
items | array | Массив проектов |
↳ id | string | Node ID проекта |
↳ title | string | Название проекта |
↳ number | number | Номер проекта |
↳ url | string | URL проекта |
↳ closed | boolean | Проект закрыт |
↳ public | boolean | Проект публичный |
↳ shortDescription | string | Краткое описание |
totalCount | number | Всего проектов |
Карточка проекта V2 по номеру.
| Параметр | Тип | Обязательный | Описание |
|---|
owner_type | string | Да | Тип владельца: org или user |
owner_login | string | Да | Логин организации или пользователя |
project_number | number | Да | Номер проекта |
apiKey | string | Да | Персональный токен доступа GitHub с правом чтения проекта |
| Параметр | Тип | Описание |
|---|
id | string | Node ID проекта |
title | string | Название проекта |
number | number | Номер проекта |
url | string | URL проекта |
closed | boolean | Проект закрыт |
public | boolean | Проект публичный |
shortDescription | string | Краткое описание |
readme | string | Readme проекта |
createdAt | string | Когда создали |
updatedAt | string | Когда обновляли |
Создать проект V2. Нужен Node ID владельца (не логин).
| Параметр | Тип | Обязательный | Описание |
|---|
owner_id | string | Да | Node ID владельца (PVT_... или MDQ6...). Берите через GraphQL API по логину |
title | string | Да | Название проекта |
apiKey | string | Да | Персональный токен доступа GitHub с правом записи проекта |
| Параметр | Тип | Описание |
|---|
id | string | Node ID проекта |
title | string | Название проекта |
number | number | Номер проекта |
url | string | URL проекта |
closed | boolean | Проект закрыт |
public | boolean | Проект публичный |
shortDescription | string | Краткое описание |
Обновить проект V2: название, описание, видимость, статус. Нужен Node ID проекта.
| Параметр | Тип | Обязательный | Описание |
|---|
project_id | string | Да | Node ID проекта (формат PVT_...) |
title | string | Нет | Новое название проекта |
shortDescription | string | Нет | Новое краткое описание проекта |
project_public | boolean | Нет | Видимость проекта (true — публичный, false — закрытый) |
closed | boolean | Нет | Статус проекта (true — закрыт, false — открыт) |
apiKey | string | Да | Персональный токен доступа GitHub с правом записи проекта |
| Параметр | Тип | Описание |
|---|
id | string | Node ID проекта |
title | string | Название проекта |
number | number | Номер проекта |
url | string | URL проекта |
closed | boolean | Проект закрыт |
public | boolean | Проект публичный |
shortDescription | string | Краткое описание |
Удалить проект V2. Необратимо. Нужен Node ID проекта.
| Параметр | Тип | Обязательный | Описание |
|---|
project_id | string | Да | Node ID проекта (формат PVT_...) |
apiKey | string | Да | Персональный токен доступа GitHub с правами администратора проекта |
| Параметр | Тип | Описание |
|---|
id | string | Node ID удалённого проекта |
title | string | Название удалённого проекта |
number | number | Номер удалённого проекта |
url | string | URL удалённого проекта |