Всем привет! Продолжаю свой мониторинг по упрощению работы с Unity. В прошлой статье я писал о JSON Viewer (CraftHub) — инструменте, который упрощает работу с конфигами в формате JSON.
Откуда растут ноги
Я всё чаще сталкиваюсь с одной и той же рутиной — и на работе, и в личных проектах. Каждый раз, когда нужен свежий билд какого-либо приложения, приходится вручную собирать, после ещё закидывать файлы куда нужно… и так по кругу для каждой платформы. Это личная боль. Поэтому последние несколько месяцев я занимаюсь автоматизацией и написанием пайплайнов для своих и рабочих проектов.
Примерно полгода в нашем рабочем кругу не утихал один и тот же вопрос: как автоматизировать сборку Unity-проекта? Хотелось что-то максимально незамысловатое, наглядное и простое — без лишних церемоний. По простоте и доступности это не avalonia, которую можно спокойно собрать на сервере.
Первая попытка: Jenkins на своём сервере
Мои друзья (кстати, вот @crackanddie одного из них) первыми бросились в бой и попробовали Jenkins на собственном сервере. Настроили пайплайны, всё красиво… но идея быстро споткнулась о суровую реальность:
Unity поначалу вставал с большим трудом
Лицензия оказалась настоящим квестом — получить Community-ключ так и не получилось
Пошли дальше.
Вторая попытка: GitHub Actions + game-ci
Спустя полгода я решил разобраться в вопросе сам и подключил к поискам нейросеть. Она подсказала unity-builder от game-ci — на первый взгляд идеальный вариант.
Быстро добавили все данные от аккаунта в Repository Secrets, настроили workflow — и поехали. Вот что получилось:
name: Unity Build & Release
on:
workflow_dispatch:
permissions:
contents: write
jobs:
build-windows:
name: Build Windows (x64)
runs-on: ubuntu-latest
steps:
- name: Free disk space
uses: jlumbroso/free-disk-space@main
with:
tool-cache: false
android: true
dotnet: true
haskell: true
large-packages: true
swap-storage: true
- name: Checkout
uses: actions/checkout@v4
with:
lfs: true
- name: Cache Library
uses: actions/cache@v4
with:
path: Library
key: Library-Windows-${{ hashFiles('Assets/**', 'Packages/**', 'ProjectSettings/**') }}
restore-keys: Library-Windows-
- name: Build
uses: game-ci/unity-builder@v4
env:
UNITY_LICENSE: ${{ secrets.UNITY_LICENSE }}
UNITY_EMAIL: ${{ secrets.UNITY_EMAIL }}
UNITY_PASSWORD: ${{ secrets.UNITY_PASSWORD }}
with:
unityVersion: 2021.3.45f2
targetPlatform: StandaloneWindows64
buildName: ${{ github.event.repository.name }}
buildsPath: build
- name: Zip build
run: |
cd build/StandaloneWindows64
zip -r ../../${{ github.event.repository.name }}-windows-x64.zip .
- name: Upload to Release
uses: softprops/action-gh-release@v2
with:
tag_name: ${{ github.ref_name }}
files: ${{ github.event.repository.name }}-windows-x64.zip
build-linux:
name: Build Linux (x64)
runs-on: ubuntu-latest
steps:
- name: Free disk space
uses: jlumbroso/free-disk-space@main
with:
tool-cache: false
android: true
dotnet: true
haskell: true
large-packages: true
swap-storage: true
- name: Checkout
uses: actions/checkout@v4
with:
lfs: true
- name: Cache Library
uses: actions/cache@v4
with:
path: Library
key: Library-Linux-${{ hashFiles('Assets/**', 'Packages/**', 'ProjectSettings/**') }}
restore-keys: Library-Linux-
- name: Build
uses: game-ci/unity-builder@v4
env:
UNITY_LICENSE: ${{ secrets.UNITY_LICENSE }}
UNITY_EMAIL: ${{ secrets.UNITY_EMAIL }}
UNITY_PASSWORD: ${{ secrets.UNITY_PASSWORD }}
with:
unityVersion: 2021.3.45f2
targetPlatform: StandaloneLinux64
buildName: ${{ github.event.repository.name }}
buildsPath: build
- name: Zip build
run: |
cd build/StandaloneLinux64
zip -r ../../${{ github.event.repository.name }}-linux-x64.zip .
- name: Upload to Release
uses: softprops/action-gh-release@v2
with:
tag_name: ${{ github.ref_name }}
files: ${{ github.event.repository.name }}-linux-x64.zip
build-macos:
name: Build macOS (arm64)
runs-on: ubuntu-latest
steps:
- name: Free disk space
uses: jlumbroso/free-disk-space@main
with:
tool-cache: false
android: true
dotnet: true
haskell: true
large-packages: true
swap-storage: true
- name: Checkout
uses: actions/checkout@v4
with:
lfs: true
- name: Cache Library
uses: actions/cache@v4
with:
path: Library
key: Library-macOS-${{ hashFiles('Assets/**', 'Packages/**', 'ProjectSettings/**') }}
restore-keys: Library-macOS-
- name: Build
uses: game-ci/unity-builder@v4
env:
UNITY_LICENSE: ${{ secrets.UNITY_LICENSE }}
UNITY_EMAIL: ${{ secrets.UNITY_EMAIL }}
UNITY_PASSWORD: ${{ secrets.UNITY_PASSWORD }}
with:
unityVersion: 2021.3.45f2
targetPlatform: StandaloneOSX
buildName: ${{ github.event.repository.name }}
buildsPath: build
- name: Zip build
run: |
cd build/StandaloneOSX
zip -r ../../${{ github.event.repository.name }}-macos-arm64.zip .
- name: Upload to Release
uses: softprops/action-gh-release@v2
with:
tag_name: ${{ github.ref_name }}
files: ${{ github.event.repository.name }}-macos-arm64.zip
Казалось бы, вот оно счастье. Но дальше ждало разочарование.
Сборка нашего рабочего проекта под три платформы — Windows, Linux и macOS — заняла 40 минут.
Сорок. Минут. СОРОК. Загрузка Unity, получение лицензии через unity-builder — всё это вылилось в настоящую бесконечность. Особенно обидно, когда на локальной машине те же действия занимают от силы минуты три на каждую платформу, забавный момент.
Вы скажете: «А что насчёт self-hosted runner?» Пробовали. И тут тоже не срослось — активация Unity через сеть сам по себе небыстрый процесс. А пока мы настраивали self-hosted и исправляли баги, время ожидания каждой следующей ошибки росло в геометрической прогрессии. Сдали ли нервы? Может быть.
Третья попытка: написать своё
Изрядно намучавшись, мы с другом решили работать в долгую и написать собственное приложение. К тому же мне давно хотелось попробовать себя в чём-то связанном с пайплайнами и нодами (написать приложение с таким функционалом) — опыт интересный.
Встречайте — Unity Builder!
Сразу оговорюсь: мы делали проект под себя и свои потребности, поэтому некоторые решения могут показаться лишними. Но мы предусмотрели выбор — сборка прекрасно работает и без дополнительных фич.
Что умеет Unity Builder
Базовая настройка
На старте вас встречает простой экран с минимально необходимым:
Путь до исполняемого файла Unity
Папка проекта
Версия Unity
Выходная директория
Название проекта
База, ничего лишнего.
Выгрузка на FTP и индексация изменений
Для тех, у кого есть собственный апдейтер — есть интеграция с Hash Computer. Можно проиндексировать изменения и обновлять только изменившуюся часть файлов, не заливая всё целиком.
Также есть возможность выгрузить собранный проект прямо на свой FTP-сервер — без лишних телодвижений.
Поддержка платформ
Официально в Community-версии Unity нет поддержки под Linux ARM64, поэтому на текущий момент доступны:
Платформа | Архитектуры |
|---|---|
Windows | x64, x86 |
Linux | x64 |
macOS | Universal (Silicon + Intel) |
Кстати, macOS — очень удобно: собирается сразу универсальный билд, совместимый и с Apple Silicon, и с Intel. Поэтому если вы выбрали выгрузку на FTP, можно указать сразу два пути — для нашего, а может и вашего удобства.
Android пока не завезли, но будем рады помощи :)
Пайплайн в виде нодов
Вот, пожалуй, самая интересная часть. После запуска вы видите визуальный пайплайн в виде нодов — в полоске отображаются все зависимые и дочерние процессы.
Несколько важных деталей о работе пайплайна:
Одновременно может выполняться только один Build — он взаимодействует с Unity напрямую
Hash Computer и выгрузка на FTP могут работать до 10 параллельных потоков — этого более чем достаточно
Под капотом это
SemaphoreSlim— простое и надёжное решение
Каждый нод кликабельный: можно тыкнуть по нему и увидеть консольный вывод в реальном времени. В случае отмены главного процесса (сборки) все дочерние процессы — выгрузка и Hash Computer — убиваются автоматически.
Карточки нодов показывают:
Текущий статус
Прогресс выполнения
Время выполнения каждого нода
Это оказалось невероятно удобным на практике.
Что нужно для запуска
Всё просто: предустановите в Unity модули для нужных платформ — Windows, macOS, Linux — и сборки будут работать для всех из них без дополнительных телодвижений.
Никаких скриптов активации, никаких танцев с лицензией, никакого Docker. Скачал, указал путь до Unity и папку проекта — и через пару кликов у тебя уже крутится пайплайн. Если Unity уже стоит с нужными модулями, первый билд можно запустить буквально за пару минут после скачивания приложения. Мы специально старались сделать порог входа минимальным — чтобы не было ощущения, что ты настраиваешь CI/CD на работе, а не собираешь свой проект дома в воскресенье вечером.
Обновления
Приложение обновляет себя само — все релизы подтягиваются прямо с GitHub. Внутри есть кнопка обновления: никаких ручных походов на сайт, никакого «а вдруг вышла новая версия, а я и не знаю». Просто открыл — и всё актуально.
Вместо заключения
Мы прошли через Jenkins с его лицензионным квестом, через GitHub Actions с сорокаминутными сборками — и в итоге написали то, что хотели с самого начала.
Проект живой: мы сами им пользуемся каждый день, поэтому баги долго не залёживаются, а хотелки постепенно превращаются в фичи. Android пока не завезли — но руки тянутся. Если хочется ускорить этот процесс или добавить что-то своё — мы очень рады PR, идеям и баг-репортам. А если просто хочется поддержать — звёздочка на GitHub тоже считается.
Ссылка на проект: https://github.com/Soft-V/UnityBuilder
Ссылка на релизы: https://github.com/Soft-V/UnityBuilder/releases
Спасибо, что дочитали до конца. Надеемся, что Unity Builder сделает вашу разработку чуть приятнее — или хотя бы избавит от тех самых сорока минут ожидания.