Рабочие процессы

Используйте REST API для взаимодействия с рабочими процессами в GitHub Actions.

Сведения о рабочих процессах в GitHub Actions

С помощью REST API можно просматривать рабочие процессы для репозитория в GitHub Actions. Рабочие процессы автоматизируют жизненный цикл разработки программного обеспечения, используя широкий ряд инструментов и служб. Дополнительные сведения см. в разделе Документация по GitHub Actions.

Эти конечные точки доступны для пользователей, прошедших проверку подлинности, OAuth Apps и GitHub Apps. Маркерам доступа требуется repo область для закрытых репозиториев и public_repo область для репозиториев public. GitHub Apps должно иметь разрешение на actions использование этих конечных точек.

List repository workflows

Работа с GitHub Apps

Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.

Параметры для "List repository workflows"

Заголовки
Имя, Тип, Описание
`accept` string Setting to `application/vnd.github+json` is recommended.
Параметры пути
Имя, Тип, Описание
`owner` string Обязательно The account owner of the repository. The name is not case sensitive.
`repo` string Обязательно The name of the repository. The name is not case sensitive.
Параметры запроса
Имя, Тип, Описание
`per_page` integer The number of results per page (max 100). Значение по умолчанию: `30`
`page` integer Page number of the results to fetch. Значение по умолчанию: `1`

Коды состояния HTTP-ответа для "List repository workflows"

Код состояния	Описание
`200`	OK

Примеры кода для "List repository workflows"

get/repos/{owner}/{repo}/actions/workflows

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/actions/workflows

Response

Status: 200

{
  "total_count": 2,
  "workflows": [
    {
      "id": 161335,
      "node_id": "MDg6V29ya2Zsb3cxNjEzMzU=",
      "name": "CI",
      "path": ".github/workflows/blank.yaml",
      "state": "active",
      "created_at": "2020-01-08T23:48:37.000-08:00",
      "updated_at": "2020-01-08T23:50:21.000-08:00",
      "url": "https://HOSTNAME/repos/octo-org/octo-repo/actions/workflows/161335",
      "html_url": "https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335",
      "badge_url": "https://github.com/octo-org/octo-repo/workflows/CI/badge.svg"
    },
    {
      "id": 269289,
      "node_id": "MDE4OldvcmtmbG93IFNlY29uZGFyeTI2OTI4OQ==",
      "name": "Linter",
      "path": ".github/workflows/linter.yaml",
      "state": "active",
      "created_at": "2020-01-08T23:48:37.000-08:00",
      "updated_at": "2020-01-08T23:50:21.000-08:00",
      "url": "https://HOSTNAME/repos/octo-org/octo-repo/actions/workflows/269289",
      "html_url": "https://github.com/octo-org/octo-repo/blob/master/.github/workflows/269289",
      "badge_url": "https://github.com/octo-org/octo-repo/workflows/Linter/badge.svg"
    }
  ]
}

Get a workflow

Работа с GitHub Apps

Gets a specific workflow. You can replace workflow_id with the workflow file name. For example, you could use main.yaml. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.

Параметры для "Get a workflow"

Заголовки
Имя, Тип, Описание
`accept` string Setting to `application/vnd.github+json` is recommended.
Параметры пути
Имя, Тип, Описание
`owner` string Обязательно The account owner of the repository. The name is not case sensitive.
`repo` string Обязательно The name of the repository. The name is not case sensitive.
`workflow_id` Обязательно The ID of the workflow. You can also pass the workflow file name as a string.

Коды состояния HTTP-ответа для "Get a workflow"

Код состояния	Описание
`200`	OK

Примеры кода для "Get a workflow"

get/repos/{owner}/{repo}/actions/workflows/{workflow_id}

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/actions/workflows/WORKFLOW_ID

Response

Status: 200

{
  "id": 161335,
  "node_id": "MDg6V29ya2Zsb3cxNjEzMzU=",
  "name": "CI",
  "path": ".github/workflows/blank.yaml",
  "state": "active",
  "created_at": "2020-01-08T23:48:37.000-08:00",
  "updated_at": "2020-01-08T23:50:21.000-08:00",
  "url": "https://HOSTNAME/repos/octo-org/octo-repo/actions/workflows/161335",
  "html_url": "https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335",
  "badge_url": "https://github.com/octo-org/octo-repo/workflows/CI/badge.svg"
}

Disable a workflow

Работа с GitHub Apps

Disables a workflow and sets the state of the workflow to disabled_manually. You can replace workflow_id with the workflow file name. For example, you could use main.yaml.

You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint.

Параметры для "Disable a workflow"

Заголовки
Имя, Тип, Описание
`accept` string Setting to `application/vnd.github+json` is recommended.
Параметры пути
Имя, Тип, Описание
`owner` string Обязательно The account owner of the repository. The name is not case sensitive.
`repo` string Обязательно The name of the repository. The name is not case sensitive.
`workflow_id` Обязательно The ID of the workflow. You can also pass the workflow file name as a string.

Коды состояния HTTP-ответа для "Disable a workflow"

Код состояния	Описание
`204`	No Content

Примеры кода для "Disable a workflow"

put/repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable

curl -L \
  -X PUT \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/actions/workflows/WORKFLOW_ID/disable

Response

Status: 204

Create a workflow dispatch event

Работа с GitHub Apps

You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace workflow_id with the workflow file name. For example, you could use main.yaml.

You must configure your GitHub Actions workflow to run when the workflow_dispatch webhook event occurs. The inputs are configured in the workflow file. For more information about how to configure the workflow_dispatch event in the workflow file, see "Events that trigger workflows."

You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint. For more information, see "Creating a personal access token for the command line."

Параметры для "Create a workflow dispatch event"

Заголовки
Имя, Тип, Описание
`accept` string Setting to `application/vnd.github+json` is recommended.
Параметры пути
Имя, Тип, Описание
`owner` string Обязательно The account owner of the repository. The name is not case sensitive.
`repo` string Обязательно The name of the repository. The name is not case sensitive.
`workflow_id` Обязательно The ID of the workflow. You can also pass the workflow file name as a string.
Параметры запроса
Имя, Тип, Описание
`ref` string Обязательно The git reference for the workflow. The reference can be a branch or tag name.
`inputs` object Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when `inputs` are omitted.

Коды состояния HTTP-ответа для "Create a workflow dispatch event"

Код состояния	Описание
`204`	No Content

Примеры кода для "Create a workflow dispatch event"

post/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/actions/workflows/WORKFLOW_ID/dispatches \
  -d '{"ref":"topic-branch","inputs":{"name":"Mona the Octocat","home":"San Francisco, CA"}}'

Response

Status: 204

Enable a workflow

Работа с GitHub Apps

Enables a workflow and sets the state of the workflow to active. You can replace workflow_id with the workflow file name. For example, you could use main.yaml.

You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint.

Параметры для "Enable a workflow"

Заголовки
Имя, Тип, Описание
`accept` string Setting to `application/vnd.github+json` is recommended.
Параметры пути
Имя, Тип, Описание
`owner` string Обязательно The account owner of the repository. The name is not case sensitive.
`repo` string Обязательно The name of the repository. The name is not case sensitive.
`workflow_id` Обязательно The ID of the workflow. You can also pass the workflow file name as a string.

Коды состояния HTTP-ответа для "Enable a workflow"

Код состояния	Описание
`204`	No Content

Примеры кода для "Enable a workflow"

put/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable

curl -L \
  -X PUT \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/actions/workflows/WORKFLOW_ID/enable

Response

Status: 204