mirror of https://github.com/Vateron-Media/XC_VM.git synced 2026-10-04 20:03:11 +02:00

Files

T

Divarion-D 788ec37637 refactor: replace DEVELOPMENT flag, fix bootstrap and logging

- Remove DEVELOPMENT constant from AppConfig.php; introduce DB_ACCESS_ENABLED
  (controls phpMiniAdmin access in admin panel only, not core DB connections)
- Detach bootstrap.php from www/constants.php: load core/Config/* and
  core/Logging/Logger directly; define PHP_ERRORS fallback
- Switch Logger::init() to PHP_ERRORS in bootstrap.php, stream/init.php,
  RequestGuard.php; remove leftover TODO comment
- Logger: always set error_reporting(E_ALL); UI visibility controlled
  separately via display_errors; rename $development -> $showErrors
- MigrationRunner: track applied/failed counts separately; failed migrations
  are not marked as applied
- Replace DEVELOPMENT with DB_ACCESS_ENABLED in admin settings.php and
  database.php (phpMiniAdmin gate)
- Replace DEVELOPMENT with PHP_ERRORS in CertbotCronJob
- Docs (en/ru): add DB_ACCESS_ENABLED flag description; update feature-flags,
  updates_checklist, http-request-handling; remove DEVELOPMENT references
- MIGRATION.md: mark L-1 as done, remove from backlog and wave A;
  unblock L-2; renumber steps

2026-04-19 18:13:56 +03:00

7.4 KiB

Raw Blame History

✅ Чеклист подготовки релиза XC_VM

Пошаговое руководство по подготовке и публикации релиза XC_VM.

1. Подготовить базу для релиза

Сначала завершите все рабочие изменения (feature/fix/docs) и убедитесь, что они уже в main.

Задайте переменную версии один раз и используйте её во всех командах ниже:

VERSION="X.Y.Z"

⚠️ Не делайте отдельный commit/push с bump версии на этом шаге. Иначе dist/changes.md будет включать лишние релизные коммиты, и вам придётся делать дополнительные правки.

🧹 2. Удалённые файлы

Перед сборкой сгенерируйте список файлов для удаления при обновлении:

make generate_deleted_files

Команда запускает git diff между LAST_TAG и HEAD, находит удалённые файлы под src/, убирает префикс src/ и записывает результат в src/migrations/deleted_files.txt.

Если LAST_TAG не определяется автоматически (нет сети / нет релизов), передайте явно:

make generate_deleted_files LAST_TAG=1.2.16

Проверьте сгенерированный файл — убедитесь, что в списке нет критичных файлов:

cat src/migrations/deleted_files.txt

После валидации make main / make lb упакуют файл в архив через delete_files_list / lb_delete_files_list.

При php console.php update post-update вызывается MigrationRunner::runFileCleanup(), который автоматически удаляет перечисленные файлы.

⚠️ Строки, начинающиеся с #, являются комментариями и будут проигнорированы. Можно закомментировать файлы, которые нужно сохранить.

🧪 3. Предрелизная проверка

Перед публикацией убедитесь, что сборка работает:

Проверка синтаксиса PHP:

make syntax_check

Тестовая установка в Docker (см. tools/test-install/):

bash tools/test-install/test_release.sh

Скрипт собирает образ, запускает контейнер с systemd и автоматически выполняет установку. dist/XC_VM.zip монтируется в контейнер как read-only volume.

✅ Убедитесь, что панель открывается по http://localhost:8880 и вход в админку работает.

Security-сканирование (запускается автоматически при push через .github/workflows/security-scan.yml):

tools/php_syntax_check.sh
tools/run_scan.sh

📝 4. Changelog

Сгенерировать лог коммитов (только рабочие изменения):

PREV_TAG=$(git describe --tags --abbrev=0)
git log --pretty=format:"- %s (%h)" "$PREV_TAG"..main > dist/changes.md

Обновить changelog.json в корне репозитория — этот файл содержит только изменения для предстоящего релиза:

{
    "version": "X.Y.Z",
    "changes": [
        "Описание изменения 1",
        "Описание изменения 2"
    ]
}

Панель получает этот файл из тега релиза автоматически через GithubReleases::getChangelog().

💬 Описания должны быть краткими — фокус на пользовательских улучшениях и исправлениях.

🔢 5. Обновить версию и сделать единый release commit

Изменить константу версии и отключить флаг доступа к phpMiniAdmin в:

src/core/Config/AppConfig.php

Быстрые команды:

sed -i "s/define('DB_ACCESS_ENABLED', true);/define('DB_ACCESS_ENABLED', false);/" src/core/Config/AppConfig.php
sed -i "s/define('XC_VM_VERSION', *'[0-9]\+\.[0-9]\+\.[0-9]\+');/define('XC_VM_VERSION', '${VERSION}');/" src/core/Config/AppConfig.php

Сделать один финальный commit/push для релиза:

git add src/core/Config/AppConfig.php changelog.json src/migrations/deleted_files.txt
git commit -m "Prepare release ${VERSION}"
git push

⚠️ Это устраняет необходимость в нескольких релизных коммитах.

⚙️ 6. Сборка архивов

🤖 Production-сборки выполняются через GitHub Actions (.github/workflows/build-release.yml) при публикации релиза. Файлы прикрепляются автоматически.

Для локальной сборки:

make new
make lb
make main

После сборки в dist/ должны быть:

Файл	Описание
`XC_VM.zip`	Установочный пакет MAIN (install скрипт + xc_vm.tar.gz)
`xc_vm.tar.gz`	Архив MAIN (установка и обновление)
`loadbalancer.tar.gz`	Архив LB (установка и обновление)
`hashes.md5`	Контрольные суммы MD5

Один и тот же архив используется как для чистой установки, так и для обновлений. Скрипт обновления (src/update) исключает каталоги бинарников/конфигов во время выполнения по hardcoded-списку UPDATE_EXCLUDE_DIRS внутри самого Python-скрипта.

Проверка целостности:

cd dist && md5sum -c hashes.md5

🚀 7. GitHub релиз

Перейти на GitHub Releases
Создать новый релиз с тегом из первого шага
Вставить changelog в описание релиза
Опубликовать без прикрепления файлов — GitHub Actions соберёт и прикрепит их

После публикации workflow автоматически:

Соберёт все архивы + контрольные суммы
Прикрепит их к релизу
Отправит Telegram-уведомление через release-notifier.yml

✅ Дождитесь завершения Actions и проверьте, что все файлы доступны для скачивания.

📢 8. После релиза

Проверить, что все 4 файла прикреплены к релизу
Скачать и проверить md5sum -c hashes.md5
Убедиться, что Telegram-уведомление отправлено
Закрыть связанные GitHub issues/milestones

7.4 KiB Raw Blame History