Статус-бейдж workflow

Info

Статус-бейдж — это миниатюрная плашка, которая показывает актуальный статус выполнения workflow. Обычно бейдж размещают в файле README.md репозитория, но его можно вставить в любую веб-страницу, поддерживающую Markdown или HTML.

Как работает статус-бейдж

Бейдж отображает два блока: название workflow (поле name из YAML-файла, а при его отсутствии — имя файла workflow) и статус последней проверки с цветовой индикацией.

Поведение бейджа по умолчанию:

  • отображается статус последней проверки на ветке по умолчанию репозитория;
  • если на ветке по умолчанию нет ни одного запуска, бейдж показывает статус последнего запуска по всем веткам;
  • если запусков workflow нет вовсе, бейдж отображает серый статус «нет статуса».

Создание бейджа через интерфейс

Самый простой способ получить готовый Markdown-код бейджа — создать его через интерфейс CI/CD:

  1. Откройте страницу репозитория и перейдите во вкладку CI/CD.

  2. В списке workflow слева выберите нужный workflow.

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

  4. В открывшемся окне при необходимости измените:

    • ветка — если не задана, используется ветка по умолчанию репозитория;
    • событие — по умолчанию «Все события», можно выбрать конкретное триггерное событие workflow;
    • язык — язык текста статуса на бейдже (русский или английский).

  5. Нажмите «Скопировать markdown» и вставьте скопированный код в ваш README.md.

Info

Сгенерированный через интерфейс Markdown оборачивает изображение бейджа в ссылку вида https://gitverse.ru/OWNER/REPO/cicd?workflow=WORKFLOW-FILE&workflowName=NAME: по клику на бейдж пользователь попадает на страницу CI/CD выбранного workflow.

Сборка ссылки вручную

Ссылка на бейдж состоит из трех частей:

[![название](картинка бейджа)](ссылка на CI/CD)
  • название — отображаемое название workflow: workflowName, если он указан; иначе name (поле YAML-файла); если и его нет — имя файла workflow (например, main.yml);
  • картинка бейджа — https://gitverse.ru/api/repos/OWNER/REPO/actions/workflows/WORKFLOW-FILE/badge.svg, где OWNER — владелец, REPO — репозиторий, WORKFLOW-FILE — имя файла workflow (например, main.yml для файла .gitverse/workflows/main.yml);
  • ссылка на CI/CD — https://gitverse.ru/OWNER/REPO/cicd?workflow=WORKFLOW-FILE&workflowName=НАЗВАНИЕ, страница CI/CD выбранного workflow: по клику на бейдж пользователь попадает в CI/CD этого workflow.

Готовая ссылка для workflow с файлом test.yml (название Tests) в репозитории OWNER/docs:

[![Tests](https://gitverse.ru/api/repos/OWNER/docs/actions/workflows/test.yml/badge.svg)](https://gitverse.ru/OWNER/docs/cicd?workflow=test.yml&workflowName=Tests)

Параметр branch

Чтобы показать статус последней проверки workflow на конкретной ветке, добавьте к URL бейджа параметр ?branch=BRANCH-NAME.

Например, чтобы показать статус workflow на ветке feature-1:

[![Tests](https://gitverse.ru/api/repos/OWNER/docs/actions/workflows/test.yml/badge.svg?branch=feature-1)](https://gitverse.ru/OWNER/docs/cicd?workflow=test.yml&workflowName=Tests)

Info

Если для явно указанной ветки запусков workflow нет, бейдж покажет статус «нет статуса» (в отличие от поведения по умолчанию, когда используется последний запуск по всем веткам).

Параметр event

Чтобы показать статус проверок, запущенных конкретным событием, добавьте к URL бейджа параметр ?event=EVENT.

Например, чтобы показать статус сборок, запущенных событием push:

[![Tests](https://gitverse.ru/api/repos/OWNER/docs/actions/workflows/test.yml/badge.svg?event=push)](https://gitverse.ru/OWNER/docs/cicd?workflow=test.yml&workflowName=Tests)

Параметры branch и event можно использовать одновременно через &:

[![Tests](https://gitverse.ru/api/repos/OWNER/docs/actions/workflows/test.yml/badge.svg?branch=feature-1&event=push)](https://gitverse.ru/OWNER/docs/cicd?workflow=test.yml&workflowName=Tests)

Параметр lang

Параметр ?lang=LANG управляет языком текста статуса на бейдже: ru (русский) или en (английский). Без параметра язык по умолчанию — английский.

Например:

[![Tests](https://gitverse.ru/api/repos/OWNER/docs/actions/workflows/test.yml/badge.svg?lang=ru)](https://gitverse.ru/OWNER/docs/cicd?workflow=test.yml&workflowName=Tests)

Info

Бейджи, созданные через интерфейс, автоматически содержат параметр lang, соответствующий выбранному в окне Создать статус-бейдж языку.

Warning

Бейджи приватных репозиториев доступны только аутентифицированным пользователям с доступом к CI/CD, поэтому встраивать или ссылаться на них из внешних страниц не имеет смысла. Для публичных репозиториев бейдж доступен без аутентификации.

Вид графа

Связанные страницы