Описание CI/CD Pipeline

Общее описание

Pipeline проекта расположен в папке .github/workflows и содержит: - Файл deploy.yml, которые запускает автоматизированный процесс сборки и публикации статического сайта Github Pages для репозитория. - Файл validate-structure.yml, который запускает автоматизированный процесс проверки структуры проекта,

Проверка структуры проекта

При проверке структуры проекта проверяется наличие папок contents/, docs/, а также основного файла документации README.md В случае отсутствия одного из указанных файлов происходит выход из программы запуска pipeline с ошибкой и соответствующим комментарием

Сборка документации

Для реализации генерации статического сайта документации применяется сервис Mkdocs.