Восстановить инструкции деплоя и работы с Git

This commit is contained in:
AidarKC
2026-11-05 23:35:20 +03:00
parent 4f8c2a72e9
commit e575512ebb
3 changed files with 143 additions and 0 deletions
+69
View File
@@ -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, версию и отсутствие секретов.
+70
View File
@@ -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/<date>/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/`.
+4
View File
@@ -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`.
## Скрипты
Общие скрипты: