Название проекта: set-badge

Описание проекта

Скрипт запускающийся во время выполнения pipeline и проставляющий необходимые badge

Список задач для улучшений

Список задач

Описание параметров

--id {ID} # ID проекта
--default-branch # Добавить бейдж default ветки
--last-release # Добавить бейдж последнего релиза
--pipeline-status # Добавить бейдж статуса последнего pipeline
--last-tag # Добавить бейдж с последним тэгом
--coverage-report # Добавить бейдж с покрытием тестами

Описание переменных окружения

Правила наименования переменных: DYNACONF_{NAME}={variable}

Блок [.env.example]

Краткое описание переменных и где их взять.

DYNACONF_GITLAB_TOKEN - токен для доступа к API gitlab
DYNACONF_GITLAB_URL - ссылка на домен gitlab

Развертывание

• Установить зависимости

poetry install

• Установить pre-commit хуки

poetry run pre-commit install
poetry run pre-commit install --hook-type commit-msg

• Для работы линтера gitlab-ci.yml

1. Создать токен в своем аккаунте gitlab
2. Добавить в переменные оболочки:

echo "GITLAB_TOKEN={TOKEN} >> .bashrc"
===
echo "GITLAB_TOKEN={TOKEN} >> .zshrc"
===
export "GITLAB_TOKEN={TOKEN}"

• Запустить тесты

poetry run pytest

Соглашение по формату сообщения коммита

Conventional Commits

<Вид>(<Задача в yandex.tracker>): <Описание>

Видом может быть:

• feat - Фича, новая функицональность
• fix - Исправление
• chore - Не связанные с кодом/незначительные изменения
• docs - Документация
• refactor - Рефакторинг
• ci - Правки в CI
• test - Правки тестов

Пример текста для коммита: chore(DEVOPS-123): обновил readme