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

В этом документе описан процесс создания релиза XC_VM — пошаговое руководство для разработчиков по обновлению версии, сборке архивов и публикации на GitHub.

⬅️ Назад на главную

📚 Навигация

🔢 1. Обновить версию
🧹 2. Удалённые файлы
⚙️ 3. Сборка архивов
📝 4. Changelog
🚀 5. GitHub релиз

🔢 1. Обновить версию

Установить новое значение XC_VM_VERSION в следующих файлах:

Файлы для редактирования:

src/www/constants.php  
src/www/stream/init.php  
src/player/functions.php

Auto-update команда:

find -type f -name "*.php" -exec sed -i \
"s/define('XC_VM_VERSION', '[0-9]\+\.[0-9]\+\.[0-9]\+');/define('XC_VM_VERSION', 'X.Y.Z');/g" {} \;

Закоммитить изменения с сообщением:

git add .
git commit -m "Bump version to X.Y.Z"

💡 Совет: Замените X.Y.Z на актуальную версию, например, 1.2.3.

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

Выполнить команду для генерации списка удаленных файлов:
```
make delete_files_list
```
Открыть файл dist/deleted_files.txt.
Для каждого пути из списка добавить в src/includes/cli/update.php после комментария // Update checkpoint следующий блок:
```
if (file_exists(MAIN_HOME . 'file_path')) {
    unlink(MAIN_HOME . 'file_path');
}
```

⚠️ Важно: Убедитесь, что пути указаны корректно, чтобы избежать удаления важных файлов.

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

Последовательно выполнить команды для сборки:
```
make lb
make main
make main_update
make lb_update
```
Убедиться, что созданы следующие файлы в директории dist/:
- loadbalancer.tar.gz — установочный архив LB
- loadbalancer_update.tar.gz — архив обновления LB
- XC_VM.zip — установочный архив MAIN
- update.tar.gz — архив обновления MAIN
- hashes.md5 — файл с хеш-суммами

🧰 Проверка: После сборки проверьте целостность архивов с помощью md5sum -c hashes.md5.

📝 4. Changelog

Сначала сгенерируйте файл с изменениями из git:

git log --pretty=format:"- %s (%h)" X.Y.Z..main > dist/changes.md

Перейдите по ссылке и добавьте изменения текущего релиза: https://github.com/Vateron-Media/XC_VM_Update/blob/main/changelog.json

Добавить изменения текущего релиза в формате JSON:

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

💬 Рекомендация: Держите описания изменений краткими и информативными, фокусируясь на ключевых улучшениях и фиксах.

🚀 5. GitHub релиз

Создать новый релиз на GitHub Releases.
Прикрепить следующие файлы к релизу:
- dist/loadbalancer.tar.gz
- dist/XC_VM.zip
- dist/update.tar.gz
- dist/loadbalancer_update.tar.gz
- dist/hashes.md5
Указать changelog в описании релиза.

✅ Завершение: После публикации проверьте, что все файлы доступны для скачивания и хеш-суммы совпадают.