Примечание. Индикаторы рабочих процессов в частном репозитории недоступны извне, поэтому вы не сможете внедрить их или указать ссылку на них с внешнего сайта.
Индикатор состояния показывает, что в данный момент рабочий процесс завершается сбоем или передачей. Обычное индикатор состояния добавляется в файл README.md
репозитория, но может быть добавлен на любую веб-страницу по вашему желанию. По умолчанию индикаторы показывают состояние ветви по умолчанию. Если в ветвь по умолчанию не выполняется рабочий процесс, отобразится состояние последнего запуска во всех ветвях. Состояние рабочего процесса можно отобразить для определенной ветви или события с помощью branch
event
параметров запроса в URL-адресе.
Чтобы добавить индикатор состояния рабочего процесса в файл README.md
, сначала найдите URL-адрес индикатора состояния, который нужно отобразить. После этого вы можете использовать Markdown для отображения индикатора в виде изображения в файле README.md
. Дополнительные сведения о разметке изображений в Markdown см. в разделе "Базовый синтаксис записи и форматирования".
Использование имени файла рабочего процесса
Вы можете создать URL-адрес для индикатора состояния рабочего процесса, используя имя файла рабочего процесса:
https://github.com/OWNER/REPOSITORY/actions/workflows/WORKFLOW-FILE/badge.svg
Чтобы отобразить индикатор состояния рабочего процесса в файле README.md
, используйте разметку Markdown для внедрения изображений. Дополнительные сведения о разметке изображений в Markdown см. в разделе "Базовый синтаксис записи и форматирования".
Например, вставьте приведенный ниже код Markdown в файл README.md
, чтобы добавить индикатор состояния для рабочего процесса с путем к файлу .github/workflows/main.yml
. Владелец (OWNER
) репозитория — организация github
, а имя REPOSITORY
— docs
.
![example workflow](https://github.com/github/docs/actions/workflows/main.yml/badge.svg)
Использование параметра branch
Чтобы отобразить состояние выполнения рабочего процесса для определенной ветви, добавьте ?branch=BRANCH-NAME
в конец URL-адреса индикатора состояния.
Например, вставьте приведенный ниже код Markdown в файл README.md
, чтобы добавить индикатор состояния для ветви с именем feature-1
.
![example branch parameter](https://github.com/github/docs/actions/workflows/main.yml/badge.svg?branch=feature-1)
Использование параметра event
Чтобы отобразить состояние выполнения рабочего процесса, активированного событием push
, добавьте ?event=push
в конец URL-адреса индикатора состояния.
Например, добавьте следующий код Markdown в файл README.md
, чтобы отобразить индикатор с состоянием выполнения рабочего процесса, активированного событием push
. В результате отобразится состояние сборки для текущего состояния этой ветви.
![example event parameter](https://github.com/github/docs/actions/workflows/main.yml/badge.svg?event=push)