diff --git a/docs/dist/docs/ru-guide/ci-cd/github-actions.md b/docs/dist/docs/ru-guide/ci-cd/github-actions.md index 8537f09e..efb6832c 100644 --- a/docs/dist/docs/ru-guide/ci-cd/github-actions.md +++ b/docs/dist/docs/ru-guide/ci-cd/github-actions.md @@ -49,7 +49,7 @@ jobs: - name: Verify EasyP version run: | which easyp - easyp version + easyp --version - name: Lint run: easyp lint @@ -367,7 +367,7 @@ easyp generate -v - name: Debug environment run: | env | sort - easyp version + easyp --version ``` ## Переменные окружения (примерно) diff --git a/docs/dist/docs/ru-guide/ci-cd/gitlab.md b/docs/dist/docs/ru-guide/ci-cd/gitlab.md index c350e983..3c72f747 100644 --- a/docs/dist/docs/ru-guide/ci-cd/gitlab.md +++ b/docs/dist/docs/ru-guide/ci-cd/gitlab.md @@ -27,7 +27,7 @@ validate: before_script: - go install github.com/easyp-tech/easyp/cmd/easyp@latest - echo "EasyP version:" - - easyp version + - easyp --version # При необходимости: git fetch --all --tags script: - easyp lint diff --git a/docs/public/docs/ru-guide/ci-cd/github-actions.md b/docs/public/docs/ru-guide/ci-cd/github-actions.md index 8537f09e..be13a10f 100644 --- a/docs/public/docs/ru-guide/ci-cd/github-actions.md +++ b/docs/public/docs/ru-guide/ci-cd/github-actions.md @@ -5,6 +5,7 @@ ## Зачем использовать EasyP в CI Встраивание EasyP в GitHub Actions даёт: + - Единообразие правил линтинга и генерации между разработчиками. - Автоматическое выявление несовместимых изменений (breaking changes) до мержа. - Гарантию, что сгенерированный код не «устарел» относительно .proto. @@ -49,7 +50,7 @@ jobs: - name: Verify EasyP version run: | which easyp - easyp version + easyp --version - name: Lint run: easyp lint @@ -61,6 +62,7 @@ jobs: ## Установка EasyP Варианты: + 1. Через `go install` (как в примере выше). 2. Использование заранее собранного бинаря (артефакт релиза). @@ -74,6 +76,7 @@ jobs: ## Кэширование Для ускорения повторных сборок можно кэшировать: + - Go модульный кеш (если используете генерацию с плагинами Go). - Внешние зависимые Git-клонирования (папки `vendor` или содержимое `deps` при использовании `easyp mod download` / `easyp mod update`). - Сгенерированный код (если он тяжёлый, но чаще генерируется заново). @@ -115,6 +118,7 @@ easyp lint ``` Рекомендуется: + - В PR: всегда запускать. - На main: можно запускать для верификации перед релизом. @@ -132,6 +136,7 @@ easyp lint EasyP может сравнивать текущее состояние против ветки / коммита / тега. Примеры: + ```bash # Сравнить против origin/main easyp breaking --against git-ref=origin/main @@ -163,11 +168,13 @@ Workflow шаг: ## Генерация кода Обычно для генерации: + ```bash easyp generate ``` Если нужно явно указать конфиг: + ```bash easyp --cfg easyp.yaml generate ``` @@ -356,6 +363,7 @@ jobs: ## Отладка Если нужно больше логов: + ```bash easyp lint -v easyp breaking -v --against git-ref=origin/main @@ -363,11 +371,12 @@ easyp generate -v ``` Добавьте вывод окружения для диагностики: + ```yaml - name: Debug environment run: | env | sort - easyp version + easyp --version ``` ## Переменные окружения (примерно) diff --git a/docs/public/docs/ru-guide/ci-cd/gitlab.md b/docs/public/docs/ru-guide/ci-cd/gitlab.md index c350e983..9446e1ca 100644 --- a/docs/public/docs/ru-guide/ci-cd/gitlab.md +++ b/docs/public/docs/ru-guide/ci-cd/gitlab.md @@ -4,6 +4,7 @@ Документация по интеграции EasyP с GitLab CI находится в процессе подготовки. Планируемые разделы: + - Быстрый старт (пример `.gitlab-ci.yml` для линтинга и проверки несовместимых изменений) - Кэширование зависимостей и ускорение сборок - Генерация кода и проверка актуальности артефактов @@ -27,7 +28,7 @@ validate: before_script: - go install github.com/easyp-tech/easyp/cmd/easyp@latest - echo "EasyP version:" - - easyp version + - easyp --version # При необходимости: git fetch --all --tags script: - easyp lint