From e575512ebbc61ebc9efbbd5683a71d0b933542d1ecf7671567d51e3617258eee Mon Sep 17 00:00:00 2001 From: AidarKC Date: Thu, 5 Nov 2026 23:35:20 +0300 Subject: [PATCH] =?UTF-8?q?=D0=92=D0=BE=D1=81=D1=81=D1=82=D0=B0=D0=BD?= =?UTF-8?q?=D0=BE=D0=B2=D0=B8=D1=82=D1=8C=20=D0=B8=D0=BD=D1=81=D1=82=D1=80?= =?UTF-8?q?=D1=83=D0=BA=D1=86=D0=B8=D0=B8=20=D0=B4=D0=B5=D0=BF=D0=BB=D0=BE?= =?UTF-8?q?=D1=8F=20=D0=B8=20=D1=80=D0=B0=D0=B1=D0=BE=D1=82=D1=8B=20=D1=81?= =?UTF-8?q?=20Git?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- GIT_COMMIT_PUSH_INSTRUCTIONS.md | 69 +++++++++++++++++++++++++++ deploy/DEPLOY_SERVER_INSTRUCTIONS.md | 70 ++++++++++++++++++++++++++++ deploy/README.md | 4 ++ 3 files changed, 143 insertions(+) create mode 100644 GIT_COMMIT_PUSH_INSTRUCTIONS.md create mode 100644 deploy/DEPLOY_SERVER_INSTRUCTIONS.md diff --git a/GIT_COMMIT_PUSH_INSTRUCTIONS.md b/GIT_COMMIT_PUSH_INSTRUCTIONS.md new file mode 100644 index 00000000..841d1341 --- /dev/null +++ b/GIT_COMMIT_PUSH_INSTRUCTIONS.md @@ -0,0 +1,69 @@ +# Инструкция по commit и push в Git + +## Репозиторий + +Работать с Git нужно из корня репозитория `SHiNE-product/`: + +```bash +cd /home/ai/work/SHiNE/SHiNE-server-sha256/SHiNE-product +``` + +Секреты, токены, приватные ключи, `.env`, логи и сборочные артефакты в Git не добавлять. + +## Перед коммитом + +```bash +git status --short --branch +git diff --check +git diff +``` + +Перед обычным коммитом обновить `VERSION.properties`: + +- только UI — увеличить `client.version`; +- только сервер — увеличить `server.version`; +- UI и сервер — увеличить обе версии; +- в рабочей ветке использовать patch-инкремент: `1.2.346` → `1.2.347`. + +Сообщения коммитов писать на русском языке. + +## Commit + +```bash +git add <нужные-файлы> +git commit -m "Краткое описание изменения" +``` + +Для локального `git commit` токен не нужен. Не использовать `git add .`, если в рабочем дереве есть непроверенные локальные файлы. + +## Push + +Сначала проверить ветку и remote: + +```bash +git branch --show-current +git remote -v +``` + +Для push использовать токен из переменной окружения `GITEA_TOKEN`; сам токен в команду, файл или историю shell не записывать. При HTTPS Git обычно запросит имя пользователя и пароль токена: + +```bash +export GITEA_TOKEN='токен задаётся локально и не коммитится' +git push origin HEAD +unset GITEA_TOKEN +``` + +Если credential helper не умеет автоматически подставлять `GITEA_TOKEN`, использовать настроенный локально способ авторизации Gitea; не вставлять токен в URL remote. + +После push проверить результат: + +```bash +git status --short --branch +git log -1 --oneline +``` + +## Ветка `main` + +`main` предназначена для стабильных версий. По умолчанию изменения сначала коммитить в рабочей ветке, затем вливать в `main`. Для merge в `main` увеличивать вторую цифру версии и обнулять третью: `1.2.346` → `1.3.0`. + +Перед push в `main` отдельно проверить diff, версию и отсутствие секретов. diff --git a/deploy/DEPLOY_SERVER_INSTRUCTIONS.md b/deploy/DEPLOY_SERVER_INSTRUCTIONS.md new file mode 100644 index 00000000..b645f2cb --- /dev/null +++ b/deploy/DEPLOY_SERVER_INSTRUCTIONS.md @@ -0,0 +1,70 @@ +# Инструкция по деплою SHiNE на сервер + +## Целевые контуры + +Production: + +- `shineup.me` — основной production; +- `server2.shineup.me` — второй production. + +Тестовые/devnet-серверы: + +- `t1.shineup.me`; +- `t2.shineup.me`; +- `t3.shineup.me`; +- `t4.shineup.me`. + +В документации и скриптах использовать домены, а не IP. SSH-пользователь — `player`. + +## Безопасность + +- Production-деплой на `shineup.me` или `server2.shineup.me` выполнять только после отдельного подтверждения. +- Перед production-деплоем проверить свежий backup в `deploy/backup/archive//MANIFEST.txt`. +- Не коммитить секреты, `.env`, JWK, TURN shared secrets, приватные ключи и локальные конфиги. +- Если пользователь просит «задеплой» без указания контура, сначала уточнить: production или test. + +## Команды + +Все команды выполнять из корня `SHiNE-product/`. + +Production: + +```bash +bash deploy/scripts/production_shineupme_server.sh +bash deploy/scripts/production_shineupme_ui.sh + +bash deploy/scripts/production_server2_server.sh +bash deploy/scripts/production_server2_ui.sh +``` + +Тестовые серверы: + +```bash +bash deploy/scripts/test_t1_server.sh +bash deploy/scripts/test_t1_ui.sh +bash deploy/scripts/test_t2_server.sh +bash deploy/scripts/test_t2_ui.sh +bash deploy/scripts/test_t3_server.sh +bash deploy/scripts/test_t3_ui.sh +bash deploy/scripts/test_t4_server.sh +bash deploy/scripts/test_t4_ui.sh +``` + +Не путать `server2.shineup.me` и `t2.shineup.me`. + +Скрипт сервера собирает jar через `./gradlew shadowJar`, копирует jar и список email-доменов через `rsync`, обновляет systemd unit и перезапускает сервис. Для локальной проверки использовать `./gradlew startLocal` или `./gradlew startLocalWithBuild`. + +Не использовать удалённые Gradle deploy-задачи: штатный путь — скрипты из `deploy/scripts/`. + +## Настройки серверов + +| Контур | SSH | Каталог сервера | Сервис | Порт | +|---|---|---|---|---:| +| `shineup.me` | `player@shineup.me` | `/home/player/SHiNE/shine-server` | `shine-server` | 7070 | +| `server2.shineup.me` | `player@server2.shineup.me` | `/home/player/SHiNE/shine-server` | `shine-server` | 7070 | +| `t1.shineup.me` | `player@t1.shineup.me` | `/home/player/t1/server` | `shine-t1` | 7101 | +| `t2.shineup.me` | `player@t2.shineup.me` | `/home/player/t2/server` | `shine-t2` | 7102 | +| `t3.shineup.me` | `player@t3.shineup.me` | `/home/player/t3/server` | `shine-t3` | 7103 | +| `t4.shineup.me` | `player@t4.shineup.me` | `/home/player/t4/server` | `shine-t4` | 7104 | + +Источники истины для деталей и backup: `deploy/AGENTS.md`, `deploy/README.md`, `deploy/backup/README.md` и сами скрипты `deploy/scripts/`. diff --git a/deploy/README.md b/deploy/README.md index c4b0d123..5a74148a 100644 --- a/deploy/README.md +++ b/deploy/README.md @@ -25,6 +25,7 @@ ## Основные документы +- `DEPLOY_SERVER_INSTRUCTIONS.md` — краткая пошаговая памятка: какой wrapper запускать для каждого контура. - `PRODUCTION_SERVERS.md` — production-контуры. - `TEST_SERVERS.md` — test/devnet-контуры. - `TURN_SERVERS.md` — TURN-серверы. @@ -37,6 +38,9 @@ - `AGENT_BOT_CODER_LOCAL_SYSTEMD.md` — локальный systemd-deploy Telegram-бота агента-кодера. - `AGENTS.md` — правила для агента при деплое. +Правила Git для подготовки и отправки изменений находятся в корневом файле +`GIT_COMMIT_PUSH_INSTRUCTIONS.md`. + ## Скрипты Общие скрипты: