Skip to main content

Добавление эмблемы состояния рабочего процесса

В репозитории можно отобразить эмблему состояния, чтобы обозначать состояние рабочих процессов.

Note

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

Индикатор состояния показывает, что в данный момент рабочий процесс завершается сбоем или передачей. Обычное индикатор состояния добавляется в файл README.md репозитория, но может быть добавлен на любую веб-страницу по вашему желанию. По умолчанию индикаторы показывают состояние ветви по умолчанию. Если в ветвь по умолчанию не выполняется рабочий процесс, отобразится состояние последнего запуска во всех ветвях. Состояние рабочего процесса можно отобразить для определенной ветви или события с помощью branch event параметров запроса в URL-адресе.

Снимок экрана: значок состояния рабочего процесса. Справа налево отображается логотип GitHub, имя рабочего процесса ("Демонстрация действий GitHub") и состояние ("передача").

Чтобы добавить индикатор состояния рабочего процесса в файл README.md, сначала найдите URL-адрес индикатора состояния, который нужно отобразить. После этого вы можете использовать Markdown для отображения индикатора в виде изображения в файле README.md. Дополнительные сведения о разметке изображений в Markdown см. в разделе Базовый синтаксис записи и форматирования.

Использование пользовательского интерфейса

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

  1. На GitHubперейдите на главную страницу репозитория.

  2. Под именем репозитория щелкните Actions.

    Снимок экрана: вкладки для репозитория github/docs. Вкладка "Действия" выделена оранжевым контуром.

  3. На левой боковой панели щелкните нужный рабочий процесс.

    Снимок экрана: левая боковая панель вкладки "Действия". Рабочий процесс CodeQL описывается в темно-оранжевый цвет.

  4. В правой части страницы рядом с полем "Фильтрация выполнения рабочего процесса" щелкните (Показать параметры рабочего процесса), чтобы отобразить раскрывающееся меню и нажмите кнопку "Создать значок состояния".

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

  6. При необходимости выберите событие, которое активирует рабочий процесс.

  7. Щелкните Copy status badge Markdown.

  8. Скопируйте Markdown в README.md файл.

Использование имени файла рабочего процесса

Вы можете создать 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)