PEP8 Speaker позволяет отслеживать корректность Python кода относительно правил оформления PEP8.
В проекте, по решению команды, могут быть определены отступления от классических правил PEP8, например, допустимая длина строки кода может быть увеличена с 79 символов до 100 или 120 символов. Некоторые правила PEP8 могут быть игнорированы.
Все необходимые настройки PEP8 Speaker должны быть прописаны в манифесте бота (конфигурационном файле), а сам файл с названием .pep8speaks.yml добавлен в ваш проект. Вы можете полностью скопировать конфигурации, что описаны по ссылке выше, однако допускается использовать и упрощенную конфигурацию, как в данном проекте.
- Перейти на главную страницу бота;
- Нажать на кнопку
Configure - Выбрать репозиторий, для которого вы хотите активировать PEP8 Speaker (помните, что вы должны обладать правами администратора в добавляемом проекте)
- В корневую директорию проекта необходимо добавить манифест
.pep8speaks.ymlс настройками, которые вы сами определите (или скопируете стандартрые настройки из примера)
При использовании оригинального бота вам не гарантируется сохранение приватности кода. В случае, когда вам это необходимо, вы можете воспользоваться ботом, расположенным на выделенном сервере ИТМО. Для этого, вам необходимо выполнить несколько действий:
Пригласите бота в репозиторий (Пункт актуален только для приватных репозиториев):
- Убедитесь, что у вас есть статус Maintainer или Owner для репозитория или группы. Если такового нет, то попросите администратора изменить статус.
- Перейдите во вкладку
Settings - В левом меню выберете
Collaborators - Нажмите на кнопку
Add people - В появившемся окне введите
aim-pep8-botи выберете его - Нажмите
Add aim-pep8-bot to this repository - Дождитесь, пока бот примет приглашение (примерно час)
Важно отметить, что бот должен иметь права доступа ко всем репозиториям, для которых вы хотите использовать сервис. В случае если Pull Request создается из секретного форка секретного репозитория, бот должен быть добавлен и в этот форк, чтобы получить diff PR.
Настройте Github Actions:
- Убедитесь, что у вас есть статус Maintainer или Owner для репозитория или группы. Если такового нет, то попросите администратора изменить статус.
- Перейдите во вкладку
Settings - В левом меню выберете
Webhooks - Справа сверху нажмите
Add webhook - В
Payload URLвставьтеhttps://automation.nsslab.onti.actcognitive.org - В поле
Content typeвыберетеapplication/json - Поле
Secretоставьте пустым - Далее в разделе
Which events would you like to trigger this webhook?выберетеLet me select individual events. - Выставите галочку на
Pull requestsи уберите сPushes - Поставьте галочку
Activeи нажмите на кнопкуAdd webhook
CodeCov - это инструмент, предоставляющий метрики и информацию о результатах тестов с помощью отчетов о покрытии кода. Отчеты о покрытии используются для определения того, какие строки кода были протестированы, а какие нет, а также возмжное наличие ошибок в коде.
CodeCov формирует отчет внутри Pull Request после каждого коммита, что позволяет просматривать статистику на каждом этапе работы над проектом.
- Интегрировать инструмент в репозиторий по инструкции (обратите внимание, что для настройки в GitHub существует дополнительный раздел)
- Добавить в репозиторий манифест
.codecov.yml. CodeCov обладает большим набором статистик и метрик, которые могут отображаться в отчете, выбрать необходимые для своего проекта можно среди наиболее популярных. Пример упрощенного файла с конфигурациями можно найти по ссылке.