From bac2f93a25b7088f9d67d7b7fd97d76f6b180390 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9CNaeel=E2=80=9D?= Date: Mon, 11 May 2026 07:22:08 +0400 Subject: [PATCH] =?UTF-8?q?=D0=94=D0=BE=D0=B1=D0=B0=D0=B2=D0=BB=D0=B5?= =?UTF-8?q?=D0=BD=20=D1=84=D0=B0=D0=B9=D0=BB=20pravila.md=20(=D0=B0=D0=B4?= =?UTF-8?q?=D0=B0=D0=BF=D1=82=D0=B0=D1=86=D0=B8=D1=8F=20=D0=BF=D0=BE=D0=B4?= =?UTF-8?q?=20IoT)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/pravila.md | 99 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 99 insertions(+) create mode 100644 .github/pravila.md diff --git a/.github/pravila.md b/.github/pravila.md new file mode 100644 index 0000000..3e85b0a --- /dev/null +++ b/.github/pravila.md @@ -0,0 +1,99 @@ +# Правила работы агента + +## ⛔⛔⛔ DOCKER — ОБЯЗАТЕЛЬНЫЙ ПОРЯДОК ПЕРЕД КАЖДЫМ BUILD + +1. УВЕЛИЧИТЬ ТЕГ в `deployments/k8s/iot-console.yaml` (vX.Y.Z → vX.Y.Z+1) +2. rsync на ВМ +3. ПРОВЕРИТЬ что файлы на ВМ новые (grep ключевой строки) +4. docker build с НОВЫМ тегом +5. docker push с НОВЫМ тегом +6. kubectl apply (не rollout restart — apply подтягивает новый тег) + +**НИКОГДА не делать `docker build` со старым тегом — под не перетянет образ (imagePullPolicy: IfNotPresent)** + +## Файловая система (актуально) + +1. Все файлы редактируются локально: `~/IoT` +2. После любых изменений — обязательно rsync на ВМ: + rsync -az \ + -e "ssh -i ~/.ssh/naeel_vm_id_ed25519 -o StrictHostKeyChecking=no -o ConnectTimeout=10" \ + ~/IoT/ \ + naeel@5.172.178.213:~/terra/IoT/ + +3. Git (add/commit/push) выполнять ЛОКАЛЬНО в ~/IoT +4. Docker, kubectl и другие инфраструктурные команды — только через SSH на ВМ +5. Перед запуском любой команды на ВМ обязательно убедиться, что синхронизация (rsync) выполнена +6. SCP, sshfs, remote_dev и маунты больше НЕ используются +7. Только rsync для синхронизации + +Пример: +1. Редактируешь локально +2. rsync на ВМ +3. Выполняешь команды через SSH на ВМ + +## SSH + +Все команды — только через SSH на ВМ. Локально — только читать и редактировать файлы. + +```bash +ssh -i ~/.ssh/naeel_vm_id_ed25519 -o StrictHostKeyChecking=no -o ConnectTimeout=10 naeel@5.172.178.213 'КОМАНДА' +``` + +Запрещено локально: `go`, `docker`, `kubectl`, `helm`, `terraform`, `curl/wget`, `git push/pull`, любые скрипты проекта. + +## Документация + +- `doc/thinking/` — лог рассуждений агента (обязательно) +- `doc/progress.md` — трекер задач +- Старые файлы `doc/` не перезаписывать — новое в новых файлах с датой + +## Git + +⛔⛔⛔ АБСОЛЮТНОЕ ПРАВИЛО: +- Git — ТОЛЬКО ЛОКАЛЬНО в `~/IoT`. НИКОГДА через SSH на VM. +- Разрешены ТОЛЬКО две операции: `git commit` и `git push`. +- ЗАПРЕЩЕНО: git pull, git fetch, git rebase, git merge, git reset, git stash, git checkout — что угодно кроме commit и push. +- Если push отклонён — СТОП, доложить пользователю. Не лезть в pull/merge/rebase самостоятельно. + +Версионирование тегами: `vMAJOR.MINOR.PATCH` +- Patch — любое изменение кода +- Minor — новая фича / компонент +- Major — breaking change + +```bash +git tag vX.Y.Z && git push origin vX.Y.Z +``` + +## ⛔ ТЕРМИНАЛЬНЫЙ БУФЕР — НИКОГДА НЕ ЧИТАТЬ СТАРЫЙ + +**АБСОЛЮТНОЕ ПРАВИЛО:** +- get_terminal_output из старых сессий — МУСОР. Там старые прогоны. +- Всегда запускать новую команду через SSH и читать её вывод напрямую. +- НИКОГДА не читать буфер терминала из предыдущей сессии как актуальные данные. +- Актуальный результат — только из команды, которая была запущена СЕЙЧАС. + +## ⛔ ДОКУМЕНТАЦИЯ ТЕСТ-ПРОГОН�ОВ — В РЕАЛЬНОМ ВРЕМЕНИ + +**Правила:** +1. Перед запуском `run_all.sh` — создать файл `test-results/YYYY-MM-DD_HH-MM.log` и записать в него метку времени и что запускается. +2. Запускать `run_all.sh 2>&1 | tee ~/terra/IoT/test-results/YYYY-MM-DD_HH-MM.log` — вывод пишется сразу в файл и отображается в терминале. +3. После завершения — rsync лога локально. Лог остаётся как документация. +4. Папка `test-results/` в репозитории — `.gitignore` не добавлять, логи коммитить. + +**Формат запуска:** +```bash +LOG="test-results/$(date +%Y-%m-%d_%H-%M).log" +ssh -i ~/.ssh/naeel_vm_id_ed25519 -o StrictHostKeyChecking=no naeel@5.172.178.213 \ + "bash ~/terra/IoT/scripts/run_all.sh 2>&1 | tee ~/terra/IoT/${LOG}" +rsync -az -e "ssh -i ~/.ssh/naeel_vm_id_ed25519 -o StrictHostKeyChecking=no" \ + naeel@5.172.178.213:~/terra/IoT/test-results/ ~/IoT/test-results/ +``` + +**Никогда не разбираться с результатами по памяти / буферу / чату. Только лог.** + +## ⛔ РУЧНЫЕ ПАТЧИ — ЗАПРЕЩЕНЫ + +- НИКОГДА не применять ручные патчи (`kubectl patch`, `kubectl apply` отдельных полей, `python -c` замены в yaml и т.д.) без явного указания. +- Все изменения — только через код (Helm chart, YAML, Go-код) + сборка + деплой. +- Ручной патч слетает при следующем helm upgrade/redeploy → регрессия. +- Исключение: только если пользователь явно написал "примени ручной патч".