Выполнение анализа кода и модульного тестирования

Завершено

GitHub Actions можно использовать для автоматизации задач, запускаемых событиями. Чтобы запускать проверки качества кода при создании запроса на вытягивание, вам потребуется:

• Проверка кода с помощью анализаторов кода и модульных тестов.
• Интеграция проверок кода с запросами на вытягивание.

Проверка кода

Существует два распространенных типа проверок кода: анализатор кода и модульный тест.

С помощью анализаторов кода можно проверить, соответствует ли код рекомендациям по качеству, заданным в вашей организации. Например, чтобы создать код с помощью Flake8, вы создадите файл конфигурации .flake8, содержащий правила, которых должен придерживаться код.

Чтобы проверить, работает ли код должным образом, можно создать модульные тесты. Чтобы легко протестировать определенные части кода, скрипты должны содержать функции. Вы можете протестировать функции в скриптах, создав тестовые файлы. Популярное средство для тестирования Python кода — Pytest.

Совет

Узнайте больше о том, как выполнять модульные тесты с помощью Pytest.

Чтобы проверить код с помощью GitHub Actions вам потребуется выполнить следующие действия:

• Установка инструмента (Flake8 или Pytest).
• Запуск тестов путем указания папок в репозитории, которые необходимо проверить.

Совет

Вы можете автоматически проверить код с помощью GitHub Actions или сделать это вручную в Visual Studio Code. Узнайте больше о том, как проверить код локально.

Интеграция проверок кода с запросами на вытягивание.

Чтобы активировать рабочий процесс GitHub Actions при создании запроса на вытягивание, можно использовать on: pull_request.

Убедитесь, что слияние запроса на вытягивание возможно только после прохождения всех проверок качества.

Чтобы интегрировать проверки кода с запросами на вытягивание, предназначенными для основной ветви, необходимо сделать следующее:

1. Перейдите на вкладку Параметры в репозитории.
2. Выбор Ветвей.
3. Включите параметр Требовать прохождение проверок состояния перед слиянием в правиле защиты основной ветви.

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

Примечание.

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