docs: обновлена документация и help для линтинга ролей
Some checks failed
Ansible Testing / lint (push) Has been cancelled
Ansible Testing / test (default) (push) Has been cancelled
Ansible Testing / test (minimal) (push) Has been cancelled
Ansible Testing / test (performance) (push) Has been cancelled
Ansible Testing / deploy-check (push) Has been cancelled

- Обновлена основная справка make help с примерами использования
- Добавлена подробная справка по линтингу в make role
- Создана документация docs/linting-guide.md с полным руководством
- Обновлен README.md с примерами команд линтинга
- Добавлена ссылка на новую документацию в секции разработки

Новая документация включает:
- Команды линтинга (все роли и конкретные)
- Профили линтинга (production, basic, min)
- Типы ошибок и способы исправления
- Интеграция с CI/CD
- Лучшие практики и устранение неполадок
This commit is contained in:
Сергей Антропов
2025-10-25 20:44:51 +03:00
parent b315bc6b14
commit 34e0cbd570
3 changed files with 253 additions and 5 deletions

View File

@@ -147,7 +147,11 @@ role:
echo " 💡 Использует: ansible-lint"; \
echo " 💡 Без параметра: проверяет все роли"; \
echo " 💡 С параметром: проверяет конкретную роль"; \
echo " 💡 Примеры: make role lint, make role lint devops"; \
echo " 💡 Валидация: показывает доступные роли при ошибке"; \
echo " 💡 Примеры:"; \
echo " make role lint # проверить все роли"; \
echo " make role lint devops # проверить только devops"; \
echo " make role lint ping # проверить только ping"; \
echo ""; \
echo " 📋 make role list - показать все роли"; \
echo " 💡 Показывает: список всех ролей в roles/"; \
@@ -160,7 +164,14 @@ role:
echo " 🗑️ make role delete - удалить роль"; \
echo " 💡 Интерактивно: запрашивает имя роли"; \
echo " 💡 Удаляет: папку роли и файлы"; \
echo " 💡 Обновляет: roles/deploy.yml";; \
echo " 💡 Обновляет: roles/deploy.yml"; \
echo ""; \
echo " 🔧 ДОПОЛНИТЕЛЬНАЯ ИНФОРМАЦИЯ О ЛИНТИНГЕ:"; \
echo " 💡 Линтинг проверяет: синтаксис, стиль, лучшие практики"; \
echo " 💡 Профили: production, basic, min"; \
echo " 💡 Конфигурация: .ansible-lint"; \
echo " 💡 Ошибки: показываются с номерами строк"; \
echo " 💡 Валидация: автоматическая проверка существования роли";; \
esac
# =============================================================================
@@ -948,15 +959,23 @@ help:
@echo " dockerfiles/ - Docker образы для тестирования"
@echo ""
@echo "🚀 ОСНОВНЫЕ КОМАНДЫ:"
@echo " make role lint [role] - проверить синтаксис ролей (все или конкретную)"
@echo " make role lint [role] - проверить синтаксис ролей (все или конкретную)"
@echo " 💡 Примеры: make role lint, make role lint devops"
@echo " make role test [preset] - протестировать роли с preset'ом"
@echo " make role deploy - развернуть роли на реальные серверы"
@echo " make role list - показать все роли"
@echo " make role create - создать новую роль (интерактивно)"
@echo " make role delete - удалить роль (интерактивно)"
@echo ""
@echo "📖 ДОКУМЕНТАЦИЯ ПО DEPLOY.YML:"
@echo "📖 ДОКУМЕНТАЦИЯ:"
@echo " docs/deploy-yml-customization.md - полное руководство по кастомизации"
@echo " docs/linting-guide.md - руководство по линтингу ролей"
@echo ""
@echo "🔍 ЛИНТИНГ РОЛЕЙ:"
@echo " make role lint [role] - проверить синтаксис (все или конкретную роль)"
@echo " 💡 Профили: production, basic, min"
@echo " 💡 Конфигурация: .ansible-lint"
@echo " 💡 Валидация: автоматическая проверка существования роли"
@echo ""
@echo "📋 PRESET'Ы (тестовые окружения):"
@echo " make presets list - показать все доступные preset'ы"