Зачем нужна автоматическая сборка проекта никому объяснять не надо.
В случае со сборкой проектов под Unity это особенно актуально, так как средненький проект, например, под WebGL собирается на рабочей машине 5-7 минут, полностью её завешивая.

Не так давно вышла версия Unity под Linux, что дало принципиальную возможность настроить автоматическую сборку при помощи Gitlab CI (которая основана на docker образах).

Я хочу поделиться своим опытом такой настройки.

Часть первая — собираем докер образ с Unity

Нам понадобится докер-образ, содержащий Unity.

Ниже я приложу готовый докер файл.
Но сначала несколько комментариев, из которых должно стать понятно, зачем в докерфайле такая экзотика, как gnome или tightvncserver.

Итак, основная проблема при использовании докер-образа с юнити «в лоб»: юнити после установки требует ручной активации. Причем работает активация только в графическом режиме. К счастью, делать это нужно только один раз.

Поэтому план такой:

• Собираем образ с Unity, содержащий графическую среду и VNC-сервер
• Запускаем из него контейнер
• Подключаемся к VNC серверу
• Запускаем Unity вручную и активируем ее
• Сохраняем контейнер в новый образ, в котором будет содержаться активированная копия unity

Ниже мой докер файл. Он собирает образ для unity5.6
Я не меняю версию Unity на более новую, потому что сам я всё проверял именно с этой версией.
Но вы можете попробовать заменить
beta.unity3d.com/download/6a86e542cf5c/unity-editor_amd64-5.6.1xf1Linux.deb
на другую версию.

Актуальный список можно найти тут:


А вот два скрипта, которые используются этим докерфайлом:

Шаг 1

Складываем эти три файла в одну директорию.

Шаг 2

Собираем докером образ (он будет содержать неактивированную копию Unity)
Я делал так:

docker build -t softaria/unity3d .

Шаг 3

Запускаем контейнер из этого образа:

docker run --privileged --cap-add=SYS_ADMIN -ti -p "5901:5901" --entrypoint=bash softaria/unity3d

Порт нам нужен, чтобы достучаться до VNC сервера.

Зачем нужны привилегии я уже не помню, но без них оно не работает. В качестве entrypoint указываем bash чтобы сразу зайти в запущенный контейнер.

Шаг 4

Теперь внутри контейнера нужно запустить vnc сервер:

vncserver :1

Оно попросит придумать пароль. Ок — придумываем.



Как видно на скриншоте, сервер пишет путь до своего лог файла.
Можно заглянуть в этот лог, чтобы убедиться, что стартовал gnome (впрочем, можно и не заглядывать).

Шаг 5

Теперь нам нужен VNC клиент. Любой.
Например, вот этот

Заходим на свой сервер (надо указывать IP + port) например:

123.123.133.123:5901

Порт будет именно 5901. А вот IP – ваш.

Шаг 6

Запускаеи через gnome меню Unity
Логинимся, и активируем лицензию.



Выходим

Шаг 7

Останавливаем vncserver (естественно, внутри докер контейнера — там же, где его запускали)

vncserver -kill :1

Это стоит сделать, чтобы не засорять наш будущий образ с активированной Unity всяким ненужным барахлом.

Шаг 8

Теперь на машине, где запущен докер контейнер открываем другой терминал. Нам нужно сохранить новый докер-образ из работающего контейнера.

Для этого не выходя из контейнера, в другом терминале находим этот контейнер, просто запустив docker ps и копируем себе ид этого контейнера.

Далее сохраняем контейнер в новый образ:

docker commit {ид-контейнера} softaria/unity3d:licensed

Теперь у нас есть докер образ с активированной Unity.
Можно залить его в registry.

Проверяем образ

После этого шага стоит проверить работоспособность образа вне gitlab.

Сделать это можно так:

Пусть в /root/myProject лежат исходники нашего проекта, которые надо собрать.
Мы знаем (или сейчас узнаем), что для сборки из командной строки в исходники проекта нужно поместить специальный класс, конфигурирующий сборку.

Поместить его надо в Assets/Editor

И называться класс и его метод должны именно так, как в моем примере ниже (поскольку эти имена упоминались в нашем скрипте runUnity.sh. Помните :“-executeMethod WebGLBuilder.build” ?)

public class WebGLBuilder {

    static void build()
{
         //Здесь нужно указать все пути к вашим сценам
        string[] scenes = { "Assets/main.unity" };
//Второй аргумент — название папки в которую будет помещена сборка, Третий — тип сборки (в нашем случае WebGL, четвертый обычно None)
BuildPipeline.BuildPlayer(scenes, "WebGL-Dist", BuildTarget.WebGL, BuildOptions.None);
    }
}

Далее запускаем конейнер из нашего образа так:

docker run --privileged --cap-add=SYS_ADMIN -v "/root/myProject:/project" softaria/unity3d:licensed /root/runUnity.sh

И убеждаемся, что сборка работает.

Если сборка заработала, переходим к следующему пункту:

Часть вторая. Сборка проекта в Gitlab.CI

Ниже я приведу свой .gitlab-ci.yml

Но сначала снова несколько комментариев — почему он такой безобразный нетривиальный.

Попытка сделать сборку на основе только что собранного образа (softaria/unity3d:licenced)
провалилась — возникала ошибка "/usr/bin/sh: /usr/bin/sh: cannot execute binary file gitlab"
Точных ее причин я уже не помню, но простым и работающим решением оказалось использовать стандартный image – docker, а свой образ запускать уже внутри него.

Второй проблемой оказалась невозможность передать свои исходники внутрь контейнера с Unity при помощи volume. Внутри гитлаба volumes просто не заработали. Возможно, тут есть какой-то workaround, но мне было лень разбираться проще скопировать исходники внутрь контейнера с юнити, а потом забрать результат обратно.

Не претендую на элегантность этих решений, но вот вам
На этом все. Если возникнут вопросы, постараюсь ответить в комментариях.